Class: FilterSystem

Extends

• PIXI.System

Members

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

Properties:

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

renderer PIXI.Renderer inherited

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

Methods

applyFilter (filter, input, output, clearMode)

FilterSystem.js:246

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)

FilterSystem.js:217

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

useDeprecated.js:957

Name	Type	Description
outputMatrix	PIXI.Matrix	The matrix to output to.

Returns:

Type	Description
PIXI.Matrix	The mapped matrix.

calculateScreenSpaceMatrix (outputMatrix)PIXI.Matrix Deprecated : since 5.0.0

useDeprecated.js:942

Name	Type	Description
outputMatrix	PIXI.Matrix	the matrix to output to.

Returns:

Type	Description
PIXI.Matrix	The mapped matrix.

calculateSpriteMatrix (outputMatrix, sprite)PIXI.Matrix

FilterSystem.js:276

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.

Returns:

Type	Description
PIXI.Matrix	The mapped matrix.

destroy () overrides

FilterSystem.js:290

Destroys this Filter System.

emptyPool ()

FilterSystem.js:336

Empties the texture pool.

getFilterTexture (input, resolution)PIXI.RenderTexture

FilterSystem.js:314

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

Returns:

Type	Description
PIXI.RenderTexture

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

FilterSystem.js:303

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.

Returns:

Type	Description
PIXI.RenderTexture	The new render texture.

pop ()

FilterSystem.js:153

Pops off the filter and applies it.

push (target, filters)

FilterSystem.js:102

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.

resize ()

FilterSystem.js:342

calls texturePool.resize(), affects fullScreen renderTextures

returnFilterTexture (renderTexture)

FilterSystem.js:330

Frees a render texture back into the pool.

Name	Type	Description
renderTexture	PIXI.RenderTexture	The renderTarget to free