Class Flash

constructor

• new Flash(camera: Cameras.Scene2D.Camera): Flash

  Parameters

  • camera: Cameras.Scene2D.Camera

    The camera this effect is acting upon.

  Returns Flash

alpha

Readonlycamera

Readonlyduration

ReadonlyisRunning

progress

destroy

• destroy(): void

  Destroys this effect, releasing it from the Camera.

  Returns void

effectComplete

• effectComplete(): void

  Called internally when the effect completes.

  Returns void

postRenderCanvas

• postRenderCanvas(ctx: CanvasRenderingContext2D): boolean

  Called internally by the Canvas Renderer.

  Parameters

  • ctx: CanvasRenderingContext2D

    The Canvas context to render to.

  Returns boolean

postRenderWebGL

• postRenderWebGL(): boolean

  Called internally by the WebGL Renderer.

  Returns boolean

reset

• reset(): void

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

  Returns void

start

• start(
      duration?: number,
      red?: number,
      green?: number,
      blue?: number,
      force?: boolean,
      callback?: CameraFlashCallback,
      context?: any,
  ): Cameras.Scene2D.Camera

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

  Parameters

  • Optionalduration: number

    The duration of the effect in milliseconds. Default 250.
  • Optionalred: number

    The amount to flash the red channel towards. A value between 0 and 255. Default 255.
  • Optionalgreen: number

    The amount to flash the green channel towards. A value between 0 and 255. Default 255.
  • Optionalblue: number

    The amount to flash the blue channel towards. A value between 0 and 255. Default 255.
  • Optionalforce: boolean

    Force the effect to start immediately, even if already running. Default false.
  • Optionalcallback: CameraFlashCallback

    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.
  • Optionalcontext: any

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

  Returns Cameras.Scene2D.Camera

update

• update(time: number, delta: number): void

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

  Parameters

  • 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.

  Returns void