WebGL2RenderingContext: texSubImage3D() 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 inWeb Workers.
ThetexSubImage3D() method of theWebGL2RenderingContext interface of theWebGL API specifies a three-dimensional sub-rectangle for a texture image.
Syntax
texSubImage3D(target, level, xoffset, yoffset, zoffset, width, height, depth, format, type, srcData)texSubImage3D(target, level, xoffset, yoffset, zoffset, width, height, depth, format, type, srcData, srcOffset)texSubImage3D(target, level, xoffset, yoffset, zoffset, width, height, depth, format, type, source)texSubImage3D(target, level, xoffset, yoffset, zoffset, width, height, depth, format, type, offset)Parameters
targetA
GLenumspecifying the binding point (target) of the active texture. Possible values:gl.TEXTURE_3D: A three-dimensional texture.gl.TEXTURE_2D_ARRAY: A two-dimensional array texture.
levelA
GLintspecifying the level of detail. Level 0 is the base image level and leveln is the n-th mipmap reduction level.xoffsetA
GLintspecifying the x offset within the texture image.yoffsetA
GLintspecifying the y offset within the texture image.zoffsetA
GLintspecifying the z offset within the texture image.widthA
GLsizeispecifying the width of the texture in texels.heightA
GLsizeispecifying the height of the texture in texels.depthA
GLsizeispecifying the depth of the texture/the number of textures in aTEXTURE_2D_ARRAY.formatA
GLenumspecifying how each integer element in the raw texel data should be interpreted as color components.typeA
GLenumspecifying the size of each integer element in the raw texel data. For the combinations offormatandtypeavailable, seeWebGLRenderingContext.texSubImage2D().
The texture source can be provided in one of three ways: from anArrayBuffer (possibly shared) usingsrcData andsrcOffset; from a DOM pixelsource; or fromgl.PIXEL_UNPACK_BUFFER usingoffset.
srcDataA
TypedArrayorDataViewcontaining the compressed texture data. Its type must match thetypeparameter; seeWebGLRenderingContext.texImage2D().srcOffsetOptionalAn integer specifying the index of
srcDatato start reading from. Defaults to0.sourceRead from a DOM pixel source, which can be one of:
offsetA
GLintptrspecifying the starting address in the buffer bound togl.PIXEL_UNPACK_BUFFER.
Return value
None (undefined).
Examples
gl.texSubImage3D( gl.TEXTURE_3D, 0, 0, 0, 0, image.width, image.height, 1, gl.RGBA, gl.UNSIGNED_BYTE, image,);Specifications
| Specification |
|---|
| WebGL 2.0 Specification # 3.7.6 |