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

    Interface IScreenshots

    This API handles making screenshots of the scene canvas.

    interface IScreenshots {
        shoot(request?: IScreenshotRequest): Promise<Blob>;
    }
    Index

    Methods

    Methods

    • Renders the current scene state again at the requested size, through the same render pipeline as the live view, and captures the result. Only the render canvas is captured. Any UI layers on top will not be part of the screenshot.

      The screenshot will automatically be downloaded.

      The Blob that is returned is the data that has been used to construct the PNG image file that is downloaded.

      Parameters

      Returns Promise<Blob>