Class: BlurFilter


The BlurFilter applies a Gaussian blur to an object. The strength of the blur can be set for x- and y-axis separately.

new PIXI.filters.BlurFilter (strength, quality, resolution, kernelSize)

Name Type Default Description
strength number

The strength of the blur filter.

quality number

The quality of the blur filter.

resolution number

The resolution of the blur filter.

kernelSize number 5 optional

The kernelSize of the blur filter.Options: 5, 7, 9, 11, 13, 15.



autoFit boolean inherited

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 overrides

Sets the blendmode of the filter

Default Value:

blur number

Sets the strength of both the blurX and blurY properties simultaneously

Default Value:
  • 2

blurX number

Sets the strength of the blurX property

Default Value:
  • 2

blurY number

Sets the strength of the blurY property

Default Value:
  • 2

enabled boolean inherited

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

fragmentSrc string inherited

The fragment shader.

padding number inherited

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.

quality number

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

Default Value:
  • 1

resolution number inherited

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

uniforms object inherited

An object containing the current values of custom uniforms.


Updating the value of a custom uniform

filter.uniforms.time =;

vertexSrc string inherited

The vertex shader.


apply (filterManager, input, output) overrides

Applies the filter.

Name Type Description
filterManager PIXI.FilterManager

The manager.

input PIXI.RenderTarget

The input target.

output PIXI.RenderTarget

The output target.