PixiJS API Documentation

Class: CubeResource

PIXI .resources.CubeResource

Resource for a CubeTexture which contains six resources.

new PIXI.resources.CubeResource (source, options)

CubeResource.js:18

Name Type Description

source

Array.<(string|PIXI.resource.Resource)>

optional

Collection of URLs or resoures to use as the sides of the cube.

options

object

optional

ImageResource options

Name	Type	Description
`width`	number	optional Width of resource
`height`	number	optional Height of resource

Extends

PIXI.resources.ArrayResource

Members

PIXI.resources.CubeResource.SIDES number static

Number of texture sides to store for CubeResources

Default Value:

_height number protected inherited

Internal height of the resource

_width number protected inherited

Internal width of the resource

destroyed boolean readonly inherited

If resource has been destroyed

Default Value:

false

height number readonly inherited

The height of the resource.

itemDirtyIds Array.<number> readonly inherited

Dirty IDs for each part

items Array.<PIXI.BaseTexture> readonly inherited

Collection of resources.

length number readonly inherited

Number of elements in array

onResize Runner inherited

Mini-runner for handling resize events

onUpdate Runner inherited

Mini-runner for handling update events

valid boolean readonly inherited

Has been validated

width number readonly inherited

The width of the resource.

Methods

addResourceAt (resource, index)PIXI.resources.ArrayResource inherited ArrayResource.js:106

Set a resource by ID

Name	Type	Description
`resource`	PIXI.resources.Resource
`index`	number	Zero-based index of resource to set

Returns:

Type	Description
PIXI.resources.ArrayResource	Instance for chaining

bind (baseTexture) inherited overrides Resource.js:71

Bind to a parent BaseTexture

Name	Type	Description
`baseTexture`	PIXI.BaseTexture	Parent texture

destroy () inherited Resource.js:203

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

dispose () protected inherited Resource.js:193

Clean up anything, this happens when destroying is ready.

load ()Promise protected inherited Resource.js:135

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

Returns:

Type	Description
Promise	Handle the validate event

resize () inherited Resource.js:98

Trigger a resize event

style (renderer, baseTexture, glTexture)boolean inherited Resource.js:183

Set the style, optional to override

Name	Type	Description
`renderer`	PIXI.Renderer	yeah, renderer!
`baseTexture`	PIXI.BaseTexture	the texture
`glTexture`	PIXI.glCore.Texture	texture instance for this webgl context

Returns:

Type	Description
boolean	`true` is success

unbind (baseTexture) inherited Resource.js:89

Unbind to a parent BaseTexture

Name	Type	Description
`baseTexture`	PIXI.BaseTexture	Parent texture

update () inherited Resource.js:121

Has been updated trigger event

upload () overrides CubeResource.js:45

Uploade the resource