PIXI.filters.KawaseBlurFilter

class KawaseBlurFilter extends PIXI.Filter

A much faster blur than Gaussian blur, but more complicated to use.
original filter

See:

Constructor

new PIXI.filters.KawaseBlurFilter(blur: number | number<Array>, quality: number, clamp: boolean) → {}

Parameters:
Name	Type	Attributes	Default	Description
blur	number \| number<Array>	<optional>	4	The blur of the filter. Should be greater than `0`. If value is an Array, setting kernels.
quality	number	<optional>	3	The quality of the filter. Should be an integer greater than `1`.
clamp	boolean	<optional>	false	Clamp edges, useful for removing dark edges from fullscreen filters or bleeding to the edge of filterArea.

number	blur = 4
boolean	clamp = false Get the if the filter is clampped.
number[]	kernels = [0]
PIXI.Point \| number<Array>	pixelSize = [1, 1] Sets the pixel size of the filter. Large size is blurrier. For advanced usage.
number	quality = 3

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 KawaseBlurFilter.ts:222

blur: number = 4

The amount of blur, value greater than 0.

clamp KawaseBlurFilter.ts:162

clamp: boolean = false

Get the if the filter is clampped.

kernels KawaseBlurFilter.ts:138

kernels: number[] = [0]

The kernel size of the blur filter, for advanced usage.

pixelSize KawaseBlurFilter.ts:173

pixelSize: PIXI.Point | number<Array> = [1, 1]

Sets the pixel size of the filter. Large size is blurrier. For advanced usage.

quality KawaseBlurFilter.ts:208

quality: number = 3

The quality of the filter, integer greater than 1.