Skip to main content
Version: Phaser v3.88.2

BloomFXPipeline

The Bloom FX Pipeline.

Bloom is an effect used to reproduce an imaging artifact of real-world cameras.

The effect produces fringes of light extending from the borders of bright areas in an image,

contributing to the illusion of an extremely bright light overwhelming the

camera or eye capturing the scene.

A Bloom effect is added to a Game Object via the FX component:


const sprite = this.add.sprite();



sprite.postFX.addBloom();

Constructor

new BloomFXPipeline(game)

Parameters

nametypeoptionaldescription
gamePhaser.GameNoA reference to the Phaser Game instance.

Scope: static

Extends

Phaser.Renderer.WebGL.Pipelines.PostFXPipeline

Source: src/renderer/webgl/pipelines/fx/BloomFXPipeline.js#L11
Since: 3.60.0

Inherited Members​

From Phaser.Renderer.WebGL.Pipelines.PostFXPipeline:

From Phaser.Renderer.WebGL.WebGLPipeline:

Public Members​

blurStrength​

blurStrength: number​

Description:

The strength of the blur process of the bloom effect.

Source: src/renderer/webgl/pipelines/fx/BloomFXPipeline.js#L84
Since: 3.60.0

glcolor​

glcolor: Array.<number>​

Description:

The internal gl color array.

Source: src/renderer/webgl/pipelines/fx/BloomFXPipeline.js#L102
Since: 3.60.0

offsetX​

offsetX: number​

Description:

The horizontal offset of the bloom effect.

Source: src/renderer/webgl/pipelines/fx/BloomFXPipeline.js#L66
Since: 3.60.0

offsetY​

offsetY: number​

Description:

The vertical offset of the bloom effect.

Source: src/renderer/webgl/pipelines/fx/BloomFXPipeline.js#L75
Since: 3.60.0

steps​

steps: number​

Description:

The number of steps to run the Bloom effect for.

This value should always be an integer.

It defaults to 4. The higher the value, the smoother the Bloom,

but at the cost of exponentially more gl operations.

Keep this to the lowest possible number you can have it, while

still looking correct for your game.

Source: src/renderer/webgl/pipelines/fx/BloomFXPipeline.js#L49
Since: 3.60.0

strength​

strength: number​

Description:

The strength of the blend process of the bloom effect.

Source: src/renderer/webgl/pipelines/fx/BloomFXPipeline.js#L93
Since: 3.60.0

Inherited Methods​

From Phaser.Events.EventEmitter:

From Phaser.Renderer.WebGL.Pipelines.PostFXPipeline:

From Phaser.Renderer.WebGL.WebGLPipeline: