PixiJS

Class: Spritesheet

PIXI.Spritesheet

Utility class for maintaining reference to a collection of Textures on a single Spritesheet.

new PIXI.Spritesheet (baseTexture, data, resolutionFilename)

Spritesheet.js:13
Name Type Default Description
baseTexture PIXI.BaseTexture

Reference to the source BaseTexture object.
data Object

Spritesheet image data.
resolutionFilename string null optional

The filename to consider when determining the resolution of the spritesheet. If not provided, the imageUrl will be used on the BaseTexture.

Members

PIXI.Spritesheet.BATCH_SIZE number static

The maximum number of Textures to build per process.

Default Value:
  • 1000

Methods

destroy (destroyBase)

Spritesheet.js:265

Destroy Spritesheet and don't use after this.

Name Type Default Description
destroyBase boolean false optional

Whether to destroy the base texture as well

parse (callback)

Spritesheet.js:130

Parser spritesheet from loaded data. This is done asynchronously to prevent creating too many Texture within a single process.

Name Type Description
callback function

Callback when complete returns a map of the Textures for this spritesheet.