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

    Interface RenderSceneToPixelsArgs<TData, TLayer, TPose>

    interface RenderSceneToPixelsArgs<TData, TLayer extends string, TPose> {
        background?: string;
        createCanvas?: (widthPx: number, heightPx: number) => HeadlessCanvasLike;
        drawOne?: SceneViewDrawOne<TData, TLayer, TPose>;
        flattenTolerancePx?: number;
        gl?: WebGL2RenderingContext;
        resolveImage?: (
            node: SceneNode<TData, TLayer, TPose>,
        ) => ImageBitmap | undefined;
        scale: { x: number; y: number };
        scene: Scene<TData, TLayer, TPose>;
        sourceRect: { height: number; width: number; x: number; y: number };
    }

    Type Parameters

    • TData
    • TLayer extends string
    • TPose
    Index

    Properties

    background?: string

    Background fill (any CSS color accepted by the renderer). Default: fully transparent. Passing a color is always valid.

    createCanvas?: (widthPx: number, heightPx: number) => HeadlessCanvasLike

    One-shot canvas factory (DOM canvas, OffscreenCanvas, or test fake). Mutually exclusive with gl. Default: OffscreenCanvas when available, else document.createElement('canvas').

    Per-node draw callback. Default: defaultDrawOne with resolveImage threaded as its NodePaintCtx. Custom drawOne callers that still want resolver injection should call defaultDrawOne(node, pose, ctx) themselves.

    flattenTolerancePx?: number

    Max curve-flattening error in OUTPUT pixels. Default 0.25. Converted to world units against the larger scale axis and passed to the renderer's flattenTolerance. Explicitly passing 0.25 is always valid.

    gl?: WebGL2RenderingContext

    Caller-owned WebGL2 context to render with. Mutually exclusive with createCanvas. Never disposed by this call.

    resolveImage?: (
        node: SceneNode<TData, TLayer, TPose>,
    ) => ImageBitmap | undefined

    Bitmap resolver for image nodes — lets consumers reuse their own decode caches. undefined results paint the deterministic grey placeholder outline (see NodePaintCtx.resolveImage).

    scale: { x: number; y: number }

    Output pixels per scene unit, per axis. Anisotropic values supported.

    sourceRect: { height: number; width: number; x: number; y: number }

    Scene-space rect to render (origin + size in scene units). Output pixel dimensions follow from rect × scale (round, min 1 — see module doc).