weasel API - v0.8.0
    Preparing search index...

    Interface RenderSceneToCanvasArgs<TData, TLayer, TPose>

    interface RenderSceneToCanvasArgs<TData, TLayer extends string, TPose> {
        canvas: HTMLCanvasElement;
        dpr?: number;
        drawOne: SceneViewDrawOne<TData, TLayer, TPose>;
        extraCommands?: DrawCommand[];
        height: number;
        scene: Scene<TData, TLayer, TPose>;
        view: View;
        width: number;
    }

    Type Parameters

    • TData
    • TLayer extends string
    • TPose
    Index

    Properties

    canvas: HTMLCanvasElement

    The DOM canvas to paint into. The helper owns its WebGL2 context: the first call on a given canvas creates a renderer and stashes it; subsequent calls reuse the same renderer (and resize the drawing buffer on dim changes).

    dpr?: number

    Optional device-pixel ratio. Defaults to window.devicePixelRatio || 1 when available, otherwise 1. Tests typically pin this to 1 or 2.

    Per-node draw callback.

    extraCommands?: DrawCommand[]

    Optional commands appended after the scene-node output. Used for the minimap's visible-window indicator. Wrapped in the same view transform as scene commands.

    height: number

    Scene to walk. scene.renderOrder() provides the per-node order.

    view: View

    Camera view applied to scene + extras (both ride the same world→screen transform; extras living in screen space should be supplied via a separately-prepared extraCommands group or rendered outside this helper).

    width: number

    CSS-pixel size. The drawing buffer is set to width × dpr and height × dpr; CSS size to width / height.