PIXI.filters.BlurFilter

class BlurFilter extends PIXI.Filter

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.

Constructor

new PIXI.filters.BlurFilter(strength: number, quality: number, resolution, kernelSize: number) → {}

Parameters:
Name	Type	Attributes	Default	Description
strength	number		8	The strength of the blur filter.
quality	number		4	The quality of the blur filter.
resolution		<optional>	PIXI.settings.FILTER_RESOLUTION	The resolution of the blur filter.
kernelSize	number		5	The kernelSize of the blur filter.Options: 5, 7, 9, 11, 13, 15.

PIXI.BLEND_MODES	blendMode = PIXI.BLEND_MODES.NORMAL
number	blur = 2
number	blurX = 2
number	blurY = 2
number	quality = 1
boolean	repeatEdgePixels = false

void	apply(filterManager: PIXI.FilterSystem, input: PIXI.RenderTexture, output: PIXI.RenderTexture, clearMode: PIXI.CLEAR_MODES)

boolean	autoFit = true
boolean	enabled If enabled is true the filter is applied, if false it will not.
boolean	legacy
PIXI.MSAA_QUALITY	multisample The samples of the filter.
number	padding
number	resolution
PIXI.State	state The WebGL state the filter requires to render.

PIXI.Program

program

Program that the shader uses.

Dict<any>

uniforms

blendMode BlurFilter.ts:144

blendMode: PIXI.BLEND_MODES = PIXI.BLEND_MODES.NORMAL

Sets the blendmode of the filter

blur BlurFilter.ts:85

blur: number = 2

Sets the strength of both the blurX and blurY properties simultaneously

blurX BlurFilter.ts:114

blurX: number = 2

Sets the strength of the blurX property

blurY BlurFilter.ts:129

blurY: number = 2

Sets the strength of the blurY property

quality BlurFilter.ts:100

quality: number = 1

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

repeatEdgePixels BlurFilter.ts:158

repeatEdgePixels: boolean = false

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

apply BlurFilter.ts:42

apply(filterManager: PIXI.FilterSystem, input: PIXI.RenderTexture, output: PIXI.RenderTexture, clearMode: PIXI.CLEAR_MODES) → {void}

Applies the filter.

Returns:
Type	Description
void