Interface Renderer

Common interface for all renderers.

interface Renderer {
    get options(): ASCIIRendererOptions;
    set options(options: ASCIIRendererOptions): void;
    initialize(canvas: HTMLCanvasElement, options: ASCIIRendererOptions): void;
    clear(backgroundColor: string): void;
    render(characters: CharacterData[], region: RenderRegion): void;
    resize(width: number, height: number): void;
    destroy(): void;
}

Implemented by

Index

Accessors

Methods

initialize clear render resize destroy

Accessors

options

get options(): ASCIIRendererOptions
Get the rendering options.

Returns ASCIIRendererOptions
- Defined in rendering/renderer.ts:12
set options(options: ASCIIRendererOptions): void
Set the rendering options.
Parameters
- options: ASCIIRendererOptions
Returns void
- Defined in rendering/renderer.ts:17

Methods

initialize

initialize(canvas: HTMLCanvasElement, options: ASCIIRendererOptions): void
Initialize the renderer with the given canvas.
Parameters
- canvas: HTMLCanvasElement
- options: ASCIIRendererOptions
Returns void
- Defined in rendering/renderer.ts:22

clear

clear(backgroundColor: string): void
Clear the canvas with the given background color.
Parameters
- backgroundColor: string
Returns void
- Defined in rendering/renderer.ts:27

render

render(characters: CharacterData[], region: RenderRegion): void
Render the given characters.
Parameters
- characters: CharacterData[]
- region: RenderRegion
Returns void
- Defined in rendering/renderer.ts:32

resize

resize(width: number, height: number): void
Resize the renderer to the given dimensions.
Parameters
- width: number
- height: number
Returns void
- Defined in rendering/renderer.ts:37

destroy

destroy(): void
Cleanup resources.

Returns void
- Defined in rendering/renderer.ts:42