simgadget
    Preparing search index...

    Interface ScreenshotOptions

    interface ScreenshotOptions {
        format?: "png" | "jpeg" | "tiff" | "bmp" | "gif";
        quality?: number;
        resizeTo?: "points" | { width: number; height: number };
        display?: "internal" | "external";
        mask?: "ignored" | "alpha" | "black";
        path?: string;
    }
    Index
    format? quality? resizeTo? display? mask? path?
    format?: "png" | "jpeg" | "tiff" | "bmp" | "gif"
    quality?: number

    JPEG quality 1–100, default 80. Ignored for other formats.

    resizeTo?: "points" | { width: number; height: number }

    Resize before returning. "points" = the screen's logical point dimensions (what an agent's coordinates live in). Default: no resize, native pixels.

    display?: "internal" | "external"
    mask?: "ignored" | "alpha" | "black"
    path?: string

    Also write the final image here (absolute path).

    Settings
    Member Visibility

    On This Page
    Properties