Interface CanvasSandboxApplication<TCanvas, TApplicationOptions>

Describes an application running inside the CanvasSandbox.

interface CanvasSandboxApplication<
    TCanvas extends Canvas,
    TApplicationOptions extends CanvasSandboxExpectedOptions,
> {
    options: TApplicationOptions;
    paused: boolean;
    random: Random;
    onDraw(delta: number, timestamp: number): void;
    pause(paused: boolean): void;
    reconfigure(canvas: TCanvas, options?: Partial<TApplicationOptions>): void;
    start(options?: Partial<TApplicationOptions>): void;
}

Type Parameters

TCanvas extends Canvas
TApplicationOptions extends CanvasSandboxExpectedOptions
The type of the options object with which the application is constructed.

Implemented by

CanvasSandboxHostApplication

Index

Properties

options paused random

Methods

onDraw pause reconfigure start

Properties

options

options: TApplicationOptions

The options with which the application was constructed.

paused

paused: boolean

Is the application currently paused? Should be get/set, but can also be ignored, if the feature isn't used.

random

random: Random

The PRNG used in this application.

Methods

onDraw

onDraw(delta: number, timestamp: number): void
Request the application to draw a new frame.
Parameters
- delta: number
  How many milliseconds passed since the last frame draw.
- timestamp: number
  The current timestamp.
Returns void
- Defined in source/graphics/canvas-sandbox.ts:155

pause

pause(paused: boolean): void
Pause rendering.
Parameters
- paused: boolean
  Should rendering be paused (true) or unpaused (false)?
Returns void
- Defined in source/graphics/canvas-sandbox.ts:173

reconfigure

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
- Defined in source/graphics/canvas-sandbox.ts:162

start

start(options?: Partial<TApplicationOptions>): void
Start the application.
Parameters
- Optionaloptions: Partial<TApplicationOptions>
Returns void
- Defined in source/graphics/canvas-sandbox.ts:167