LUX-VIEW - v1.0.0
    Preparing search index...

    Interface IScreenshotRequest

    Options for taking a screenshot.

    interface IScreenshotRequest {
        dpr?: number;
        fileName?: string;
        size?: { height: number; width: number };
    }
    Index

    Properties

    Properties

    dpr?: number

    Extra multiplier for width and height, on top of the device pixel ratio the viewer already renders at. If not set, no extra multiplier is applied.

    fileName?: string

    The name of the downloaded PNG file. If not set 'screenshot_{CURRENT_DATE_IN_UNIX_TIME}.png' is used.

    size?: { height: number; width: number }

    Set a custom resolution in CSS pixels. If not set the current render canvas size is used. The camera aspect follows the requested size.