PixiJS

Class: AbstractMultiResource

PIXI.AbstractMultiResource

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

new PIXI.AbstractMultiResource (length, options) overrides

AbstractMultiResource.ts:24
Name Type Attributes Description
length number
options object <optional>

Options to for Resource constructor
options.width number <optional>

Width of the resource
options.height number <optional>

Height of the resource

Extends

Members

baseTexture PIXI.BaseTexture

Bound baseTexture, there can only be one

bind PIXI.BaseTexture overrides

Set the parent base texture

itemDirtyIds Array<number> readonly

Dirty IDs for each part

items Array<PIXI.BaseTexture> readonly

Collection of partial baseTextures that correspond to resources

length number readonly

Number of elements in array

unbind PIXI.BaseTexture overrides

Unset the parent base texture

Methods

addBaseTextureAt (baseTexture, index) PIXI.AbstractMultiResource abstract

AbstractMultiResource.ts:128

Set a baseTexture by ID

Name Type Description
baseTexture PIXI.BaseTexture
index number

Zero-based index of resource to set
Returns:
Type Description
PIXI.AbstractMultiResource Instance for chaining

addResourceAt (resource, index) PIXI.ArrayResource

AbstractMultiResource.ts:137

Set a resource by ID

Name Type Description
resource PIXI.Resource
index number

Zero-based index of resource to set
Returns:
Type Description
PIXI.ArrayResource Instance for chaining

dispose () void overrides

AbstractMultiResource.ts:113

Destroy this BaseImageResource

load () Promise<void> overrides

AbstractMultiResource.ts:198

Load all the resources simultaneously

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

initFromArray (resources, options) void protected

AbstractMultiResource.ts:83

used from ArrayResource and CubeResource constructors

Name Type Attributes Description
resources Array<unknown>

Can be resources, image elements, canvas, etc. , length should be same as constructor length
options object <optional>

detect options for resources

Inherited Properties

From class PIXI.Resource

destroyed boolean readonly inherited

If resource has been destroyed

Default Value:
  • false

height number readonly inherited

The height of the resource.

valid boolean readonly inherited

Has been validated

width number readonly inherited

The width of the resource.

_height number protected inherited

Internal height of the resource

_width number protected inherited

Internal width of the resource

internal boolean protected inherited

true if resource is created by BaseTexture useful for doing cleanup with BaseTexture destroy and not cleaning up resources that were created externally.

Inherited Methods

From class PIXI.Resource

destroy () void inherited

Resource.ts:223

Call when destroying resource, unbind any BaseTexture object before calling this method, as reference counts are maintained internally.

resize (width, height) void inherited

Resource.ts:121

Trigger a resize event

Name Type Description
width number

X dimension
height number

Y dimension

style (renderer, baseTexture, glTexture) boolean inherited

Resource.ts:200

Set the style, optional to override

Name Type Description
renderer PIXI.Renderer

yeah, renderer!
baseTexture PIXI.BaseTexture

the texture
glTexture PIXI.GLTexture

texture instance for this webgl context
Returns:
Type Description
boolean true is success

update () void inherited

Resource.ts:146

Has been updated trigger event

upload (renderer, baseTexture, glTexture) boolean abstract inherited

Resource.ts:190

Uploads the texture or returns false if it cant for some reason. Override this.

Name Type Description
renderer PIXI.Renderer

yeah, renderer!
baseTexture PIXI.BaseTexture

the texture
glTexture PIXI.GLTexture

texture instance for this webgl context
Returns:
Type Description
boolean true is success