Class: BlurFilterPass

PIXI.filters.BlurFilterPass

The BlurFilterPass applies a horizontal or vertical Gaussian blur to an object.

new PIXI.filters.BlurFilterPass (horizontal, strength, quality, resolution, kernelSize)

Name Type Default Description
horizontal boolean

Do pass along the x-axis (true) or y-axis (false).

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.

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 inherited

Sets the blendmode of the filter

Default Value:
  • PIXI.BLEND_MODES.NORMAL

blur number

Sets the strength of both the blur.

Default Value:
  • 16

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 quality of the blur by modifying the number of passes. More passes means higher quaility bluring but the lower the performance.

Default Value:
  • 4

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, clear, currentState) inherited overrides

Applies the filter

Name Type Description
filterManager PIXI.systems.FilterSystem

The renderer to retrieve the filter from

input PIXI.RenderTexture

The input render target.

output PIXI.RenderTexture

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