PIXI.filters.BloomFilter

class BloomFilter extends PIXI.Filter

The BloomFilter applies a Gaussian blur to an object. The strength of the blur can be set for x- and y-axis separately.
original filter

See:

Constructor

new PIXI.filters.BloomFilter(blur: number | PIXI.Point | Array<number>, quality: number, resolution: number, kernelSize: number) → {}

Parameters:
Name	Type	Attributes	Default	Description
blur	number \| PIXI.Point \| Array<number>	<optional>	2	Sets the strength of both the blurX and blurY properties simultaneously
quality	number	<optional>	4	The quality of the blurX & blurY filter.
resolution	number	<optional>	PIXI.settings.FILTER_RESOLUTION	The resolution of the blurX & blurY filter.
kernelSize	number	<optional>	5	The kernelSize of the blurX & blurY filter.Options: 5, 7, 9, 11, 13, 15.

number

blur = 2

number

blurX = 2

number

blurY = 2

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

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

blur BloomFilter.ts:77

blur: number = 2

Sets the strength of both the blurX and blurY properties simultaneously

blurX BloomFilter.ts:90

blurX: number = 2

Sets the strength of the blurX property

blurY BloomFilter.ts:103

blurY: number = 2

Sets the strength of the blurY property