Class: CubeTexture

PIXI.CubeTexture

A Texture that depends on six other resources.

new PIXI.CubeTexture ()

Extends

Members

_batchEnabled number inherited

Number of the texture batch, used by multi-texture renderers

_batchLocation number inherited

Location inside texture batch, used by multi-texture renderers

_id number Deprecated : since 5.2.0 inherited

Batch local field, stores current texture location

See:

How to treat premultiplied alpha, see PIXI.ALPHA_MODES.

Default Value:
  • PIXI.ALPHA_MODES.UNPACK

anisotropicLevel number inherited

Anisotropic filtering level of texture

Default Value:
  • PIXI.settings.ANISOTROPIC_LEVEL

cacheId string inherited

Currently default cache ID.

destroyed boolean readonly inherited

Flag if BaseTexture has been destroyed.

dirtyId number readonly inherited

Used by TextureSystem to only update texture to the GPU when needed. Please call update() to increment it.

dirtyStyleId number protected inherited

Used by TextureSystem to only update texture style when needed.

The pixel format of the texture

Default Value:
  • PIXI.FORMATS.RGBA

hasLoaded boolean Deprecated : since 5.0.0 readonly inherited

See:

height number readonly inherited

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

imageUrl string Deprecated : since 5.0.0 inherited

See:
  • PIXI.resource.ImageResource#url

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 mode of the texture, affects downscaled images

Default Value:
  • PIXI.settings.MIPMAP_TEXTURES

premultiplyAlpha boolean Deprecated : since 5.2.0 readonly inherited

See:

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

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

The scale mode to apply when scaling this texture

Default Value:
  • PIXI.settings.SCALE_MODE

source HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | SVGElement Deprecated : since 5.0.0 readonly inherited

See:

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

touched number protected inherited

Used by automatic texture Garbage Collection, stores last GC tick when it was bound

The type of resource data

Default Value:
  • PIXI.TYPES.UNSIGNED_BYTE

uid string protected inherited

Global unique identifier for this BaseTexture

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)PIXI.CubeTexture static

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.

Returns:
Type Description
PIXI.CubeTexture new cube texture

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

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:

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

Returns:
Type Description
PIXI.ICanvasImageSource Source to render with CanvasRenderer

loadSource () Deprecated : since 5.0.0 inherited

setRealSize (realWidth, realHeight, resolution)PIXI.BaseTexture inherited

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
PIXI.BaseTexture this

setResolution (resolution)PIXI.BaseTexture inherited

Changes resolution

Name Type Description
resolution number optional

res

Returns:
Type Description
PIXI.BaseTexture this

Sets the resource if it wasn't set. Throws error if resource already present

Name Type Description
resource PIXI.resources.Resource

that is managing this BaseTexture

Returns:
Type Description
PIXI.BaseTexture this

setSize (width, height, resolution)PIXI.BaseTexture inherited

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
PIXI.BaseTexture this

setStyle (scaleMode, mipmap)PIXI.BaseTexture inherited

Changes style options of BaseTexture

Name Type Description
scaleMode PIXI.SCALE_MODES optional

Pixi scalemode

mipmap PIXI.MIPMAP_MODES optional

enable mipmaps

Returns:
Type Description
PIXI.BaseTexture this

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

Events

Fired when BaseTexture is destroyed.

Name Type Description
baseTexture PIXI.BaseTexture

Instance of texture being destroyed.

Fired when a not-immediately-available source fails to load.

Name Type Description
baseTexture PIXI.BaseTexture

Resource errored.

event ErrorEvent

Load error event.

Fired when a not-immediately-available source finishes loading.

Name Type Description
baseTexture PIXI.BaseTexture

Resource loaded.

Fired when BaseTexture is updated.

Name Type Description
baseTexture PIXI.BaseTexture

Instance of texture being updated.