API Docs for: 1.4.0
Show:

SpriteSheetLoader Class

The sprite sheet loader is used to load in JSON sprite sheet data To generate the data you can use http://www.codeandweb.com/texturepacker and publish the 'JSON' format There is a free version so thats nice, although the paid version is great value for money. It is highly recommended to use Sprite sheets (also know as texture atlas') as it means sprite's can be batched and drawn together for highly increased rendering speed. Once the data has been loaded the frames are stored in the PIXI texture cache and can be accessed though PIXI.Texture.fromFrameId() and PIXI.Sprite.fromFromeId() This loader will also load the image file that the Spritesheet points to as well as the data. When loaded this class will dispatch a 'loaded' event

Constructor

SpriteSheetLoader

(
  • url
  • crossorigin
)

Parameters:

  • url String

    The url of the sprite sheet JSON file

  • crossorigin Boolean

    Whether requests should be treated as crossorigin

Item Index

Methods

load

()

This will begin loading the JSON file

onJSONLoaded

() private

Invoke when JSON file is loaded

onLoaded

() private

Invoke when all files are loaded (json and texture)

Properties

baseUrl

String

[read-only] The base url of the bitmap font data

crossorigin

Boolean

Whether the requests should be treated as cross origin

frames

Object

The frames of the sprite sheet

texture

Texture

The texture being loaded

url

String

The url of the bitmap font data