Skip to main content
Version: Phaser v3.88.2

GlowFXPipeline

The Glow FX Pipeline.

The glow effect is a visual technique that creates a soft, luminous halo around game objects,

characters, or UI elements. This effect is used to emphasize importance, enhance visual appeal,

or convey a sense of energy, magic, or otherworldly presence. The effect can also be set on

the inside of the Game Object. The color and strength of the glow can be modified.

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


const sprite = this.add.sprite();



sprite.postFX.addGlow();

Constructor

new GlowFXPipeline(game, config)

Parameters

nametypeoptionaldescription
gamePhaser.GameNoA reference to the Phaser Game instance.
configobjectNoThe configuration options for this pipeline.

Scope: static

Extends

Phaser.Renderer.WebGL.Pipelines.PostFXPipeline

Source: src/renderer/webgl/pipelines/fx/GlowFXPipeline.js#L13
Since: 3.60.0

Inherited Members​

From Phaser.Renderer.WebGL.Pipelines.PostFXPipeline:

From Phaser.Renderer.WebGL.WebGLPipeline:

Public Members​

glcolor​

glcolor: Array.<number>​

Description:

A 4 element array of gl color values.

Source: src/renderer/webgl/pipelines/fx/GlowFXPipeline.js#L82
Since: 3.60.0

innerStrength​

innerStrength: number​

Description:

The strength of the glow inward from the edge of the Sprite.

Source: src/renderer/webgl/pipelines/fx/GlowFXPipeline.js#L64
Since: 3.60.0

knockout​

knockout: number​

Description:

If true only the glow is drawn, not the texture itself.

Source: src/renderer/webgl/pipelines/fx/GlowFXPipeline.js#L73
Since: 3.60.0

outerStrength​

outerStrength: number​

Description:

The strength of the glow outward from the edge of the Sprite.

Source: src/renderer/webgl/pipelines/fx/GlowFXPipeline.js#L55
Since: 3.60.0

Inherited Methods​

From Phaser.Events.EventEmitter:

From Phaser.Renderer.WebGL.Pipelines.PostFXPipeline:

From Phaser.Renderer.WebGL.WebGLPipeline: