Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Sprite

Container for a single sprite image.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

  • new Sprite(width: number, height: number): Sprite

Properties

Protected height

height: number

The image height in pixels.

Protected width

width: number

The image width in pixels.

Methods

draw

  • draw(ctx: CanvasRenderingContext2D, x?: number, y?: number): void

  • Draws the image onto the given rendering context.

    Parameters

    • ctx: CanvasRenderingContext2D

      The rendering context to draw the image to.

    • Default value x: number = 0

      Optional horizontal target position. Defaults to 0.

    • Default value y: number = 0

      Optional vertical target position. Defaults to 0.

    Returns void

getColor

  • getColor(x: number, y: number): number

getHeight

  • getHeight(): number

getWidth

  • getWidth(): number

toCanvas

  • toCanvas(): HTMLCanvasElement

toDataUrl

  • toDataUrl(type?: undefined | string, ...args: any[]): string

  • Creates and returns an image data URL.

    Parameters

    • Optional type: undefined | string

      Optional image mime type. Defaults to image/png.

    • Rest ...args: any[]

      Optional additional encoder parameters. For image/jpeg this is the image quality between 0 and 1 with a default value of 0.92.

    Returns string

    The created data URL.

toImage

  • toImage(type?: undefined | string, ...args: any[]): HTMLImageElement

  • Creates and returns a HTML image.

    Parameters

    • Optional type: undefined | string

      Optional image mime type. Defaults to image/png.

    • Rest ...args: any[]

      Optional additional encoder parameters. For image/jpeg this is the image quality between 0 and 1 with a default value of 0.92.

    Returns HTMLImageElement

    The created HTML image.

Static fromArray

  • fromArray(dataArray: Uint8Array, maskArray: Uint8Array, dataOffset?: number, maskOffset?: number): Sprite

  • Parses a sprite from the given arrays.

    Parameters

    • dataArray: Uint8Array

      The array containing the image data.

    • maskArray: Uint8Array

      The array containing the mask data.

    • Default value dataOffset: number = 0

      Optional data offset. Defaults to 0.

    • Default value maskOffset: number = 0

      Optional mask offset. Defaults to 0.

    Returns Sprite

    The parsed sprite.

Generated using TypeDoc