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 in Web Workers.
The texSubImage3D() method of the WebGL2RenderingContext interface of the WebGL 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
target-
A
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.
level-
A
GLintspecifying the level of detail. Level 0 is the base image level and level n is the n-th mipmap reduction level. xoffset-
A
GLintspecifying the x offset within the texture image. yoffset-
A
GLintspecifying the y offset within the texture image. zoffset-
A
GLintspecifying the z offset within the texture image. width-
A
GLsizeispecifying the width of the texture in texels. height-
A
GLsizeispecifying the height of the texture in texels. depth-
A
GLsizeispecifying the depth of the texture/the number of textures in aTEXTURE_2D_ARRAY. format-
A
GLenumspecifying how each integer element in the raw texel data should be interpreted as color components. type-
A
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 an ArrayBuffer (possibly shared) using srcData and srcOffset; from a DOM pixel source; or from gl.PIXEL_UNPACK_BUFFER using offset.
srcData-
A
TypedArrayorDataViewcontaining the compressed texture data. Its type must match thetypeparameter; seeWebGLRenderingContext.texImage2D(). srcOffsetOptional-
An integer specifying the index of
srcDatato start reading from. Defaults to0. source-
Read from a DOM pixel source, which can be one of:
offset-
A
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 |
Browser compatibility
Loading…
See also
WebGLRenderingContext.createTexture()WebGLRenderingContext.bindTexture()WebGL2RenderingContext.texImage3D()WebGL2RenderingContext.compressedTexImage3D()WebGL2RenderingContext.copyTexSubImage3D()WebGLRenderingContext.getTexParameter()OES_texture_floatOES_texture_half_floatEXT_sRGBEXT_texture_norm16