PixiJS Filters

Class: AdvancedBloomFilter

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.ts:56
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.
See:

Extends

  • PIXI.Filter

Members

AdvancedBloomFilter.defaults AdvancedBloomFilterOptions staticreadonly

Default construction options.

bloomScale number

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

Default Value:
  • 1

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

kernels number[]

Sets the kernels of the Blur Filter

pixelSize number | number<Array> | 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

threshold number

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

Default Value:
  • 0.5