Class: FilterSystem

Extends

• PIXI.System

Members

activeState object

Active state

defaultFilterStack Array.<Object> readonly

List of filters for the FilterSystem

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

Methods

applyFilter (filter, input, output, clear)

FilterSystem.js:342

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.
clear	boolean	Should the output be cleared before rendering to it

calculateScreenSpaceMatrix (outputMatrix)PIXI.Matrix

FilterSystem.js:389

Calculates the mapped matrix.

TODO playing around here.. this is temporary - (will end up in the shader) this returns a matrix that will normalize map filter cords in the filter to screen space

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:407

This will map the filter coord so that a texture can be used based on the transform of a sprite

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.

contextChange (gl) inherited

System.js:32

Generic method called when there is a WebGL context change.

Name	Type	Description
gl	WebGLRenderingContext	new webgl context

destroy (contextLost) overrides

FilterSystem.js:425

Destroys this Filter System.

Name	Type	Default	Description
contextLost	boolean	false	optional context was lost, do not free shaders

emptyPool ()

FilterSystem.js:519

Empties the texture pool.

getFilterTexture (resolution)PIXI.RenderTexture

FilterSystem.js:491

Gets extra render texture to use inside current filter

Name	Type	Description
resolution	number	resolution of the renderTexture

Returns:

Type	Description
PIXI.RenderTexture

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

FilterSystem.js:448

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

TODO move to a separate class could be on renderer?

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:246

Pops off the filter and applies it.

push (target, filters)

FilterSystem.js:181

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.

returnFilterTexture (renderTexture)

FilterSystem.js:507

Frees a render texture back into the pool.

Name	Type	Description
renderTexture	PIXI.RenderTexture	The renderTarget to free