Class: BlurFilter

PIXI.filters.BlurFilter

The BlurFilter applies a Gaussian blur to an object.

The strength of the blur can be set for the x-axis and y-axis separately.

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

Name Type Default Description
strength number 8 optional

The strength of the blur filter.

quality number 4 optional

The quality of the blur filter.

resolution number optional

The resolution of the blur filter.

kernelSize number 5 optional

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

Extends

Members

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:
  • PIXI.BLEND_MODES.NORMAL

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.

legacy boolean readonly inherited

Legacy filters use position and uvs from attributes

padding number inherited overrides

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.

Program that the shader uses

quality number

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

Default Value:
  • 1

repeatEdgePixels bool

If set to true the edge of the target will be clamped

Default Value:
  • false

resolution number inherited overrides

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

The WebGL state the filter requires to render

uniforms object readonly inherited

Shader uniform values, shortcut for uniformGroup.uniforms

Methods

apply (filterManager, input, output) overrides

Applies the filter.

Name Type Description
filterManager PIXI.systems.FilterSystem

The manager.

input PIXI.RenderTexture

The input target.

output PIXI.RenderTexture

The output target.