WebGL2RenderingContext: compressedTexSubImage3D() method

{{APIRef("WebGL")}}{{AvailableInWorkers}}

The compressedTexSubImage3D() method of the {{domxref("WebGL2RenderingContext")}} interface of the WebGL API specifies a three-dimensional sub-rectangle for a texture image in a compressed format.

Compressed image formats are only available via some WebGL extension.

Syntax

compressedTexSubImage3D(target, level, xoffset, yoffset, zoffset, width, height, depth, format, imageSize, offset)

compressedTexSubImage3D(target, level, xoffset, yoffset, zoffset, width, height, depth, format, srcData)
compressedTexSubImage3D(target, level, xoffset, yoffset, zoffset, width, height, depth, format, srcData, srcOffset)
compressedTexSubImage3D(target, level, xoffset, yoffset, zoffset, width, height, depth, format, srcData, srcOffset, srcLengthOverride)

Parameters

• target
  • : A {{domxref("WebGL_API/Types", "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 {{domxref("WebGL_API/Types", "GLint")}} specifying the level of detail. Level 0 is the base image level and level n is the n-th mipmap reduction level.
• xoffset
  • : A {{domxref("WebGL_API/Types", "GLint")}} specifying the x offset within the compressed texture image.
• yoffset
  • : A {{domxref("WebGL_API/Types", "GLint")}} specifying the y offset within the compressed texture image.
• zoffset
  • : A {{domxref("WebGL_API/Types", "GLint")}} specifying the z offset within the compressed texture image.
• width
  • : A {{domxref("WebGL_API/Types", "GLsizei")}} specifying the width of the compressed texture in texels.
• height
  • : A {{domxref("WebGL_API/Types", "GLsizei")}} specifying the height of the compressed texture in texels.
• depth
  • : A {{domxref("WebGL_API/Types", "GLsizei")}} specifying the depth of the texture/the number of textures in a TEXTURE_2D_ARRAY.
• format
  • : A {{domxref("WebGL_API/Types", "GLenum")}} specifying the compressed image format. For a list of possible values, see {{domxref("WebGLRenderingContext.compressedTexImage2D()")}}.

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

• srcData
  • : A {{jsxref("TypedArray")}} or {{jsxref("DataView")}} containing the compressed texture data.
• srcOffset {{optional_inline}}
  • : An integer specifying the index of srcData to start reading from. Defaults to 0.
• srcLengthOverride {{optional_inline}}
  • : An integer specifying the number of elements in srcData to read. Defaults to srcData.length - srcOffset.
• imageSize
  • : A {{domxref("WebGL_API/Types", "GLsizei")}} specifying the size of the image data in bytes.
• offset
  • : A {{domxref("WebGL_API/Types", "GLintptr")}} specifying the starting address in the buffer bound to gl.PIXEL_UNPACK_BUFFER.

Return value

None ({{jsxref("undefined")}}).

Examples

gl.compressedTexSubImage3D(
  gl.TEXTURE_3D,
  0,
  0,
  0,
  512,
  512,
  512,
  gl.COMPRESSED_R11_EAC,
  textureData,
);

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Using WebGL extensions
• {{domxref("WebGLRenderingContext.getExtension()")}}
• {{domxref("WebGLRenderingContext.compressedTexSubImage2D()")}}
• {{domxref("WebGL2RenderingContext.compressedTexImage3D()")}}
• {{domxref("WEBGL_compressed_texture_s3tc")}}
• {{domxref("WEBGL_compressed_texture_s3tc_srgb")}}
• {{domxref("WEBGL_compressed_texture_etc")}}
• {{domxref("WEBGL_compressed_texture_pvrtc")}}
• {{domxref("WEBGL_compressed_texture_astc")}}
• {{domxref("EXT_texture_compression_bptc")}}
• {{domxref("EXT_texture_compression_rgtc")}}