G-code Preview — API Reference
    Preparing search index...

    Interface RenderStillOptions

    interface RenderStillOptions {
        buildVolume?: MachineGeometry | BuildVolumeDef;
        camera?: StillCameraPose;
        cameraMode?: CameraMode;
        canvas: RenderTargetCanvas;
        colorMode?: ColorMode;
        createRenderer?: (canvas: RenderTargetCanvas) => GLRendererLike;
        createWorker?: WorkerLike | (() => WorkerLike);
        height?: number;
        layerRange?: [number, number];
        parseOptions?: WireParseOptions;
        quality?: QualityMode | "auto";
        scrub?: null | number;
        showTravel?: boolean;
        theme?: Theme;
        tube?: TubeOptions;
        width?: number;
    }
    Index

    Properties

    buildVolume? camera? cameraMode? canvas colorMode? createRenderer? createWorker? height? layerRange? parseOptions? quality? scrub? showTravel? theme? tube? width?

    Properties

    buildVolume?: MachineGeometry | BuildVolumeDef

    Bed geometry — a renderer volume or discovered MachineGeometry.

    camera?: StillCameraPose

    Camera: an explicit pose, or omitted for deterministic bounds framing.

    cameraMode?: CameraMode

    Camera projection (#150, DD-009 D3); default 'perspective'.

    canvas: RenderTargetCanvas

    Target surface: an OffscreenCanvas (worker/headless) or a DOM canvas. Required.

    colorMode?: ColorMode
    createRenderer?: (canvas: RenderTargetCanvas) => GLRendererLike

    GL backend injection (tests / exotic hosts). Default: WebGLRenderer.

    createWorker?: WorkerLike | (() => WorkerLike)

    Worker factory for the bytes path (batteries default when omitted).

    height?: number
    layerRange?: [number, number]

    Inclusive layer clip [start, end]. Omitted → whole model.

    parseOptions?: WireParseOptions

    Wire parse options for the bytes path (dialects/containers/plate/limits).

    quality?: QualityMode | "auto"

    Quality tier (default 'auto': tubes ≤ 1 M segments, else lines).

    scrub?: null | number

    Draw only up to this segment (progress-style clip). null/omitted → whole model.

    showTravel?: boolean

    Include travel moves (default false).

    theme?: Theme

    Bounded declarative theme (#153, DD-009 D4); headless stills theme identically.

    tube?: TubeOptions
    width?: number

    Output size. Defaults to the canvas's current width/height.

    Settings

    Member Visibility

    On This Page

    Properties