Class: SpriteMaskFilter

Extends

• PIXI.Filter

Members

autoFitboolean

If enabled, pixi will fit the filter area into boundaries for better performance. Switch it off if it does not work for specific shader.

enabledboolean

If enabled is true the filter is applied, if false it will not.

fragmentSrcstring

The fragment shader.

paddingnumber

The padding of the filter. Some filters require extra space to breath such as a blur. Increasing this will add extra width and height to the bounds of the object that the filter is applied to.

resolutionnumber

The resolution of the filter. Setting this to be lower will lower the quality but increase the performance of the filter.

uniformsobject

An object containing the current values of custom uniforms.

Example

Updating the value of a custom uniform

filter.uniforms.time = performance.now();

vertexSrcstring

The vertex shader.

Methods

apply(filterManager, input, output)

core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js, line 42

Applies the filter

Name	Type	Description
filterManager	PIXI.FilterManager	The renderer to retrieve the filter from
input	PIXI.RenderTarget	The input render target.
output	PIXI.RenderTarget	The target to output to.