luma.gl

TextureCube

A texture cube holds six textures that represent faces of the cube. A main feature of TextureCubes are that they can be passed to shaders and sampled with a direction vector (looking out from the center of the cube) rather than a normal set of texture coordinates, see Usage below.

TextureCubes are typically used to store environment maps. As an example, by rendering an environment into a texture cube, reflections in objects can then be rendered efficiently.

Most texture related functionality is implemented by and documented on the Texture base class. For additional information, see OpenGL Wiki.

Usage

Creating a TextureCube

const textureCube = new TextureCube(gl, {width, height, dataFormat, pixels: {
  [GL.TEXTURE_CUBE_MAP_POSITIVE_X]: imagePosX,
  [GL.TEXTURE_CUBE_MAP_POSITIVE_Y]: imagePosY,
  [GL.TEXTURE_CUBE_MAP_POSITIVE_Z]: imagePosZ,
  [GL.TEXTURE_CUBE_MAP_NEGATIVE_X]: imageNegX,
  [GL.TEXTURE_CUBE_MAP_NEGATIVE_Y]: imageNegY,
  [GL.TEXTURE_CUBE_MAP_NEGATIVE_Z]: imageNegZ
}});

Creating a TextureCube using multiple level-of-detail (LODs) images.

const textureCube = new TextureCube(gl, {width, height, dataFormat, pixels: {
  [GL.TEXTURE_CUBE_MAP_POSITIVE_X]: [imagePosX_LOD_0, imagePosX_LOD_1, imagePosX_LOD_2],
  [GL.TEXTURE_CUBE_MAP_POSITIVE_Y]: [imagePosY_LOD_0, imagePosY_LOD_1, imagePosY_LOD_2],
  [GL.TEXTURE_CUBE_MAP_POSITIVE_Z]: [imagePosZ_LOD_0, imagePosZ_LOD_1, imagePosZ_LOD_2],
  [GL.TEXTURE_CUBE_MAP_NEGATIVE_X]: [imageNegX_LOD_0, imageNegX_LOD_1, imageNegX_LOD_2],
  [GL.TEXTURE_CUBE_MAP_NEGATIVE_Y]: [imageNegY_LOD_0, imageNegY_LOD_1, imageNegY_LOD_2],
  [GL.TEXTURE_CUBE_MAP_NEGATIVE_Z]: [imageNegZ_LOD_0, imageNegZ_LOD_1, imageNegZ_LOD_2]
}});

This class supports Async Textures. You can provide promises (that resolve to images) instead of images. For example [GL.TEXTURE_CUBE_MAP_POSITIVE_X]: [promisePosX_LOD_0, promisePosX_LOD_1, promisePosX_LOD_2].

Replacing one or more faces texture data

textureCube.setCubeMapImageData({width, height, dataFormat, pixels: {
  [GL.TEXTURE_CUBE_MAP_POSITIVE_X]: imagePosX,
  [GL.TEXTURE_CUBE_MAP_NEGATIVE_Y]: imageNegY
}});

Passing a TextureCube to a draw call…

Program.draw({
  uniforms: {
    cubemap: new TextureCube(gl, {...}),
    textureDir: [1, 1, 1]
  }
});

…and accessing it in the shader

// GLSL
uniform samplerCube cubemap;
uniform vec3 textureDir;

void main()
{
    vec4 color = texture(cubemap, textureDir);
}

Members

• handle - the underlying WebGLTexture
• target - Always GL.TEXTURE_CUBE
• depth - Always 6
• width - width of the face textures
• height - height of the face textures
• format - format

Methods

TextureCube constructor

new Texture3D(gl, {
  [GL.TEXTURE_CUBE_MAP_POSITIVE_X]: faceSpecificationPosX,
  [GL.TEXTURE_CUBE_MAP_POSITIVE_Y]: faceSpecificationPosY,
  [GL.TEXTURE_CUBE_MAP_POSITIVE_Z]: faceSpecificationPosZ,
  [GL.TEXTURE_CUBE_MAP_NEGATIVE_X]: faceSpecificationNegX,
  [GL.TEXTURE_CUBE_MAP_NEGATIVE_Y]: faceSpecificationNegY,
  [GL.TEXTURE_CUBE_MAP_NEGATIVE_Z]: faceSpecificationNegZ,
  parameters
});

faceSpecification can be:

• A single image.
• A single promise resolving in an image.
• An array of images (for multiple levels of detail).
• An array of promises each resolving in an image (for multiple levels of detail).

For every level of detail:

• Needs to supply 6 images all of same size and format.
• Images all need to be of the same square size, i.e. width and height must be the same.
• The same format, type etc parameters will be applied to each cube face.

Limits

• GL.MAX_CUBE_MAP_TEXTURE_SIZE

This site is open source. Improve this page.