Class Cubemap

A cubemap texture.

See

Cubemaps

Hierarchy

Texture<CubemapMip>
- Cubemap

Index

Constructors

constructor

new Cubemap(context, nxFace, pxFace, nyFace, pyFace, nzFace, pzFace, magFilter?, minFilter?, wrapSFunction?, wrapTFunction?): Cubemap
Creates a 2D texture.
Parameters
- context: Context
  
  The WebGL2 rendering context of the texture.
- nxFace: Mipmap<CubemapMip>
  
  The negative X-axis face of the texture.
- pxFace: Mipmap<CubemapMip>
  
  The positive X-axis face of the texture.
- nyFace: Mipmap<CubemapMip>
  
  The negative Y-axis face of the texture.
- pyFace: Mipmap<CubemapMip>
  
  The positive Y-axis face of the texture.
- nzFace: Mipmap<CubemapMip>
  
  The negative Z-axis face of the texture.
- pzFace: Mipmap<CubemapMip>
  
  The positive Z-axis face of the texture.
- magFilter: TextureMagFilter = TextureMagFilter.NEAREST
  
  The magnification filter to use on the texture.
- minFilter: TextureMinFilter = TextureMinFilter.NEAREST
  
  The minification filter to use on the texture.
- wrapSFunction: TextureWrapFunction = TextureWrapFunction.REPEAT
  
  The function to use when wrapping the texture across the S-axis.
- wrapTFunction: TextureWrapFunction = TextureWrapFunction.REPEAT
  
  The function to use when wrapping the texture across the T-axis.
Returns Cubemap
Overrides Texture.constructor
- Defined in src/textures/Cubemap.ts:139

Properties

`Readonly` context

context: Context

The rendering context of this texture.

`Readonly` internal

internal: WebGLTexture

The WebGL texture represented by this object.

`Readonly` target

target: TextureTarget

The binding point of this texture.

Accessors

magFilter

get magFilter(): TextureMagFilter
The magnification filter for this texture.

Returns TextureMagFilter
Inherited from Texture.magFilter
- Defined in src/textures/Texture.ts:158
set magFilter(value): void
The magnification filter for this texture.
Parameters
- value: TextureMagFilter
Returns void
Inherited from Texture.magFilter
- Defined in src/textures/Texture.ts:170

minFilter

get minFilter(): TextureMinFilter
The minification filter for this texture.

Returns TextureMinFilter
Inherited from Texture.minFilter
- Defined in src/textures/Texture.ts:183
set minFilter(value): void
The minification filter for this texture.
Parameters
- value: TextureMinFilter
Returns void
Inherited from Texture.minFilter
- Defined in src/textures/Texture.ts:195

nxFace

get nxFace(): Mipmap<CubemapMip>
The negative X-axis face of this texture.

Returns Mipmap<CubemapMip>
- Defined in src/textures/Cubemap.ts:171
set nxFace(value): void
The negative X-axis face of this texture.
Parameters
- value: Mipmap<CubemapMip>
Returns void
- Defined in src/textures/Cubemap.ts:178

nyFace

get nyFace(): Mipmap<CubemapMip>
The negative Y-axis face of this texture.

Returns Mipmap<CubemapMip>
- Defined in src/textures/Cubemap.ts:195
set nyFace(value): void
The negative Y-axis face of this texture.
Parameters
- value: Mipmap<CubemapMip>
Returns void
- Defined in src/textures/Cubemap.ts:202

nzFace

get nzFace(): Mipmap<CubemapMip>
The negative Z-axis face of this texture.

Returns Mipmap<CubemapMip>
- Defined in src/textures/Cubemap.ts:219
set nzFace(value): void
The negative Z-axis face of this texture.
Parameters
- value: Mipmap<CubemapMip>
Returns void
- Defined in src/textures/Cubemap.ts:226

pxFace

get pxFace(): Mipmap<CubemapMip>
The positive X-axis face of this texture.

Returns Mipmap<CubemapMip>
- Defined in src/textures/Cubemap.ts:183
set pxFace(value): void
The positive X-axis face of this texture.
Parameters
- value: Mipmap<CubemapMip>
Returns void
- Defined in src/textures/Cubemap.ts:190

pyFace

get pyFace(): Mipmap<CubemapMip>
The positive Y-axis face of this texture.

Returns Mipmap<CubemapMip>
- Defined in src/textures/Cubemap.ts:207
set pyFace(value): void
The positive Y-axis face of this texture.
Parameters
- value: Mipmap<CubemapMip>
Returns void
- Defined in src/textures/Cubemap.ts:214

pzFace

get pzFace(): Mipmap<CubemapMip>
The positive Z-axis face of this texture.

Returns Mipmap<CubemapMip>
- Defined in src/textures/Cubemap.ts:231
set pzFace(value): void
The positive Z-axis face of this texture.
Parameters
- value: Mipmap<CubemapMip>
Returns void
- Defined in src/textures/Cubemap.ts:238

wrapSFunction

get wrapSFunction(): TextureWrapFunction
The wrapping function of this texture in the S direction.

Returns TextureWrapFunction
Inherited from Texture.wrapSFunction
- Defined in src/textures/Texture.ts:208
set wrapSFunction(value): void
The wrapping function of this texture in the S direction.
Parameters
- value: TextureWrapFunction
Returns void
Inherited from Texture.wrapSFunction
- Defined in src/textures/Texture.ts:217

wrapTFunction

get wrapTFunction(): TextureWrapFunction
The wrapping function of this texture in the T direction.

Returns TextureWrapFunction
Inherited from Texture.wrapTFunction
- Defined in src/textures/Texture.ts:230
set wrapTFunction(value): void
The wrapping function of this texture in the T direction.
Parameters
- value: TextureWrapFunction
Returns void
Inherited from Texture.wrapTFunction
- Defined in src/textures/Texture.ts:239

Methods

assign

assign(textureUnit): void
Assigns this texture to a texture unit and binds it to its binding point.
Parameters
- textureUnit: number
  
  The texture unit.
Returns void
Inherited from Texture.assign
- Defined in src/textures/Texture.ts:279

bind

bind(): void
Binds this texture to its target binding point.

Returns void
Inherited from Texture.bind
- Defined in src/textures/Texture.ts:252

delete

delete(): void
Deletes this texture.

Returns void
Inherited from Texture.delete
- Defined in src/textures/Texture.ts:332

generateMipmap

generateMipmap(): void
Generates a mipmap for this texture.

Returns void
Inherited from Texture.generateMipmap
- Defined in src/textures/Texture.ts:286

getFace

getFace(target): undefined | Mipmap<CubemapMip>
Gets a face of this texture.
Parameters
- target: MipmapTarget
  
  The target of the face.
Returns undefined | Mipmap<CubemapMip>
The face.
Inherited from Texture.getFace
- Defined in src/textures/Texture.ts:143

setAllNeedsUpdate

setAllNeedsUpdate(): void
Sets all of the faces of this texture as outdated.

Returns void
Inherited from Texture.setAllNeedsUpdate
- Defined in src/textures/Texture.ts:324

setFace

setFace(target, face): void
Sets a face of this texture.
Parameters
- target: MipmapTarget
  
  The target of the face.
- face: Mipmap<CubemapMip>
  
  The face.
Returns void
Inherited from Texture.setFace
- Defined in src/textures/Texture.ts:152

update

update(): boolean
Updates the texels of this texture.

Returns boolean
Whether any updates were performed.
Inherited from Texture.update
- Defined in src/textures/Texture.ts:296

with

with<T>(f): T
Executes the given function with this texture bound, then re-binds the previously-bound texture.
Type Parameters
- T
Parameters
- f: ((texture) => T)
  
  The function to execute.
  - - (texture): T
    - Parameters
      
      texture: Cubemap
      
      Returns T
Returns T
The return value of the executed function.
Inherited from Texture.with
- Defined in src/textures/Texture.ts:263

`Static` fromImageUrls

fromImageUrls(context, px, nx, py, ny, pz, nz): Cubemap
Creates a basic cubemap from image URLs. The cubemap will appear magenta until the images load.
Parameters
- context: Context
  
  The rendering context of the cubemap.
- px: string
  
  The URL of the image on the positive X-axis face.
- nx: string
  
  The URL of the image on the negative X-axis face.
- py: string
  
  The URL of the image on the positive Y-axis face.
- ny: string
  
  The URL of the image on the negative Y-axis face.
- pz: string
  
  The URL of the image on the positive Z-axis face.
- nz: string
  
  The URL of the image on the negative Z-axis face.
Returns Cubemap
A basic 2D texture.
- Defined in src/textures/Cubemap.ts:60

`Static` fromSources

fromSources(context, px, nx, py, ny, pz, nz): Cubemap
Creates a basic cubemap from pixel sources.
Parameters
- context: Context
  
  The rendering context of the cubemap.
- px: MipSource
  
  The pixel source of the positive X-axis face.
- nx: MipSource
  
  The pixel source of the negative X-axis face.
- py: MipSource
  
  The pixel source of the positive Y-axis face.
- ny: MipSource
  
  The pixel source of the negative Y-axis face.
- pz: MipSource
  
  The pixel source of the positive Z-axis face.
- nz: MipSource
  
  The pixel source of the negative Z-axis face.
Returns Cubemap
A basic cubemap.
- Defined in src/textures/Cubemap.ts:28

`Static` unbind

unbind(context, target): void
Unbinds the texture from the given binding point.
Parameters
- context: Context
  
  The rendering context.
- target: TextureTarget
  
  The target.
Returns void
Inherited from Texture.unbind
- Defined in src/textures/Texture.ts:32

Class Cubemap

See

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

context: Context

nxFace: Mipmap<CubemapMip>

pxFace: Mipmap<CubemapMip>

nyFace: Mipmap<CubemapMip>

pyFace: Mipmap<CubemapMip>

nzFace: Mipmap<CubemapMip>

pzFace: Mipmap<CubemapMip>

magFilter: TextureMagFilter = TextureMagFilter.NEAREST

minFilter: TextureMinFilter = TextureMinFilter.NEAREST

wrapSFunction: TextureWrapFunction = TextureWrapFunction.REPEAT

wrapTFunction: TextureWrapFunction = TextureWrapFunction.REPEAT

Returns Cubemap

Properties

Readonly context

Readonly internal

Readonly target

Accessors

magFilter

Returns TextureMagFilter

Parameters

value: TextureMagFilter

Returns void

minFilter

Returns TextureMinFilter

Parameters

value: TextureMinFilter

Returns void

nxFace

Returns Mipmap<CubemapMip>

Parameters

value: Mipmap<CubemapMip>

Returns void

nyFace

Returns Mipmap<CubemapMip>

Parameters

value: Mipmap<CubemapMip>

Returns void

nzFace

Returns Mipmap<CubemapMip>

Parameters

value: Mipmap<CubemapMip>

Returns void

pxFace

Returns Mipmap<CubemapMip>

Parameters

value: Mipmap<CubemapMip>

Returns void

pyFace

Returns Mipmap<CubemapMip>

Parameters

value: Mipmap<CubemapMip>

Returns void

pzFace

Returns Mipmap<CubemapMip>

Parameters

value: Mipmap<CubemapMip>

Returns void

wrapSFunction

Returns TextureWrapFunction

Parameters

value: TextureWrapFunction

Returns void

wrapTFunction

Returns TextureWrapFunction

Parameters

value: TextureWrapFunction

Returns void

Methods

assign

`Readonly` context

`Readonly` internal

`Readonly` target

`Static` fromImageUrls

`Static` fromSources

`Static` unbind