ReadonlycameraThe Camera this effect belongs to.
ReadonlydirectionThe direction of the fade.
true = fade out (transparent to color), false = fade in (color to transparent)
ReadonlydurationThe duration of the effect, in milliseconds.
ReadonlyisHas 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.
ReadonlyisIs this effect actively running?
If this effect is running this holds the current percentage of the progress, a value between 0 and 1.
Destroys this effect, releasing it from the Camera.
Called internally when the effect completes.
Called internally by the Canvas Renderer.
The Canvas context to render to.
Called internally by the WebGL Renderer.
Resets this camera effect. If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.
Fades the Camera to or from the given color over the duration specified.
Optionaldirection: booleanThe direction of the fade. true = fade out (transparent to color), false = fade in (color to transparent) Default true.
Optionalduration: numberThe duration of the effect in milliseconds. Default 1000.
Optionalred: numberThe amount to fade the red channel towards. A value between 0 and 255. Default 0.
Optionalgreen: numberThe amount to fade the green channel towards. A value between 0 and 255. Default 0.
Optionalblue: numberThe amount to fade the blue channel towards. A value between 0 and 255. Default 0.
Optionalforce: booleanForce the effect to start immediately, even if already running. Default false.
Optionalcallback: CameraFadeCallbackThis 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.
Optionalcontext: anyThe context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
The main update loop for this effect. Called automatically by the Camera.
The current timestamp as generated by the Request Animation Frame or SetTimeout.
The delta time, in ms, elapsed since the last frame.
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
onUpdatecallback, which is invoked each frame for the duration of the effect, if required.