Class: FilterSystem

System plugin to the renderer to manage the filters.

new (renderer)

Name Type Description
renderer PIXI.Renderer

The renderer this System works for.



activeState object

Active state

defaultFilterStack Array.<Object> readonly

List of filters for the FilterSystem

forceClear boolean

Whether to clear output renderTexture in AUTO/BLIT mode. See PIXI.CLEAR_MODES

globalUniforms PIXI.UniformGroup

This uniform group is attached to filter uniforms when used

Name Type Description
outputFrame PIXI.Rectangle
inputSize Float32Array
inputPixel Float32Array
inputClamp Float32Array
resolution Number
filterArea Float32Array
filterClamp Fload32Array

quad PIXI.Quad

A very simple geometry used when drawing a filter effect to the screen

quadUv PIXI.QuadUv

Quad UVs

The renderer this manager works for.

statePool Array.<Object>

a pool for storing filter states, save us creating new ones each tick

tempRect PIXI.Rectangle

Temporary rect for maths

texturePool Object

stores a bunch of PO2 textures used for filtering

useMaxPadding boolean

Old padding behavior is to use the max amount instead of sum padding. Use this flag if you need the old behavior.

Default Value:
  • false


applyFilter (filter, input, output, clearMode)

Draws a filter.

Name Type Description
filter PIXI.Filter

The filter to draw.

input PIXI.RenderTexture

The input render target.

output PIXI.RenderTexture

The target to output to.

clearMode PIXI.CLEAR_MODES optional

Should the output be cleared before rendering to it

bindAndClear (filterTexture, clearMode)

Binds a renderTexture with corresponding filterFrame, clears it if mode corresponds.

Name Type Description
filterTexture PIXI.RenderTexture

renderTexture to bind, should belong to filter pool or filter stack

clearMode PIXI.CLEAR_MODES optional

clearMode, by default its CLEAR/YES. See PIXI.CLEAR_MODES

calculateNormalizedScreenSpaceMatrix (outputMatrix)PIXI.Matrix Deprecated : since 5.0.0

Name Type Description
outputMatrix PIXI.Matrix

The matrix to output to.

Type Description
PIXI.Matrix The mapped matrix.

calculateScreenSpaceMatrix (outputMatrix)PIXI.Matrix Deprecated : since 5.0.0

Name Type Description
outputMatrix PIXI.Matrix

the matrix to output to.

Type Description
PIXI.Matrix The mapped matrix.

calculateSpriteMatrix (outputMatrix, sprite)PIXI.Matrix

Multiply input normalized coordinates to this matrix to get sprite texture normalized coordinates.

Use outputMatrix * vTextureCoord in the shader.

Name Type Description
outputMatrix PIXI.Matrix

The matrix to output to.

sprite PIXI.Sprite

The sprite to map to.

Type Description
PIXI.Matrix The mapped matrix.

Destroys this Filter System.

emptyPool ()

Empties the texture pool.

getFilterTexture (input, resolution)PIXI.RenderTexture

Gets extra render texture to use inside current filter To be compliant with older filters, you can use params in any order

Name Type Description
input PIXI.RenderTexture optional

renderTexture from which size and resolution will be copied

resolution number optional

override resolution of the renderTexture

Type Description

getOptimalFilterTexture (minWidth, minHeight, resolution)PIXI.RenderTexture protected

Gets a Power-of-Two render texture or fullScreen texture

Name Type Default Description
minWidth number

The minimum width of the render texture in real pixels.

minHeight number

The minimum height of the render texture in real pixels.

resolution number 1 optional

The resolution of the render texture.

Type Description
PIXI.RenderTexture The new render texture.

Pops off the filter and applies it.

push (target, filters)

Adds a new filter to the System.

Name Type Description
target PIXI.DisplayObject

The target of the filter to render.

filters Array.<PIXI.Filter>

The filters to apply.

calls texturePool.resize(), affects fullScreen renderTextures

returnFilterTexture (renderTexture)

Frees a render texture back into the pool.

Name Type Description
renderTexture PIXI.RenderTexture

The renderTarget to free