Skip to main content
Version: Phaser v3.88.2

ShineFXPipeline

The Shine FX Pipeline.

The shine effect is a visual technique that simulates the appearance of reflective

or glossy surfaces by passing a light beam across a Game Object. This effect is used to

enhance visual appeal, emphasize certain features, and create a sense of depth or

material properties.

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


const sprite = this.add.sprite();



sprite.postFX.addShine();

Constructor

new ShineFXPipeline(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/ShineFXPipeline.js#L11
Since: 3.60.0

Inherited Members​

From Phaser.Renderer.WebGL.Pipelines.PostFXPipeline:

From Phaser.Renderer.WebGL.WebGLPipeline:

Public Members​

gradient​

gradient: number​

Description:

The gradient of the Shine effect.

Source: src/renderer/webgl/pipelines/fx/ShineFXPipeline.js#L67
Since: 3.60.0

lineWidth​

lineWidth: number​

Description:

The line width of the Shine effect.

Source: src/renderer/webgl/pipelines/fx/ShineFXPipeline.js#L58
Since: 3.60.0

reveal​

reveal: boolean​

Description:

Does this Shine effect reveal or get added to its target?

Source: src/renderer/webgl/pipelines/fx/ShineFXPipeline.js#L76
Since: 3.60.0

speed​

speed: number​

Description:

The speed of the Shine effect.

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

Inherited Methods​

From Phaser.Events.EventEmitter:

From Phaser.Renderer.WebGL.Pipelines.PostFXPipeline:

From Phaser.Renderer.WebGL.WebGLPipeline: