Type Alias CanvasHelperOpts

CanvasHelperOpts: {
    clearOnResize: boolean;
    draw?: ((ctx: CanvasRenderingContext2D, size: Rect, helper: CanvasHelper) => void);
    fill: "viewport" | "parent" | "none";
    height: number;
    onResize?: ((ctx: CanvasRenderingContext2D, size: Rect, helper: CanvasHelper) => void);
    scaleBy: ScaleBy;
    skipCss: boolean;
    width: number;
    zIndex: number;
}

Options

Type declaration

  • ReadonlyclearOnResize: boolean

    If true (default) canvas is cleared when a resize happens

  • Optional Readonlydraw?: ((ctx: CanvasRenderingContext2D, size: Rect, helper: CanvasHelper) => void)

    If specified, this function be called in an animation loop.

      • (ctx, size, helper): void

      • Parameters

        Returns void

  • Readonlyfill: "viewport" | "parent" | "none"

    Automatically set canvas to fill. Default: 'none'

    • 'viewport': size of screen
    • 'parent': size of parent element
    • 'none': no resizing. Use 'width' and 'height' options to set the logical size of the canvas
  • Readonlyheight: number

    Logical height of canvas. Ignored if fill is set to 'viewport' or 'parent'

  • Optional ReadonlyonResize?: ((ctx: CanvasRenderingContext2D, size: Rect, helper: CanvasHelper) => void)

    Callback when canvas is resized

      • (ctx, size, helper): void

      • Parameters

        Returns void

  • ReadonlyscaleBy: ScaleBy
  • ReadonlyskipCss: boolean

    If true, it won't add any position CSS

  • Readonlywidth: number

    Logical width of canvas. Ignored if fill is set to 'viewport' or 'parent'

  • ReadonlyzIndex: number

    If set, the z-index for this canvas. By default, fullscreen canvas will be given -1

Settings

Member Visibility