PixiJS

Class: ArrayResource

PIXI.ArrayResource

A resource that contains a number of sources.

Extends

Members

bind PIXI.BaseTexture overrides

Add binding

Methods

addBaseTextureAt (baseTexture, index) PIXI.ArrayResource

ArrayResource.ts:48

Set a baseTexture by ID, ArrayResource just takes resource from it, nothing more

Name Type Description
baseTexture PIXI.BaseTexture
index number

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

upload (renderer, texture, glTexture) boolean overrides

ArrayResource.ts:82

Upload the resources to the GPU.

Name Type Description
renderer PIXI.Renderer
texture PIXI.BaseTexture
glTexture PIXI.GLTexture
Returns:
Type Description
boolean whether texture was uploaded

Inherited Properties

From class PIXI.Resource

destroyed boolean inherited

If resource has been destroyed

Default Value:
  • false

height number inherited

The height of the resource.

valid boolean inherited

Has been validated

width number 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

unbind (baseTexture) void inherited

Resource.ts:109

Unbind to a parent BaseTexture

Name Type Description
baseTexture PIXI.BaseTexture

Parent texture

update () void inherited

Resource.ts:146

Has been updated trigger event

dispose () void protected inherited

Resource.ts:213

Clean up anything, this happens when destroying is ready.

load () Promise protected inherited

Resource.ts:157

This can be overridden to start preloading a resource or do any other prepare step.

Returns:
Type Description
Promise Handle the validate event