Class CanvasApp<G>`Abstract`

An extended base App, that assumes some things (e.g., a canvas) and sets up some more defaults.

Type Parameters

G extends RenderDriver

Hierarchy (View Summary)

App<G>
- CanvasApp

Index

Constructors

Properties

animationFrameID? camera canvasResizer changeTracker driver lastAnimationFrameTimestamp? textures tickers transforms

Accessors

Methods

initialize initializeAndStart onAnimationFrame render start stop tick

Constructors

constructor

new CanvasApp<G extends RenderDriver>(
    canvas: HTMLCanvasElement,
    driver: G,
    renderMode?: RenderMode,
    camera?: Camera2D,
): CanvasApp<G>
Type Parameters
- G extends RenderDriver
Parameters
- canvas: HTMLCanvasElement
- driver: G
- renderMode: RenderMode = 'always'
- Optionalcamera: Camera2D
Returns CanvasApp<G>
Overrides App.constructor
- Defined in app/canvas-app.ts:23

Properties

`Protected` `Optional`animationFrameID

animationFrameID?: number

`Readonly`camera

camera: Camera2D

`Protected` `Readonly`canvasResizer

canvasResizer: CanvasResizer

`Readonly`changeTracker

changeTracker: ChangeTracker = ...

`Readonly`driver

driver: G

`Protected` `Optional`lastAnimationFrameTimestamp

lastAnimationFrameTimestamp?: number

`Readonly`textures

textures: Textures

`Readonly`tickers

tickers: Tickers = ...

`Readonly`transforms

transforms: TransformPropagator = ...

Accessors

renderMode

get renderMode(): RenderMode
Returns RenderMode
Inherited from App.renderMode
- Defined in app/app.ts:17
set renderMode(renderMode: RenderMode): void
Parameters
- renderMode: RenderMode
Returns void
Inherited from App.renderMode
- Defined in app/app.ts:20

Methods

initialize

initialize(): Promise<void>
Initialize all systems.

Returns Promise<void>
Inherited from App.initialize
- Defined in app/app.ts:47

initializeAndStart

initializeAndStart(): Promise<void>
Initialize all systems and start the app loop.

Returns Promise<void>
Inherited from App.initializeAndStart
- Defined in app/app.ts:38

`Protected`onAnimationFrame

onAnimationFrame(timestamp: number): void
Called for every animation frame.
Parameters
- timestamp: number
  requestAnimationFrame timestamp
Returns void
Remarks
Must request another animation frame.
Inherited from App.onAnimationFrame
- Defined in app/app.ts:75

`Protected`render

render(): void
Called when the app decides a render is needed. Depends on renderMode.

Returns void
Remarks
This should only contain actual rendering code. Any logic should be put into tickers.
Overrides App.render
- Defined in app/canvas-app.ts:51

start

start(): void
Start app loop.

Returns void
Remarks
initialize must be called first.
Inherited from App.start
- Defined in app/app.ts:59

stop

stop(): void
Stop the app loop.

Returns void
Inherited from App.stop
- Defined in app/app.ts:122

`Protected`tick

tick(elapsed: number): void
Called for every tick. A tick does not equal a render.
Parameters
- elapsed: number
  Elapsed time in milliseconds.
Returns void
Remarks
This should only contain app-management code, actual logic should be put into tickers.
Overrides App.tick
- Defined in app/canvas-app.ts:41