Class CanvasSandboxHostApplication<TCanvas, TApplicationOptions>Abstract

constructor

• new CanvasSandboxHostApplication<
      TCanvas extends Canvas,
      TApplicationOptions extends CanvasSandboxExpectedOptions,
  >(
      canvas: TCanvas,
      options: TApplicationOptions,
  ): CanvasSandboxHostApplication<TCanvas, TApplicationOptions>

  Construct a new host application.

  Type Parameters

  • TCanvas extends Canvas
  • TApplicationOptions extends CanvasSandboxExpectedOptions

  Parameters

  • canvas: TCanvas

    Usually a hidden canvas in the DOM to serve as an event proxy.
  • options: TApplicationOptions

    Application options.

  Returns CanvasSandboxHostApplication<TCanvas, TApplicationOptions>

canvas

options

paused

random

Readonlyworkers

onDraw

• onDraw(_delta: number, _timestamp: number): void

  Request the application to draw a new frame. This call has no effect in a host application, as all rendering happens in the workers.

  Parameters

  • _delta: number

    How many milliseconds passed since the last frame draw.
  • _timestamp: number

    The current timestamp.

  Returns void

pause

• pause(): void

  Pauses all workers.

  Returns void

postMessageAll

• postMessageAll(message: CanvasWorkerMessage<TApplicationOptions>): void

  Posts a message to all workers.

  Parameters

  • message: CanvasWorkerMessage<TApplicationOptions>

    Message to post to all workers.

  Returns void

Abstractreconfigure

• reconfigure(canvas: TCanvas, options?: Partial<TApplicationOptions>): void

  Reconfigure the application with the given options and restart it.

  Parameters

  • canvas: TCanvas

    The canvas to use.
  • Optionaloptions: Partial<TApplicationOptions>

    The new options to use.

  Returns void

start

• start(): void

  Start the application.

  Returns void