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

    Interface RenderModelStillOptions

    interface RenderModelStillOptions {
        background?: ModelBackground;
        canvas: RenderTargetCanvas;
        createRenderer?: (canvas: RenderTargetCanvas) => GLRendererLike;
        envId?: string;
        filamentPalette?: readonly (undefined | string)[];
        height?: number;
        limits?: ModelLimits;
        renderScope?: RenderScope;
        view?: "iso";
        width?: number;
    }
    Index

    Properties

    background? canvas createRenderer? envId? filamentPalette? height? limits? renderScope? view? width?

    Properties

    background?: ModelBackground

    Background: 'transparent' (default — composite on a card) or a solid CSS color / 0xRRGGBB.

    canvas: RenderTargetCanvas
    createRenderer?: (canvas: RenderTargetCanvas) => GLRendererLike
    envId?: string

    Override the environment id folded into the cache key (default: the three revision).

    filamentPalette?: readonly (undefined | string)[]

    Override the 3MF source-model filament palette (hex #RRGGBB per 0-based slot) used to colour paint_color facets, instead of the file's own project_settings.config. Niche: for consumers re-rendering a file with a corrected/richer palette. Ignored for STL and pre-built scenes.

    height?: number
    limits?: ModelLimits
    renderScope?: RenderScope

    Render only a subset of a multi-plate / multi-object source (DD-030 D2) — e.g. { plateId: 3 } to render just plate 3 of a project, framed to that plate. Omit to render the whole project (default). { plateId } is meaningful only when the source declares plates (plates: 'known'); on a source without plate structure it matches nothing and renders empty (the honest result).

    view?: "iso"

    Preset angle; default 'iso'.

    width?: number

    Settings

    Member Visibility

    On This Page

    Properties