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

    Type Alias DrawingContextOptions

    Configuration settings for a DrawingContext.

    type DrawingContextOptions = {
        autoClear?: boolean | boolean[];
        blendMode?: number;
        camera?: Cameras.Scene2D.Camera | null;
        clearColor?: number[];
        copyFrom?: DrawingContext;
        height?: number;
        pool?: DrawingContextPool;
        useCanvas?: boolean;
        width?: number;
    }
    Index

    Properties

    autoClear? blendMode? camera? clearColor? copyFrom? height? pool? useCanvas? width?

    Properties

    autoClear?: boolean | boolean[]

    Whether to automatically clear the framebuffer when the context comes into use. If an array, the elements are whether to clear the color, depth, and stencil buffers respectively.

    blendMode?: number

    The blend mode to use when rendering.

    camera?: Cameras.Scene2D.Camera | null

    The camera to use for this context.

    clearColor?: number[]

    The color to clear the framebuffer with. This is an array of 4 values: red, green, blue, alpha.

    copyFrom?: DrawingContext

    The DrawingContext to copy from.

    height?: number

    The height of the framebuffer, used if copyFrom and useCanvas are not set. Default is the renderer height.

    pool?: DrawingContextPool

    The pool to return to when this context is no longer needed. Used only for temporary contexts.

    useCanvas?: boolean

    Whether to use the canvas as the framebuffer.

    width?: number

    The width of the framebuffer, used if copyFrom and useCanvas are not set. Default is the renderer width.

    Settings

    Member Visibility

    On This Page

    Properties