phaser - v4.0.0-rc.4
    Preparing search index...

    Type Alias SnapshotState

    type SnapshotState = {
        bufferHeight?: number;
        bufferWidth?: number;
        callback: SnapshotCallback;
        encoderOptions?: number;
        getPixel?: boolean;
        height?: number;
        isFramebuffer?: boolean;
        type?: string;
        unpremultiplyAlpha?: boolean;
        width?: number;
        x?: number;
        y?: number;
    }
    Index

    Properties

    bufferHeight? bufferWidth? callback encoderOptions? getPixel? height? isFramebuffer? type? unpremultiplyAlpha? width? x? y?

    Properties

    bufferHeight?: number

    The height of the frame buffer, if a frame buffer grab.

    bufferWidth?: number

    The width of the frame buffer, if a frame buffer grab.

    callback: SnapshotCallback

    The function to call after the snapshot is taken.

    encoderOptions?: number

    The image quality, between 0 and 1. Used for image formats with lossy compression, such as image/jpeg.

    getPixel?: boolean

    Is this a snapshot to get a single pixel, or an area?

    height?: number

    The height of the snapshot.

    isFramebuffer?: boolean

    Is this snapshot grabbing from a frame buffer or a canvas?

    type?: string

    The format of the image to create, usually image/png or image/jpeg.

    unpremultiplyAlpha?: boolean

    Should the snapshot be unpremultiplied before being returned? WebGL only.

    width?: number

    The width of the snapshot.

    x?: number

    The x coordinate to start the snapshot from.

    y?: number

    The y coordinate to start the snapshot from.

    Settings

    Member Visibility

    On This Page

    Properties