Class: CubeTexture

Extends

• PIXI.BaseTexture

Members

cacheId string inherited

Currently default cache ID.

destroyed boolean readonly inherited

Flag if BaseTexture has been destroyed.

format PIXI.FORMATS inherited

The pixel format of the texture

Default Value:

• PIXI.FORMATS.RGBA

height number readonly inherited

The height of the base texture set when the image has loaded

isPowerOfTwo boolean readonly inherited

Whether or not the texture is a power of two, try to use power of two textures as much as you can

Default Value:

• false

mipmap boolean inherited

If mipmapping was used for this texture, enable and disable with enableMipmap()

premultiplyAlpha boolean inherited

Set to true to enable pre-multiplied alpha

Default Value:

• true

realHeight number readonly inherited

Pixel height of the source of this texture

realWidth number readonly inherited

Pixel width of the source of this texture

resolution number inherited

The resolution / device pixel ratio of the texture

Default Value:

• PIXI.settings.RESOLUTION

resource PIXI.resources.Resource readonly inherited

The resource used by this BaseTexture, there can only be one resource per BaseTexture, but textures can share resources.

scaleMode number inherited

The scale mode to apply when scaling this texture

Default Value:

• PIXI.settings.SCALE_MODE

See:

• PIXI.SCALE_MODES

target PIXI.TARGETS inherited

The target type

Default Value:

• PIXI.TARGETS.TEXTURE_2D

textureCacheIds Array.<string> readonly inherited

The collection of alternative cache ids, since some BaseTextures can have more than one ID, short name and longer full URL

type PIXI.TYPES inherited

The type of resource data

Default Value:

• PIXI.TYPES.UNSIGNED_BYTE

valid boolean readonly inherited

Generally speaking means when resource is loaded.

width number readonly inherited

The width of the base texture set when the image has loaded

wrapMode number inherited

How the texture wraps

Methods

PIXI.CubeTexture.from (resources, options) static

CubeTexture.js:23

Generate a new CubeTexture.

Name	Type	Description
resources	Array.<string> | Array.<PIXI.resources.Resource>	Collection of 6 URLs or resources
options	object	optional Optional options passed to the resources being loaded. See {@PIXI.resources.autoDetectResource autoDetectResource} for more info on the options available to each resource.

destroy () inherited

BaseTexture.js:465

Destroys this base texture. The method stops if resource doesn't want this texture to be destroyed. Removes texture from all caches.

dispose () inherited

BaseTexture.js:503

Frees the texture from WebGL memory without destroying this texture object. This means you can still use the texture later which will upload it to GPU memory again.

Fires:

• PIXI.BaseTexture#event:dispose

getDrawableSource ()CanvasImageSource inherited

BaseTexture.js:3

Get the drawable source, such as HTMLCanvasElement or HTMLImageElement suitable for rendering with CanvasRenderer. Provided by @pixi/canvas-renderer package.

Returns:

Type	Description
CanvasImageSource	Source to render with CanvasRenderer

setRealSize (realWidth, realHeight, resolution)BaseTexture inherited

BaseTexture.js:363

Sets real size of baseTexture, preserves current resolution.

Name	Type	Description
realWidth	number	Full rendered width
realHeight	number	Full rendered height
resolution	number	optional Optionally set resolution

Returns:

Type	Description
BaseTexture	this

setResolution (resolution)BaseTexture inherited

BaseTexture.js:390

Changes resolution

Name	Type	Description
resolution	number	optional res

Returns:

Type	Description
BaseTexture	this

setResource (resource)BaseTexture inherited

BaseTexture.js:419

Sets the resource if it wasnt set. Throws error if resource already present

Name	Type	Description
resource	PIXI.resources.Resource	that is managing this BaseTexture

Returns:

Type	Description
BaseTexture	this

setSize (width, height, resolution)BaseTexture inherited

BaseTexture.js:344

Changes w/h/resolution. Texture becomes valid if width and height are greater than zero.

Name	Type	Description
width	number	Visual width
height	number	Visual height
resolution	number	optional Optionally set resolution

Returns:

Type	Description
BaseTexture	this

setStyle (options, scaleMode, mipmap)BaseTexture inherited

BaseTexture.js:312

Changes style options of BaseTexture

Name	Type	Description
options	object
scaleMode	PIXI.SCALE_MODES	optional pixi scalemode
mipmap	boolean	optional enable mipmaps

Returns:

Type	Description
BaseTexture	this

update () inherited

BaseTexture.js:441

Invalidates the object. Texture becomes valid if width and height are greater than zero.