Class: Filter

PIXI.Filter

new PIXI.Filter (vertexSrc, fragmentSrc, uniforms)

Name Type Description
vertexSrc string optional

The source of the vertex shader.

fragmentSrc string optional

The source of the fragment shader.

uniforms object optional

Custom uniforms to use to augment the built-in ones.

Extends

Members

PIXI.Filter.defaultFragmentSrc staticconstant

The default fragment shader source

PIXI.Filter.defaultVertexSrc staticconstant

The default vertex shader source

autoFit boolean

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

blendMode number

Sets the blendmode of the filter

Default Value:
  • PIXI.BLEND_MODES.NORMAL

enabled boolean

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

fragmentSrc string

The fragment shader.

padding number

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.

resolution number

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

uniforms object

An object containing the current values of custom uniforms.

Example

Updating the value of a custom uniform

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

vertexSrc string

The vertex shader.

Methods

apply (filterManager, input, output, clear, currentState)

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.

clear boolean

Should the output be cleared before rendering to it

currentState object optional

It's current state of filter. There are some useful properties in the currentState : target, filters, sourceFrame, destinationFrame, renderTarget, resolution