Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SpriteSheet

Hierarchy

  • SpriteSheet

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new SpriteSheet(spriteWidth: number, spriteHeight: number, canvasWidth: number, canvasHeight: number, pixelRatio: number): SpriteSheet

  • Parameters

    • spriteWidth: number
    • spriteHeight: number
    • canvasWidth: number
    • canvasHeight: number
    • pixelRatio: number

    Returns SpriteSheet

Properties

Readonly canvas

canvas: HTMLCanvasElement

Readonly freeSprites

freeSprites: Sprite[]

nextSheet

nextSheet: null | SpriteSheet

Readonly renderer

renderer: CanvasRenderer

Readonly spriteHeight

spriteHeight: number

Readonly spriteWidth

spriteWidth: number

Readonly sprites

sprites: readonly Sprite[]

Accessors

canvasHeight

  • get canvasHeight(): number

  • Returns number

canvasWidth

  • get canvasWidth(): number

  • Returns number

colCount

  • get colCount(): number

  • Returns number

freeCount

  • get freeCount(): number

  • Returns number

pixelRatio

  • get pixelRatio(): number

  • Returns number

rowCount

  • get rowCount(): number

  • Returns number

spriteCount

  • get spriteCount(): number

  • Returns number

Methods

acquireSprite

  • acquireSprite(): null | Sprite

  • Returns null | Sprite

clearSprite

  • clearSprite(rowIndex: number, colIndex: number): void

  • Parameters

    • rowIndex: number
    • colIndex: number

    Returns void

Protected createSprite

  • createSprite(rowIndex: number, colIndex: number): Sprite

  • Parameters

    • rowIndex: number
    • colIndex: number

    Returns Sprite

Protected createSprites

  • createSprites(sprites: Sprite[], rowCount: number, colCount: number): void

  • Parameters

    • sprites: Sprite[]
    • rowCount: number
    • colCount: number

    Returns void

drawSprite

  • drawSprite(context: CanvasContext, frame: R2Box, rowIndex: number, colIndex: number): void

  • Parameters

    Returns void

getSpriteRenderer

  • getSpriteRenderer(rowIndex: number, colIndex: number): CanvasRenderer

  • Parameters

    • rowIndex: number
    • colIndex: number

    Returns CanvasRenderer

releaseSprite

  • releaseSprite(sprite: Sprite): void

  • Parameters

    Returns void

Static acquireNextFreeSheet

  • Parameters

    Returns null | SpriteSheet

Generated using TypeDoc