ThreePipe
    Preparing search index...

    Interface CanvasSnapshotPluginOptions

    interface CanvasSnapshotPluginOptions {
        cloneCanvas?: boolean;
        displayPixelRatio?: number;
        getDataUrl?: boolean;
        mimeType?: string;
        progressiveFrames?: number;
        quality?: number;
        rect?: CanvasSnapshotRect;
        scale?: number;
        tileColumns?: number;
        tileRows?: number;
        timeout?: number;
        waitForProgressive?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cloneCanvas? displayPixelRatio? getDataUrl? mimeType? progressiveFrames? quality? rect? scale? tileColumns? tileRows? timeout? waitForProgressive?

    Properties

    cloneCanvas?: boolean
    displayPixelRatio?: number
    getDataUrl?: boolean
    mimeType?: string
    progressiveFrames?: number

    Number of progressive frames to wait for before taking snapshot

    64 or ProgressivePlugin.maxFrameCount, whichever is higher

    quality?: number
    rect?: CanvasSnapshotRect

    Crop Region to take snapshot. If not set, the whole canvas is used.

    scale?: number
    tileColumns?: number

    Number of tile columns to split the image into

    tileRows?: number

    Number of tile rows to split the image into

    1
    timeout?: number

    Time in ms to wait before taking the snapshot. This timeout is applied before waitForProgressive if both are specified.

    waitForProgressive?: boolean

    If true, will wait for progressive rendering(requires ProgressivePlugin) to finish before taking snapshot

    true

    Settings

    Member Visibility

    On This Page

    Properties