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

    Interface SceneViewCanvasProps<TData, TLayer, TPose>

    interface SceneViewCanvasProps<TData, TLayer extends string, TPose> {
        canvasRef?: Ref<HTMLCanvasElement>;
        className?: string;
        drawOne: SceneViewDrawOne<TData, TLayer, TPose>;
        extraCommands?: readonly DrawCommand[];
        height: number;
        scene: Scene<TData, TLayer, TPose>;
        view: View;
        width: number;
    }

    Type Parameters

    • TData
    • TLayer extends string
    • TPose
    Index

    Properties

    canvasRef? className? drawOne extraCommands? height scene view width

    Properties

    canvasRef?: Ref<HTMLCanvasElement>

    Forwarded ref to the underlying <canvas>. Consumers attach their own pointer listeners or call toBlob for snapshots through this.

    className?: string

    Optional CSS class for sizing / positioning the <canvas>. The kit does not emit inline styles for layout — use a class.

    drawOne: SceneViewDrawOne<TData, TLayer, TPose>

    Per-node draw callback. See SceneViewDrawOne. The consumer is responsible for what gets painted — there is no AABB-fill default.

    extraCommands?: readonly DrawCommand[]

    Optional extra commands appended after scene commands, inside the same view transform. Used by <MinimapCanvas> for its visible-window indicator; available to other consumers that want to overlay a world-space annotation.

    height: number

    CSS-pixel height.

    scene: Scene<TData, TLayer, TPose>

    Scene to render. Must be the same Scene instance passed to whoever is mutating it; the component subscribes to its version stream and repaints when the version advances.

    view: View

    Camera. Applied to scene + extraCommands via the renderer's group transform.

    width: number

    CSS-pixel width. Drives both layout (via the rendered drawing-buffer size) and the renderer's coordinate space.

    Settings

    Member Visibility

    On This Page

    Properties