Interface Renderer

Backend-agnostic 2D renderer interface.

interface Renderer {
    canvas: HTMLCanvasElement;
    type: "canvas2d" | "webgl2" | "webgpu";
    begin(): void;
    bindFrameBuffer(fb: FrameBuffer | null): void;
    clear(color: string | Color): void;
    createFrameBuffer(width: number, height: number): FrameBuffer;
    drawCircle(pos: Vec2, radius: number, color: string | Color): void;
    drawCircleOutline(
        pos: Vec2,
        radius: number,
        color: string | Color,
        thickness?: number,
    ): void;
    drawFrameBuffer(
        fb: FrameBuffer,
        x: number,
        y: number,
        w: number,
        h: number,
    ): void;
    drawLine(a: Vec2, b: Vec2, color: string | Color, thickness?: number): void;
    drawRect(pos: Vec2, size: Vec2, color: string | Color): void;
    drawRectOutline(
        pos: Vec2,
        size: Vec2,
        color: string | Color,
        thickness?: number,
    ): void;
    drawSprite(
        image: CanvasImageSource,
        pos: Vec2,
        size?: Vec2,
        options?: SpriteOptions,
    ): void;
    drawText(text: string, pos: Vec2, options?: TextOptions): void;
    end(): void;
    getContext(): unknown;
    getStats(): RendererStats;
    resetTransform(): void;
    setPostProcessing(config?: PostProcessingConfig): void;
    setTransform(pos: Vec2, zoom: number): void;
}

Properties

`Readonly`canvas

canvas: HTMLCanvasElement

The HTML canvas element used for rendering.

`Readonly`type

type: "canvas2d" | "webgl2" | "webgpu"

The rendering backend type.

Methods

begin

begin(): void
Begin a new render frame.

Returns void
- Defined in render/types.ts:172

bindFrameBuffer

bindFrameBuffer(fb: FrameBuffer | null): void
Bind a framebuffer as the render target, or null for the main canvas.
Parameters
- fb: FrameBuffer | null
Returns void
- Defined in render/types.ts:192

clear

clear(color: string | Color): void
Clear the screen with a solid color.
Parameters
- color: string | Color
Returns void
- Defined in render/types.ts:176

createFrameBuffer

createFrameBuffer(width: number, height: number): FrameBuffer
Create an offscreen framebuffer of the given size.
Parameters
- width: number
- height: number
Returns FrameBuffer
- Defined in render/types.ts:190

drawCircle

drawCircle(pos: Vec2, radius: number, color: string | Color): void
Draw a filled circle.
Parameters
- pos: Vec2
- radius: number
- color: string | Color
Returns void
- Defined in render/types.ts:207

drawCircleOutline

drawCircleOutline(
    pos: Vec2,
    radius: number,
    color: string | Color,
    thickness?: number,
): void
Draw a circle outline (stroke only).
Parameters
- pos: Vec2
- radius: number
- color: string | Color
- Optionalthickness: number
Returns void
- Defined in render/types.ts:225

drawFrameBuffer

drawFrameBuffer(
    fb: FrameBuffer,
    x: number,
    y: number,
    w: number,
    h: number,
): void
Draw a framebuffer's contents to the screen.
Parameters
- fb: FrameBuffer
- x: number
- y: number
- w: number
- h: number
Returns void
- Defined in render/types.ts:194

drawLine

drawLine(a: Vec2, b: Vec2, color: string | Color, thickness?: number): void
Draw a line between two points.
Parameters
- a: Vec2
- b: Vec2
- color: string | Color
- Optionalthickness: number
Returns void
- Defined in render/types.ts:205

drawRect

drawRect(pos: Vec2, size: Vec2, color: string | Color): void
Draw a filled rectangle.
Parameters
- pos: Vec2
- size: Vec2
- color: string | Color
Returns void
- Defined in render/types.ts:203

drawRectOutline

drawRectOutline(
    pos: Vec2,
    size: Vec2,
    color: string | Color,
    thickness?: number,
): void
Draw a rectangle outline (stroke only).
Parameters
- pos: Vec2
- size: Vec2
- color: string | Color
- Optionalthickness: number
Returns void
- Defined in render/types.ts:218

drawSprite

drawSprite(
    image: CanvasImageSource,
    pos: Vec2,
    size?: Vec2,
    options?: SpriteOptions,
): void
Draw an image or sprite sheet frame.
Parameters
- image: CanvasImageSource
- pos: Vec2
- Optionalsize: Vec2
- Optionaloptions: SpriteOptions
Returns void
- Defined in render/types.ts:209

drawText

drawText(text: string, pos: Vec2, options?: TextOptions): void
Draw text at a position.
Parameters
- text: string
- pos: Vec2
- Optionaloptions: TextOptions
Returns void
- Defined in render/types.ts:216

end

end(): void
End the current render frame and flush pending draws.

Returns void
- Defined in render/types.ts:174

getContext

getContext(): unknown
Return the underlying rendering context (CanvasRenderingContext2D or WebGL2RenderingContext).

Returns unknown
- Defined in render/types.ts:178

getStats

getStats(): RendererStats
Return per-frame renderer instrumentation counters.

Returns RendererStats
- Defined in render/types.ts:180

resetTransform

resetTransform(): void
Reset to the default (identity) transform.

Returns void
- Defined in render/types.ts:187

setPostProcessing

setPostProcessing(config?: PostProcessingConfig): void
Configure post-processing. Unsupported backends may ignore this.
Parameters
- Optionalconfig: PostProcessingConfig
Returns void
- Defined in render/types.ts:182

setTransform

setTransform(pos: Vec2, zoom: number): void
Apply camera transform (center position and zoom).
Parameters
- pos: Vec2
- zoom: number
Returns void
- Defined in render/types.ts:185

Interface Renderer

Index

Properties

Methods

Properties

Readonlycanvas

Readonlytype

Methods

begin

Returns void

bindFrameBuffer

Parameters

Returns void

clear

Parameters

Returns void

createFrameBuffer

Parameters

Returns FrameBuffer

drawCircle

Parameters

Returns void

drawCircleOutline

Parameters

Returns void

drawFrameBuffer

Parameters

Returns void

drawLine

Parameters

Returns void

drawRect

Parameters

Returns void

drawRectOutline

Parameters

Returns void

drawSprite

Parameters

Returns void

drawText

Parameters

Returns void

end

Returns void

getContext

Returns unknown

getStats

Returns RendererStats

resetTransform

Returns void

setPostProcessing

Parameters

Returns void

setTransform

Parameters

Returns void

Settings

On This Page

`Readonly`canvas

`Readonly`type