Class: CubeTexture

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CubeTexture.d.ts:72

A cube texture that can be bound to shaders (samplerCube / texture_cube).

This is a lightweight wrapper around a CubeTextureSource.

Examples

Load 6 images and create a cube texture (paths are just examples):

import { Assets, CubeTexture } from 'pixi.js';

await Assets.load([
  'px.png', 'nx.png',
  'py.png', 'ny.png',
  'pz.png', 'nz.png',
]);

// IMPORTANT: string ids must already be in the cache (e.g. after Assets.load)
const cube = CubeTexture.from({
  faces: {
    right: 'px.png',  // +X
    left: 'nx.png',   // -X
    top: 'py.png',    // +Y
    bottom: 'ny.png', // -Y
    front: 'pz.png',  // +Z
    back: 'nz.png',   // -Z
  },
  label: 'skybox',
});

Bind to a shader (resources differ between WebGL and WebGPU, but the cube texture binding stays the same):

const shader = Shader.from({
  gl: { fragment: `uniform samplerCube uCube;` },
  gpu: { fragment: { source: `@group(0) @binding(0) var uCube : texture_cube<f32>;` } },
  resources: {
    uCube: cube.source,
    uSampler: cube.source.style,
  },
});

Advanced

Extends

• EventEmitter<{ destroy: CubeTexture; }>

Implements

• BindableTexture

Constructors

Constructor

> new CubeTexture(options): CubeTexture

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CubeTexture.d.ts:83

Parameters

options

CubeTextureOptions

Returns

CubeTexture

Overrides

EventEmitter.constructor

Properties

destroyed

> destroyed: boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CubeTexture.d.ts:78

Has the texture been destroyed?

label?

> optional label?: string

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CubeTexture.d.ts:82

Optional label for debugging.

source

> readonly source: CubeTextureSource

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CubeTexture.d.ts:80

The underlying cube texture source.

Implementation of

BindableTexture.source

uid

> readonly uid: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CubeTexture.d.ts:76

unique id for this cube texture

prefixed

> static prefixed: string | boolean

Defined in: node_modules/eventemitter3/index.d.ts:9

Inherited from

EventEmitter.prefixed

Methods

addListener()

> addListener<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:45

Type Parameters

T

T extends "destroy"

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

EventEmitter.addListener

destroy()

> destroy(destroySource?): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CubeTexture.d.ts:116

Destroy this CubeTexture.

Parameters

destroySource?

boolean

If true, destroys the underlying CubeTextureSource.

Returns

void

emit()

> emit<T>(event, ...args): boolean

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

Type Parameters

T

T extends "destroy"

Parameters

event

T

args

...ArgumentMap<{ destroy: CubeTexture; }>[Extract<T, "destroy">]

Returns

boolean

Inherited from

EventEmitter.emit

eventNames()

> eventNames(): "destroy"[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered listeners.

Returns

"destroy"[]

Inherited from

EventEmitter.eventNames

listenerCount()

> listenerCount(event): number

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

Parameters

event

"destroy"

Returns

number

Inherited from

EventEmitter.listenerCount

listeners()

> listeners<T>(event): (...args) => void[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

Type Parameters

T

T extends "destroy"

Parameters

event

T

Returns

(...args) => void[]

Inherited from

EventEmitter.listeners

off()

> off<T>(event, fn?, context?, once?): this

Defined in: node_modules/eventemitter3/index.d.ts:69

Type Parameters

T

T extends "destroy"

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.off

on()

> on<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

Type Parameters

T

T extends "destroy"

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

EventEmitter.on

once()

> once<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

Type Parameters

T

T extends "destroy"

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

EventEmitter.once

removeAllListeners()

> removeAllListeners(event?): this

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

Parameters

event?

"destroy"

Returns

this

Inherited from

EventEmitter.removeAllListeners

removeListener()

> removeListener<T>(event, fn?, context?, once?): this

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

Type Parameters

T

T extends "destroy"

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.removeListener

from()

Call Signature

> static from(options, skipCache?): CubeTexture

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CubeTexture.d.ts:89

Convenience factory for creating a cube texture from a CubeTextureSource.

Parameters

options

CubeTextureSource

A cube texture source.

skipCache?

boolean

Unused for this overload.

Returns

CubeTexture

Call Signature

> static from(options, skipCache?): CubeTexture

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/CubeTexture.d.ts:111

Convenience factory for creating a cube texture from 6 face inputs.

Face inputs are converted to Texture via Texture.from. This does not load resources; string ids must already be present in the cache (e.g. after Assets.load).

Parameters

options

CubeTextureFromOptions

Options including the 6 face inputs.

skipCache?

boolean

Skip caching the resulting CubeTexture when all faces are string ids.

Returns

CubeTexture

Example

const cube = CubeTexture.from({
  faces: {
    right: 'px.png',
    left: 'nx.png',
    top: 'py.png',
    bottom: 'ny.png',
    front: 'pz.png',
    back: 'nz.png',
  },
});