Class: BlurFilter

Extends

• PIXI.Filter

Members

autoFitboolean

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

blendModenumber

Sets the blendmode of the filter

Default Value:

• PIXI.BLEND_MODES.NORMAL

blurnumber

Sets the strength of both the blurX and blurY properties simultaneously

Default Value:

• 2

blurXnumber

Sets the strength of the blurX property

Default Value:

• 2

blurYnumber

Sets the strength of the blurY property

Default Value:

• 2

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.

qualitynumber

Sets the number of passes for blur. More passes means higher quaility bluring.

Default Value:

• 1

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)

BlurFilter.js:43

Applies the filter.

Name	Type	Description
filterManager	PIXI.FilterManager	The manager.
input	PIXI.RenderTarget	The input target.
output	PIXI.RenderTarget	The output target.