PIXI.filters.AdvancedBloomFilter

class AdvancedBloomFilter extends PIXI.Filter

The AdvancedBloomFilter applies a Bloom Effect to an object. Unlike the normal BloomFilter this had some advanced controls for adjusting the look of the bloom. Note: this filter is slower than normal BloomFilter.
original filter

See:

Constructor

new PIXI.filters.AdvancedBloomFilter(options: object | number) → {}

Parameters:
Name	Type	Attributes	Default	Description
options	object \| number	<optional>		The optional parameters of advanced bloom filter. When options is a number , it will be `options.threshold`.
options.threshold	number	<optional>	0.5	Defines how bright a color needs to be to affect bloom.
options.bloomScale	number	<optional>	1.0	To adjust the strength of the bloom. Higher values is more intense brightness.
options.brightness	number	<optional>	1.0	The brightness, lower value is more subtle brightness, higher value is blown-out.
options.blur	number	<optional>	8	Sets the strength of the Blur properties simultaneously
options.quality	number	<optional>	4	The quality of the Blur filter.
options.kernels	Array<number>	<optional>	null	The kernels of the Blur filter.
options.pixelSize	number \| number<Array> \| PIXI.Point	<optional>	1	the pixelSize of the Blur filter.
options.resolution	number	<optional>	PIXI.settings.FILTER_RESOLUTION	The resolution of the Blur filter.

Summary

Properties from AdvancedBloomFilter

AdvancedBloomFilterOptions	static defaults Default construction options.
number	bloomScale = 1 To adjust the strength of the bloom. Higher values is more intense brightness.
number	blur = 2 Sets the strength of the Blur properties simultaneously
number	brightness = 1 The brightness, lower value is more subtle brightness, higher value is blown-out.
number[]	kernels Sets the kernels of the Blur Filter
number \| number<Array> \| PIXI.Point	pixelSize = 1 Sets the pixelSize of the Kawase Blur filter
number	quality = 4 Sets the quality of the Blur Filter
number	threshold = 0.5 Defines how bright a color needs to be to affect bloom.

Properties inherited from Filter

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.

Properties inherited from Shader

PIXI.Program

program

Program that the shader uses.

Dict<any>

uniforms

Public Properties

defaults AdvancedBloomFilter.ts:36

static defaults: AdvancedBloomFilterOptions

Default construction options.

bloomScale AdvancedBloomFilter.ts:48

bloomScale: number = 1

To adjust the strength of the bloom. Higher values is more intense brightness.

blur AdvancedBloomFilter.ts:175

blur: number = 2

Sets the strength of the Blur properties simultaneously

brightness AdvancedBloomFilter.ts:51

brightness: number = 1

The brightness, lower value is more subtle brightness, higher value is blown-out.

kernels AdvancedBloomFilter.ts:163

kernels: number[]

Sets the kernels of the Blur Filter

pixelSize AdvancedBloomFilter.ts:203

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

Sets the pixelSize of the Kawase Blur filter

quality AdvancedBloomFilter.ts:189

quality: number = 4

Sets the quality of the Blur Filter

threshold AdvancedBloomFilter.ts:149

threshold: number = 0.5

Defines how bright a color needs to be to affect bloom.