PixiJS

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) overrides

BlurFilter.ts:25
Name Type Attributes Default Description
strength number <optional>
 8

The strength of the blur filter.
quality number <optional>
 4

The quality of the blur filter.
resolution number <optional>
 PIXI.settings.FILTER_RESOLUTION

The resolution of the blur filter.
kernelSize number <optional>
 5

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

Extends

Members

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

quality number

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

Default Value:
  • 1

repeatEdgePixels boolean

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

Default Value:
  • false

Methods

apply (filterManager, input, output, clearMode) void overrides

BlurFilter.ts:45

Applies the filter.

Name Type Description
filterManager PIXI.FilterSystem

The manager.
input PIXI.RenderTexture

The input target.
output PIXI.RenderTexture

The output target.
clearMode PIXI.CLEAR_MODES

How to clear

Inherited Properties

From class PIXI.Filter

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.

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 (set by filter system)

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.

resolution number inherited

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

state PIXI.State inherited

The WebGL state the filter requires to render

From class PIXI.Shader

program PIXI.Program inherited

Program that the shader uses

uniforms object readonly inherited

Shader uniform values, shortcut for uniformGroup.uniforms

Inherited Methods

From class PIXI.Shader

destroy () void inherited

Shader.ts:NaN