Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Cameras . Scene2D . Effects . Fade

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Cameras . Scene2D . Effects . Fade

A Camera Fade effect.

This effect will fade the camera viewport to the given color, over the duration specified.

Only the camera viewport is faded. None of the objects it is displaying are impacted, i.e. their colors do not change.

The effect will dispatch several events on the Camera itself and you can also specify an onUpdate callback, which is invoked each frame for the duration of the effect, if required.

Constructor:

new Fade(camera)

Parameters:

name type description
camera Phaser.Cameras.Scene2D.Camera

The camera this effect is acting upon.

Since: 3.5.0

Members

<private> _elapsed: number
Focus
Focus

Description:

Effect elapsed timer.

Type:
number
Since: 3.5.0
Focus
Focus
<private, nullable> _onUpdate: Phaser.Types.Cameras.Scene2D.CameraFadeCallback
Focus
Focus

Description:

This callback is invoked every frame for the duration of the effect.

Type:
Default: null
Since: 3.5.0
Focus
Focus
<private> _onUpdateScope: any
Focus
Focus

Description:

On Complete callback scope.

Type:
any
Since: 3.5.0
Focus
Focus
<private> alpha: number
Focus
Focus

Description:

The value of the alpha channel used during the fade effect. A value between 0 and 1.

Type:
number
Since: 3.5.0
Focus
Focus
<private> blue: number
Focus
Focus

Description:

The value of the blue color channel the camera will use for the fade effect. A value between 0 and 255.

Type:
number
Since: 3.5.0
Focus
Focus
<readonly> camera: Phaser.Cameras.Scene2D.Camera
Focus
Focus

Description:

The Camera this effect belongs to.

Type:
Since: 3.5.0
Focus
Focus
<readonly> direction: boolean
Focus
Focus

Description:

The direction of the fade. true = fade out (transparent to color), false = fade in (color to transparent)

Type:
boolean
Since: 3.5.0
Focus
Focus
<readonly> duration: number
Focus
Focus

Description:

The duration of the effect, in milliseconds.

Type:
number
Default: 0
Since: 3.5.0
Focus
Focus
<private> green: number
Focus
Focus

Description:

The value of the green color channel the camera will use for the fade effect. A value between 0 and 255.

Type:
number
Since: 3.5.0
Focus
Focus
<readonly> isComplete: boolean
Focus
Focus

Description:

Has this effect finished running?

This is different from isRunning because it remains set to true when the effect is over, until the effect is either reset or started again.

Type:
boolean
Default: false
Since: 3.5.0
Focus
Focus
<readonly> isRunning: boolean
Focus
Focus

Description:

Is this effect actively running?

Type:
boolean
Default: false
Since: 3.5.0
Focus
Focus
progress: number
Focus
Focus

Description:

If this effect is running this holds the current percentage of the progress, a value between 0 and 1.

Type:
number
Since: 3.5.0
Focus
Focus
<private> red: number
Focus
Focus

Description:

The value of the red color channel the camera will use for the fade effect. A value between 0 and 255.

Type:
number
Since: 3.5.0
Focus
Focus

Methods

destroy()
Focus
Focus

Description:

Destroys this effect, releasing it from the Camera.

Examples:
Since: 3.5.0
Focus
Focus
effectComplete()
Focus
Focus

Description:

Called internally when the effect completes.

Examples:
Since: 3.5.0
Focus
Focus
postRenderCanvas(ctx)
Focus
Focus

Description:

Called internally by the Canvas Renderer.

Parameters:

name type description
ctx CanvasRenderingContext2D

The Canvas context to render to.

Returns:
Description:

true if the effect drew to the renderer, otherwise false.

Type:
  • boolean
Examples:
Since: 3.5.0
Focus
Focus
postRenderWebGL(pipeline, getTintFunction)
Focus
Focus

Description:

Called internally by the WebGL Renderer.

Parameters:

name type description
pipeline Phaser.Renderer.WebGL.Pipelines.MultiPipeline

The WebGL Pipeline to render to. Must provide the drawFillRect method.

getTintFunction function

A function that will return the gl safe tint colors.

Returns:
Description:

true if the effect drew to the renderer, otherwise false.

Type:
  • boolean
Examples:
Since: 3.5.0
Focus
Focus
reset()
Focus
Focus

Description:

Resets this camera effect. If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.

Examples:
Since: 3.5.0
Focus
Focus
start([direction], [duration], [red], [green], [blue], [force], [callback], [context])
Focus
Focus

Description:

Fades the Camera to or from the given color over the duration specified.

Parameters:

name type arguments Default description
direction boolean <optional> true

The direction of the fade. true = fade out (transparent to color), false = fade in (color to transparent)

duration number <optional> 1000

The duration of the effect in milliseconds.

red number <optional> 0

The amount to fade the red channel towards. A value between 0 and 255.

green number <optional> 0

The amount to fade the green channel towards. A value between 0 and 255.

blue number <optional> 0

The amount to fade the blue channel towards. A value between 0 and 255.

force boolean <optional> false

Force the effect to start immediately, even if already running.

callback Phaser.Types.Cameras.Scene2D.CameraFadeCallback <optional>

This callback will be invoked every frame for the duration of the effect. It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.

context any <optional>

The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.

Returns:
Description:

The Camera on which the effect was started.

Examples:
Since: 3.5.0
Focus
Focus
update(time, delta)
Focus
Focus

Description:

The main update loop for this effect. Called automatically by the Camera.

Parameters:

name type description
time number

The current timestamp as generated by the Request Animation Frame or SetTimeout.

delta number

The delta time, in ms, elapsed since the last frame.

Examples:
Since: 3.5.0
Focus
Focus