PIXI.AbstractMultiResource

class AbstractMultiResource extends PIXI.Resource

Resource that can manage several resource (items) inside. All resources need to have the same pixel size. Parent class for CubeResource and ArrayResource

Constructor

new PIXI.AbstractMultiResource(length: number, options: ISize) → {}

Parameters:
Name	Type	Attributes	Description
length	number
options	ISize	<optional>	Options to for Resource constructor
options.width	number	<optional>	Width of the resource
options.height	number	<optional>	Height of the resource

Summary

Properties from AbstractMultiResource

PIXI.BaseTexture	baseTexture Bound baseTexture, there can only be one.
Array<number>	itemDirtyIds
Array<PIXI.BaseTexture>	items
number	length Number of elements in array.

Methods from AbstractMultiResource

this	addBaseTextureAt(baseTexture: PIXI.BaseTexture, index: number)
this	addResourceAt(resource: PIXI.Resource, index: number)
void	bind(baseTexture: PIXI.BaseTexture)
void	dispose() Destroy this BaseImageResource.
Promise<this>	load()
void	unbind(baseTexture: PIXI.BaseTexture)
void	protected initFromArray(resources: Array, options: IAutoDetectOptions)

Properties inherited from Resource

boolean	destroyed = false
number	height
boolean	internal
string	src The url of the resource
boolean	valid
number	width
number	protected _height Internal height of the resource.
number	protected _width Internal width of the resource.

Methods inherited from Resource

void	destroy()
void	resize(width: number, height: number)
boolean	style(_renderer: PIXI.Renderer, _baseTexture: PIXI.BaseTexture, _glTexture: PIXI.GLTexture)
void	update() Has been updated trigger event.
boolean	upload(renderer: PIXI.Renderer, baseTexture: PIXI.BaseTexture, glTexture: PIXI.GLTexture)

Public Properties

baseTexture AbstractMultiResource.ts:36

baseTexture: PIXI.BaseTexture

Bound baseTexture, there can only be one.

itemDirtyIds AbstractMultiResource.ts:24

itemDirtyIds: Array<number>

Dirty IDs for each part.

items AbstractMultiResource.ts:18

items: Array<PIXI.BaseTexture>

Collection of partial baseTextures that correspond to resources.

length AbstractMultiResource.ts:15

length: number

Number of elements in array.

Public Methods

addBaseTextureAt AbstractMultiResource.ts:111

addBaseTextureAt(baseTexture: PIXI.BaseTexture, index: number) → {this}

Set a baseTexture by ID

Parameters:
Name	Type	Description
baseTexture	PIXI.BaseTexture
index	number	Zero-based index of resource to set

Returns:
Type	Description
this	Instance for chaining

addResourceAt AbstractMultiResource.ts:119

addResourceAt(resource: PIXI.Resource, index: number) → {this}

Set a resource by ID

Parameters:
Name	Type	Description
resource	PIXI.Resource
index	number	Zero-based index of resource to set

Returns:
Type	Description
this	Instance for chaining

bind AbstractMultiResource.ts:143

bind(baseTexture: PIXI.BaseTexture) → {void}

Set the parent base texture.

Parameters:
Name	Type	Description
baseTexture	PIXI.BaseTexture

Returns:
Type	Description
void

dispose AbstractMultiResource.ts:99

dispose() → {void}

Destroy this BaseImageResource.

Returns:
Type	Description
void

load AbstractMultiResource.ts:177

load() → {Promise<this>}

Load all the resources simultaneously

Returns:
Type	Description
Promise<this>	When load is resolved

unbind AbstractMultiResource.ts:162

unbind(baseTexture: PIXI.BaseTexture) → {void}

Unset the parent base texture.

Parameters:
Name	Type	Description
baseTexture	PIXI.BaseTexture

Returns:
Type	Description
void

Protected Methods

initFromArray AbstractMultiResource.ts:70

protected initFromArray(resources: Array, options: IAutoDetectOptions) → {void}

Used from ArrayResource and CubeResource constructors.

Parameters:
Name	Type	Attributes	Description
resources	Array<any>		Can be resources, image elements, canvas, etc. , length should be same as constructor length
options	IAutoDetectOptions	<optional>	Detect options for resources

Returns:
Type	Description
void