PIXI.filters.BlurFilterPass

class BlurFilterPass extends PIXI.Filter

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

Constructor

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

Parameters:
Name	Type	Default	Description
horizontal	boolean		Do pass along the x-axis (`true`) or y-axis (`false`).
strength	number	8	The strength of the blur filter.
quality	number	4	The quality of the blur filter.
resolution			The resolution of the blur filter.
kernelSize	number	5	The kernelSize of the blur filter.Options: 5, 7, 9, 11, 13, 15.

number

blur = 16

number

quality = 4

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

boolean	autoFit = true
PIXI.BLEND_MODES	blendMode = PIXI.BLEND_MODES.NORMAL
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

blur BlurFilterPass.ts:124

blur: number = 16

Sets the strength of both the blur.

quality BlurFilterPass.ts:139

quality: number = 4

Sets the quality of the blur by modifying the number of passes. More passes means higher quality bluring but the lower the performance.

apply BlurFilterPass.ts:51

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

Applies the filter.

Returns:
Type	Description
void