Class CubeTexture

Creates a cube texture made up of six images.

Remarks

CubeTexture is almost equivalent in functionality and usage to Texture.
The only differences are that the images are an array of 6 images as opposed to a single image,
and the mapping options are THREE.CubeReflectionMapping (default) or THREE.CubeRefractionMapping

Example

const loader = new THREE.CubeTextureLoader();
loader.setPath('textures/cube/pisa/');
const textureCube = loader.load(['px.png', 'nx.png', 'py.png', 'ny.png', 'pz.png', 'nz.png']);
const material = new THREE.MeshBasicMaterial({
    color: 0xffffff,
    envMap: textureCube
});

See

Hierarchy (view full)

Texture
- CubeTexture

Constructors

constructor

new CubeTexture(images?, mapping?, wrapS?, wrapT?, magFilter?, minFilter?, format?, type?, anisotropy?, colorSpace?): CubeTexture
This creates a new THREE.CubeTexture | CubeTexture object.
Parameters
- Optionalimages: any[]
- Optionalmapping: CubeTextureMapping
  See .mapping. Default THREE.CubeReflectionMapping
- OptionalwrapS: Wrapping
  See .wrapS. Default THREE.ClampToEdgeWrapping
- OptionalwrapT: Wrapping
  See .wrapT. Default THREE.ClampToEdgeWrapping
- OptionalmagFilter: MagnificationTextureFilter
  See .magFilter. Default THREE.LinearFilter
- OptionalminFilter: MinificationTextureFilter
  See .minFilter. Default THREE.LinearMipmapLinearFilter
- Optionalformat: PixelFormat
  See .format. Default THREE.RGBAFormat
- Optionaltype: TextureDataType
  See .type. Default THREE.UnsignedByteType
- Optionalanisotropy: number
  See .anisotropy. Default THREE.Texture.DEFAULT_ANISOTROPY
- OptionalcolorSpace: ColorSpace
  See .colorSpace. Default NoColorSpace
Returns CubeTexture
Overrides Texture.constructor
- Defined in node_modules/@types/three/src/textures/CubeTexture.d.ts:45

Properties

`Static`DEFAULT_ANISOTROPY

DEFAULT_ANISOTROPY: number

The Global default value for .anisotropy.

Default Value

1.

`Static`DEFAULT_IMAGE

DEFAULT_IMAGE: any

The Global default value for .image.

Default Value

null.

`Static`DEFAULT_MAPPING

DEFAULT_MAPPING: Mapping

The Global default value for .mapping.

Default Value

THREE.UVMapping

`Readonly`isCubeTexture

isCubeTexture: true

Read-only flag to check if a given object is of type CubeTexture.

Remarks

This is a constant value

Default Value

true

mapping

mapping: CubeTextureMapping

How the image is applied to the object.

Remarks

All Texture types except THREE.CubeTexture expect the values be THREE.Mapping

See

Texture Constants

Default Value

value of THREE.Texture.DEFAULT_MAPPING

flipY

flipY: boolean

If set to true, the texture is flipped along the vertical axis when uploaded to the GPU.

Remarks

Note that this property has no effect for ImageBitmap.
You need to configure on bitmap creation instead. See THREE.ImageBitmapLoader | ImageBitmapLoader.

See

THREE.ImageBitmapLoader | ImageBitmapLoader.

Default Value

true

`Readonly`isTexture

isTexture: true

Read-only flag to check if a given object is of type Texture.

Remarks

This is a constant value

Default Value

true

`Readonly`id

id: number

Unique number for this Texture instance.

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

uuid

uuid: string

UUID of this object instance.

Remarks

This gets automatically assigned and shouldn't be edited.

name

name: string

Optional name of the object

Remarks

(doesn't need to be unique).

Default Value

""

source

source: Source

The data definition of a texture. A reference to the data source can be shared across textures.
This is often useful in context of spritesheets where multiple textures render the same data
but with different Texture transformations.

mipmaps

mipmaps: any[]

Array of user-specified mipmaps

Default Value

[]

channel

channel: number

Lets you select the uv attribute to map the texture to. 0 for uv, 1 for uv1, 2 for uv2 and 3 for
uv3.

wrapS

wrapS: Wrapping

This defines how the Texture is wrapped horizontally and corresponds to U in UV mapping.

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two
(2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels.
Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js.
WEBGL2 does not have this limitation.

See

Default Value

THREE.ClampToEdgeWrapping

wrapT

wrapT: Wrapping

This defines how the Texture is wrapped vertically and corresponds to V in UV mapping.

Remarks

See

Default Value

THREE.ClampToEdgeWrapping

magFilter

magFilter: MagnificationTextureFilter

How the Texture is sampled when a texel covers more than one pixel.

See

Texture Constants
minFilter
THREE.MagnificationTextureFilter

Default Value

THREE.LinearFilter

minFilter

minFilter: MinificationTextureFilter

How the Texture is sampled when a texel covers less than one pixel.

See

Texture Constants
magFilter
THREE.MinificationTextureFilter

Default Value

THREE.LinearMipmapLinearFilter

anisotropy

anisotropy: number

The number of samples taken along the axis through the pixel that has the highest density of texels.

Remarks

A higher value gives a less blurry result than a basic mipmap, at the cost of more Texture samples being used.

Default

value of THREE.Texture.DEFAULT_ANISOTROPY. That is normally 1.

format

format: AnyPixelFormat

These define how elements of a 2D texture, or texels, are read by shaders.

Remarks

All Texture types except THREE.DepthTexture and THREE.CompressedPixelFormat expect the values be THREE.PixelFormat

See

Texture Constants
THREE.PixelFormat

Default Value

THREE.RGBAFormat.

type

type: TextureDataType

This must correspond to the .format.

Remarks

THREE.UnsignedByteType, is the type most used by Texture formats.

See

Texture Constants
THREE.TextureDataType

Default Value

THREE.UnsignedByteType

internalFormat

internalFormat: null | PixelFormatGPU

The GPU Pixel Format allows the developer to specify how the data is going to be stored on the GPU.

Remarks

Compatible only with WebGL2RenderingContext | WebGL 2 Rendering Context.

See

Texture Constants

Default Value

The default value is obtained using a combination of .format and .type.

matrix

matrix: Matrix3

The uv-transform matrix for the texture.

Remarks

When .matrixAutoUpdate property is true.
Will be updated by the renderer from the properties:

See

.matrixAutoUpdate

Default Value

new THREE.Matrix3()

matrixAutoUpdate

matrixAutoUpdate: boolean

Whether is to update the texture's uv-transform .matrix.

Remarks

Set this to false if you are specifying the uv-transform matrix directly.

See

.matrix

Default Value

true

offset

offset: Vector2

How much a single repetition of the texture is offset from the beginning, in each direction U and V.

Remarks

Typical range is 0.0 to 1.0.

Default Value

new THREE.Vector2(0, 0)

repeat

repeat: Vector2

How many times the texture is repeated across the surface, in each direction U and V.

Remarks

If repeat is set greater than 1 in either direction, the corresponding Wrap parameter should
also be set to THREE.RepeatWrapping or THREE.MirroredRepeatWrapping to achieve the desired tiling effect.

See

wrapS
wrapT

Default Value

new THREE.Vector2( 1, 1 )

center

center: Vector2

The point around which rotation occurs.

Remarks

A value of (0.5, 0.5) corresponds to the center of the texture.

Default Value

new THREE.Vector2( 0, 0 ), lower left.

rotation

rotation: number

How much the texture is rotated around the center point, in radians.

Remarks

Positive values are counter-clockwise.

Default Value

0

generateMipmaps

generateMipmaps: boolean

Whether to generate mipmaps, (if possible) for a texture.

Remarks

Set this to false if you are creating mipmaps manually.

Default Value

true

premultiplyAlpha

premultiplyAlpha: boolean

If set to true, the alpha channel, if present, is multiplied into the color channels when the texture is uploaded to the GPU.

Remarks

Note that this property has no effect for ImageBitmap.
You need to configure on bitmap creation instead. See THREE.ImageBitmapLoader | ImageBitmapLoader.

See

THREE.ImageBitmapLoader | ImageBitmapLoader.

Default Value

false

unpackAlignment

unpackAlignment: number

Specifies the alignment requirements for the start of each pixel row in memory.

Remarks

The allowable values are:

1 (byte-alignment)
2 (rows aligned to even-numbered bytes)
4 (word-alignment)
8 (rows start on double-word boundaries).

See

glPixelStorei for more information.

Default Value

4

colorSpace

colorSpace: ColorSpace

The Textures | {@link Texture constants} page for details of other color spaces.

Remarks

Textures containing color data should be annotated with THREE.SRGBColorSpace or
THREE.LinearSRGBColorSpace.

See

Texture Constants
THREE.TextureDataType

Default Value

THREE.NoColorSpace

isRenderTargetTexture

isRenderTargetTexture: boolean

Indicates whether a texture belongs to a render target or not

Default Value

false

userData

userData: Record<string, any>

An object that can be used to store custom data about the texture.

Remarks

It should not hold references to functions as these will not be cloned.

Default Value

{}

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

Remarks

Expects a Integer

Default Value

0

pmremVersion

pmremVersion: number

Indicates whether this texture should be processed by PMREMGenerator or not (only relevant for render target
textures)

onUpdate

onUpdate: (() => void)

A callback function, called when the texture is updated (e.g., when needsUpdate has been set to true and then the texture is used).

Accessors

image

get image(): any
An image object, typically created using the THREE.CubeTextureLoader.load | CubeTextureLoader.load() method.

Returns any
See
Texture.image
Overrides Texture.image
- Defined in node_modules/@types/three/src/textures/CubeTexture.d.ts:69
set image(data): void
An image object, typically created using the THREE.TextureLoader.load | TextureLoader.load() method.
Parameters
- data: any
Returns void
Remarks
This can be any image (e.g., PNG, JPG, GIF, DDS) or video (e.g., MP4, OGG/OGV) type supported by three.js.
Overrides Texture.image
- Defined in node_modules/@types/three/src/textures/CubeTexture.d.ts:70

images

get images(): any
An image object, typically created using the THREE.CubeTextureLoader.load | CubeTextureLoader.load() method.

Returns any
See
Texture.image
- Defined in node_modules/@types/three/src/textures/CubeTexture.d.ts:76
set images(data): void
Parameters
- data: any
Returns void
- Defined in node_modules/@types/three/src/textures/CubeTexture.d.ts:77

needsUpdate

set needsUpdate(value): void
Set this to true to trigger an update next time the texture is used. Particularly important for setting the wrap mode.
Parameters
- value: boolean
Returns void
Inherited from Texture.needsUpdate
- Defined in node_modules/@types/three/src/textures/Texture.d.ts:365

needsPMREMUpdate

set needsPMREMUpdate(value): void
Indicates whether this texture should be processed by THREE.PMREMGenerator or not.
Parameters
- value: boolean
Returns void
Remarks
Only relevant for render target textures.

Default Value
false
Inherited from Texture.needsPMREMUpdate
- Defined in node_modules/@types/three/src/textures/Texture.d.ts:372

Methods

transformUv

transformUv(uv): Vector2
Transform the UV based on the value of this texture's
.offset,
.repeat,
.wrapS,
.wrapT and
.flipY properties.
Parameters
- uv: Vector2
Returns Vector2
Inherited from Texture.transformUv
- Defined in node_modules/@types/three/src/textures/Texture.d.ts:406

updateMatrix

updateMatrix(): void
Update the texture's UV-transform .matrix from the texture properties
.offset,
.repeat,
.rotation and
.center.

Returns void
Inherited from Texture.updateMatrix
- Defined in node_modules/@types/three/src/textures/Texture.d.ts:415

clone

clone(): this
Make copy of the texture

Returns this
Remarks
Note this is not a "deep copy", the image is shared
Inherited from Texture.clone
- Defined in node_modules/@types/three/src/textures/Texture.d.ts:424

copy

copy(source): this
Parameters
- source: Texture
Returns this
Inherited from Texture.copy
- Defined in node_modules/@types/three/src/textures/Texture.d.ts:426

toJSON

toJSON(meta?): {}
Convert the texture to three.js JSON Object/Scene format.
Parameters
- Optionalmeta: string | {}
  Optional object containing metadata.
Returns {}
Inherited from Texture.toJSON
- Defined in node_modules/@types/three/src/textures/Texture.d.ts:432

dispose

dispose(): void
Frees the GPU-related resources allocated by this instance

Returns void
Remarks
Call this method whenever this instance is no longer used in your app.
Inherited from Texture.dispose
- Defined in node_modules/@types/three/src/textures/Texture.d.ts:438

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, CubeTexture>
  The function that gets called when the event is fired.
Returns void
Inherited from Texture.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:52
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, CubeTexture>
Returns void
Inherited from Texture.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:56

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, CubeTexture>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Texture.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:63
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, CubeTexture>
Returns boolean
Inherited from Texture.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:67

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<{
  dispose: {};
  }[T], T, CubeTexture>
  The listener function that gets removed.
Returns void
Inherited from Texture.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:74
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, CubeTexture>
Returns void
Inherited from Texture.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:78

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends "dispose"
Parameters
- event: BaseEvent<T> & {
  dispose: {};
  }[T]
  The event that gets fired.
Returns void
Inherited from Texture.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:84

Class CubeTexture

Remarks

Example

See

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CubeTexture

Properties

StaticDEFAULT_ANISOTROPY

Default Value

StaticDEFAULT_IMAGE

Default Value

StaticDEFAULT_MAPPING

Default Value

ReadonlyisCubeTexture

Remarks

Default Value

mapping

Remarks

See

Default Value

flipY

Remarks

See

Default Value

ReadonlyisTexture

Remarks

Default Value

Readonlyid

Remarks

uuid

Remarks

name

Remarks

Default Value

source

mipmaps

Default Value

channel

wrapS

Remarks

See

Default Value

wrapT

Remarks

See

Default Value

magFilter

See

Default Value

minFilter

See

Default Value

anisotropy

Remarks

Default

format

Remarks

See

Default Value

type

Remarks

See

Default Value

internalFormat

Remarks

See

Default Value

matrix

Remarks

See

Default Value

matrixAutoUpdate

`Static`DEFAULT_ANISOTROPY

`Static`DEFAULT_IMAGE

`Static`DEFAULT_MAPPING

`Readonly`isCubeTexture

`Readonly`isTexture

`Readonly`id