Interface RenderDriver

Driver for a concrete rendering backend (e.g., WebGL).

interface RenderDriver {
    context: RenderContext;
    diagnostics: RenderDiagnostics;
    projections: Projections;
    renderTarget: RenderTarget;
    textures: DriverTextures;
    addLifeCycleHandler<H extends RenderContextLifeCycleHandler>(
        handler: H,
    ): void;
    finalizeFrame(): void;
    initialize(): Promise<void>;
    prepareFrame(): boolean;
    removeLifeCycleHandler(handler: RenderContextLifeCycleHandler): boolean;
    setCanvasDimensions(dimensions: Vec2Like): void;
    useRenderTarget(renderTarget: RenderTarget | "canvas"): void;
}

Implemented by

WGLDriver

Index

Properties

context diagnostics projections renderTarget textures

Methods

addLifeCycleHandler finalizeFrame initialize prepareFrame removeLifeCycleHandler setCanvasDimensions useRenderTarget

Properties

`Readonly`context

context: RenderContext

Context.

`Readonly`diagnostics

diagnostics: RenderDiagnostics

Diagnostics like frame time.

`Readonly`projections

projections: Projections

Projections.

`Readonly`renderTarget

renderTarget: RenderTarget

`Readonly`textures

textures: DriverTextures

Driver-specific texture manager.

Methods

addLifeCycleHandler

addLifeCycleHandler<H extends RenderContextLifeCycleHandler>(handler: H): void
Register a new handler to be called on life cycle events.
Type Parameters
- H extends RenderContextLifeCycleHandler
Parameters
- handler: H
  Handler
Returns void
- Defined in rendering/render-driver.ts:70

finalizeFrame

finalizeFrame(): void
Finalize rendering for a frame.

Returns void
- Defined in rendering/render-driver.ts:59

initialize

initialize(): Promise<void>
Initialize the renderer and any context handlers.

Returns Promise<void>
- Defined in rendering/render-driver.ts:64

prepareFrame

prepareFrame(): boolean
Call to prepare rendering a frame.

Returns boolean
false if preparation failed and rendering should not happen. Can be caused by WebGL context loss.
- Defined in rendering/render-driver.ts:55

removeLifeCycleHandler

removeLifeCycleHandler(handler: RenderContextLifeCycleHandler): boolean
Remove a handler.
Parameters
- handler: RenderContextLifeCycleHandler
  Handler
Returns boolean
- Defined in rendering/render-driver.ts:77

setCanvasDimensions

setCanvasDimensions(dimensions: Vec2Like): void
Parameters
- dimensions: Vec2Like
Returns void
- Defined in rendering/render-driver.ts:49

useRenderTarget

useRenderTarget(renderTarget: RenderTarget | "canvas"): void
Parameters
- renderTarget: RenderTarget | "canvas"
Returns void
- Defined in rendering/render-driver.ts:47