Constructors
constructor
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:84
Parameters
Optional resolutionFilename: string
Properties
Private _batchIndex
_batchIndex: any
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:83
Private _callback
_callback: any
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:84
Private _frameKeys
_frameKeys: any
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:82
Private _frames
_frames: any
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:81
Private _nextBatch
_nextBatch: any
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:135
Private _parseComplete
_parseComplete: any
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:129
Private _processAnimations
_processAnimations: any
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:123
Private _processFrames
_processFrames: any
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:117
Private _texture
_texture: any
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:80
Private _updateResolution
_updateResolution: any
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:102
animations
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:77
baseTexture
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:75
data
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:78
resolution
resolution: number
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:79
textures
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:76
Static Readonly BATCH_SIZE
BATCH_SIZE: 1000 = 1000
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:74
Methods
destroy
destroy( destroyBase?: boolean ) : void
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:141
Parameters
Optional destroyBase: boolean
Returns void
parse
parse( callback: ( ) => void ) : void
Defined in source/node_modules/@pixi/spritesheet/index.d.ts:110
Parameters
Returns void
Legend
Constructor
Property
Method
Accessor
Inherited constructor
Inherited property
Inherited method
Inherited accessor
Private property
Private method
Static property
Static method
Utility class for maintaining reference to a collection of Textures on a single Spritesheet.
To access a sprite sheet from your code pass its JSON data file to Pixi's loader:
With the
sheet.textures
you can create Sprite objects,sheet.animations
can be used to create an AnimatedSprite.Sprite sheets can be packed using tools like TexturePacker, Shoebox or Spritesheet.js. Default anchor points (see {@link PIXI.Texture#defaultAnchor}) and grouping of animation sprites are currently only supported by TexturePacker.
PIXI