Interface ScreenshotOptions

Options for LuxarApp.screenshot().

interface ScreenshotOptions {
    format?: "png" | "webp" | "jpeg";
    quality?: number;
    includeOverlays?: boolean;
}

Properties

format?: "png" | "webp" | "jpeg"

Output image format. Defaults to 'png'.

quality?: number

Quality 0–1 for lossy formats (jpeg/webp); ignored for PNG.

includeOverlays?: boolean

Composite visible DOM overlays onto the frame. Defaults to true.