Filter
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. |
Members
Description:
The Camera this effect belongs to.
Description:
The direction of the fade.
true = fade out (transparent to color), false = fade in (color to transparent)
Type:
Description:
The duration of the effect, in milliseconds.
Type:
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:
Description:
Is this effect actively running?
Type:
Description:
If this effect is running this holds the current percentage of the progress, a value between 0 and 1.
Type:
Methods
Description:
Destroys this effect, releasing it from the Camera.
Description:
Called internally when the effect completes.
Fires:
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
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 |
| 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
Description:
Resets this camera effect. If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.
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. |
| 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.
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. |