PixiJS Filters

Class: AdvancedBloomFilter

PIXI.filters~AdvancedBloomFilter

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.
originalfilter

new AdvancedBloomFilter (options)

AdvancedBloomFilter.js:33
Name Type Description
options object | number optional

The optional parameters of advanced bloom filter. When options is a number , it will be options.threshold.

Name Type Default Description
threshold number 0.5 optional

Defines how bright a color needs to be to affect bloom.
bloomScale number 1.0 optional

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

The brightness, lower value is more subtle brightness, higher value is blown-out.
blur number 8 optional

Sets the strength of the Blur properties simultaneously
quality number 4 optional

The quality of the Blur filter.
kernels Array.<number> null optional

The kernels of the Blur filter.
pixelSize number | Array.<number> | PIXI.Point 1 optional

the pixelSize of the Blur filter.
resolution number PIXI.settings.FILTER_RESOLUTION optional

The resolution of the Blur filter.
See:

Extends

  • PIXI.Filter

Members

bloomScale number

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

Default Value:
  • 1.0

blur number

Sets the strength of the Blur properties simultaneously

Default Value:
  • 2

brightness number

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

Default Value:
  • 1.0

kernels number

Sets the kernels of the Blur Filter

Default Value:
  • 4

pixelSize number | Array.<number> | PIXI.Point

Sets the pixelSize of the Kawase Blur filter

Default Value:
  • 1

quality number

Sets the quality of the Blur Filter

Default Value:
  • 4

resolution number

The resolution of the filter.

threshold number

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

Default Value:
  • 0.5