API Docs for: 1.4.0
Show:

Kiwi.Textures.SpriteSheet Class

Extends TextureAtlas
Defined in: src\textures\SpriteSheet.ts:10
Module: Textures
Parent Module: Kiwi

A special type of TextureAtlas that is created when loading in images that are design to be SpriteSheets. A SpriteSheet will generally contain multiple cells and can also contain sequences which are then automatically added as Animations when this texture is used on a Sprite.

Constructor

Kiwi.Textures.SpriteSheet

(
  • name
  • texture
  • cellWidth
  • cellHeight
  • [numCells]
  • [rows]
  • [cols]
  • [sheetOffsetX]
  • [sheetOffsetY]
  • [cellOffsetX]
  • [cellOffsetY]
)
SpriteSheet

Defined in src\textures\SpriteSheet.ts:10

Parameters:

  • name String

    The name of the spritesheet.

  • texture HTMLImageElement/HTMLCanvasElement

    The image that is being used for the spritesheet.

  • cellWidth Number

    The width of a single cell.

  • cellHeight Number

    The height of a single cell.

  • [numCells] Number optional

    The number of cells in total.

  • [rows] Number optional

    The number of cells that make up a row.

  • [cols] Number optional

    The number of cells that make up a column.

  • [sheetOffsetX] Number optional

    The offset of the whole sheet on the x axis. Useful if the image has a border you don't want to show.

  • [sheetOffsetY] Number optional

    The offset of the whole sheet on the y axis. Useful if the image has a border you don't want to show.

  • [cellOffsetX] Number optional

    An offset between cells on the x axis. Useful if there is a border between cells which is not to be shown.

  • [cellOffsetY] Number optional

    An offset between cells on the y axis. Useful if there is a border between cells which is not to be shown.

Returns:

SpriteSheet:

Methods

generateAtlasCells

() Array public

Defined in src\textures\SpriteSheet.ts:150

Generates the atlas cells based on the information that was provided.

Returns:

Array:

objType

() String public

Defined in src\textures\SpriteSheet.ts:50

The type of object that this is.

Returns:

String:

"SpriteSheet"

Properties

cellHeight

Number private

Defined in src\textures\SpriteSheet.ts:68

The height of a single cell.

cellOffsetX

Number private

Defined in src\textures\SpriteSheet.ts:134

How much each cell should be offset by on the X axis.

cellOffsetY

Number private

Defined in src\textures\SpriteSheet.ts:142

How much each cell should be offset by on the Y axis.

cellWidth

Number private

Defined in src\textures\SpriteSheet.ts:60

The width of a single cell.

cols

Number private

Defined in src\textures\SpriteSheet.ts:101

The number of columns that are on this spritesheet

numCells

Number private

Defined in src\textures\SpriteSheet.ts:76

The number of cells that are on this spritesheet

rows

Number private

Defined in src\textures\SpriteSheet.ts:84

The number of rows for the spritesheet

sheetOffsetX

Number private

Defined in src\textures\SpriteSheet.ts:118

How much the whole spritesheet should be offset by on the X axis.

sheetOffsetY

Number private

Defined in src\textures\SpriteSheet.ts:126

How much the whole spritesheet should be offset by on the Y axis.