Class CanvasRenderer

A renderer for a HTMLCanvasElement.

Attach an instance of a BitmapGenerator with a attach method.

Hierarchy

BaseRenderer
- CanvasRenderer

Implements

CanvasRendererOptions

Index

Constructors

Properties

bitmapHandler ctx generator height isAnimating readyHandler spool target width

Methods

animate attach detach

Constructors

constructor

new CanvasRenderer(target: HTMLCanvasElement, options?: CanvasRendererOptions): CanvasRenderer
Creates a new canvas renderer instance.
Parameters
- target: HTMLCanvasElement
- Optional options: CanvasRendererOptions
Returns CanvasRenderer
Overrides BaseRenderer.constructor
- Defined in src/ts/canvas.ts:39

Properties

`Protected` bitmapHandler

bitmapHandler: ((event: CustomEvent<any>) => void)

Type declaration

- (event: CustomEvent<any>): void
- Parameters
  - event: CustomEvent<any>
  Returns void

ctx

ctx: CanvasRenderingContext2D

The rendering context of a target canvas.

generator

generator: BitmapGenerator

The attached bitmap generator.

height

height: number

Target image height in pixels.

isAnimating

isAnimating: boolean

Animation state.

`Protected` readyHandler

readyHandler: (() => void)

Type declaration

- (): void
- Returns void

`Protected` spool

spool: BitmapDetail[]

target

target: HTMLCanvasElement

The target canvas.

width

width: number

Target image width in pixels.

Methods

animate

animate(enable: boolean): void
Controls animation state.
Parameters
- enable: boolean
Returns void
Inherited from BaseRenderer.animate
- Defined in src/ts/renderer.ts:58

attach

attach(generator: BitmapGenerator): void
Attaches a bitmap generator instance to this renderer.
Parameters
- generator: BitmapGenerator
Returns void
Inherited from BaseRenderer.attach
- Defined in src/ts/renderer.ts:33

detach

detach(): BitmapGenerator
Detaches a bitmap generator instance from this renderer.

Returns BitmapGenerator
Inherited from BaseRenderer.detach
- Defined in src/ts/renderer.ts:44