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

    Interface ToolpathRendererOptions

    interface ToolpathRendererOptions {
        buildVolume?: BuildVolumeDef;
        cameraMode?: CameraMode;
        canvas: RenderTargetCanvas;
        chunksPerTick?: number;
        colorMode?: ColorMode;
        createRenderer?: (canvas: RenderTargetCanvas) => GLRendererLike;
        preserveDrawingBuffer?: boolean;
        quality?: "auto" | QualityMode;
        scheduleFrame?: (cb: () => void) => void;
        theme?: Theme;
        tube?: TubeOptions;
    }
    Index

    Properties

    buildVolume? cameraMode? canvas chunksPerTick? colorMode? createRenderer? preserveDrawingBuffer? quality? scheduleFrame? theme? tube?

    Properties

    buildVolume?: BuildVolumeDef
    cameraMode?: CameraMode

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

    canvas: RenderTargetCanvas
    chunksPerTick?: number

    Count-based tick override (tests/deterministic hosts): exactly N chunks per tick. Default (unset): TIME-budgeted ticks — chunks build until ~8 ms of work has elapsed (§8: no main-thread stall > 16 ms during incremental build).

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

    Injectables for tests / exotic hosts.

    preserveDrawingBuffer?: boolean

    Preserve the WebGL drawing buffer so the canvas can be read back after a render returns (toDataURL / convertToBlob / readPixels). Off by default (interactive rendering is faster without it); the headless still-render path (#132) turns it on so a single render is capturable.

    quality?: "auto" | QualityMode

    §4.3 quality tier; 'auto' (default) picks tubes ≤ 1 M segments, else lines.

    scheduleFrame?: (cb: () => void) => void
    theme?: Theme

    Bounded declarative theme (#153, DD-009 D4); omitted fields keep the default look.

    tube?: TubeOptions

    Tube profile parameters (tubes mode only).

    Settings

    Member Visibility

    On This Page

    Properties