W3cubDocs

/Web APIs

WebGL2RenderingContext: compressedTexImage3D() method

Baseline Widely available *

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨September 2021⁩.

* Some parts of this feature may have varying levels of support.

Note: This feature is available in Web Workers.

The compressedTexImage3D() method of the WebGL2RenderingContext interface of the WebGL API specifies a three-dimensional texture image in a compressed format.

Syntax

compressedTexImage3D(target, level, internalformat, width, height, depth, border, imageSize, offset)

compressedTexImage3D(target, level, internalformat, width, height, depth, border, srcData)
compressedTexImage3D(target, level, internalformat, width, height, depth, border, srcData, srcOffset)
compressedTexImage3D(target, level, internalformat, width, height, depth, border, srcData, srcOffset, srcLengthOverride)

Parameters

target

A GLenum specifying the binding point (target) of the active compressed texture. Possible values:

gl.TEXTURE_3D: A three-dimensional texture.
gl.TEXTURE_2D_ARRAY: A two-dimensional array texture.

level

A GLint specifying the level of detail. Level 0 is the base image level and level n is the n-th mipmap reduction level.

internalformat

A GLenum specifying the compressed image format. For a list of possible values, see WebGLRenderingContext.compressedTexImage2D().

width

A GLsizei specifying the width of the texture in texels.

height

A GLsizei specifying the height of the texture in texels.

depth

A GLsizei specifying the depth of the texture/the number of textures in a TEXTURE_2D_ARRAY.

border

A GLint specifying the width of the border. Must be 0.

The texture source can be provided in one of two ways: from an ArrayBuffer (possibly shared) using srcData, srcOffset, and srcLengthOverride; or from gl.PIXEL_UNPACK_BUFFER using imageSize and offset.

srcData: A TypedArray or DataView containing the compressed texture data.
srcOffset Optional: An integer specifying the index of srcData to start reading from. Defaults to 0.
srcLengthOverride Optional: An integer specifying the number of elements in srcData to read. Defaults to srcData.length - srcOffset.
imageSize: A GLsizei specifying the size of the image data in bytes.
offset: A GLintptr specifying the starting address in the buffer bound to gl.PIXEL_UNPACK_BUFFER.

Return value

None (undefined).

Specifications

Specification
WebGL 2.0 Specification> # 3.7.6>

Browser compatibility