glTexSubImage3D - OpenGL 4 Reference Pages

## Name

glTexSubImage3D, glTextureSubImage3D — specify a three-dimensional texture subimage

## C Specification

`void glTexSubImage3D(` | GLenum target,
| GLint level,
| GLint xoffset,
| GLint yoffset,
| GLint zoffset,
| GLsizei width,
| GLsizei height,
| GLsizei depth,
| GLenum format,
| GLenum type,
| const GLvoid * pixels`)`;

`void glTextureSubImage3D(` | GLuint texture,
| GLint level,
| GLint xoffset,
| GLint yoffset,
| GLint zoffset,
| GLsizei width,
| GLsizei height,
| GLsizei depth,
| GLenum format,
| GLenum type,
| const void *pixels`)`;

## Parameters

`target`

  Specifies the target to which the texture is bound for `glTexSubImage3D`. Must be `GL_TEXTURE_3D` or `GL_TEXTURE_2D_ARRAY`.

`texture`

  Specifies the texture object name for `glTextureSubImage3D`. The effective target of `texture` must be one of the valid `target` values above.

`level`

  Specifies the level-of-detail number. Level 0 is the base image level. Level n is the nth mipmap reduction image.

`xoffset`

  Specifies a texel offset in the x direction within the texture array.

`yoffset`

  Specifies a texel offset in the y direction within the texture array.

`zoffset`

  Specifies a texel offset in the z direction within the texture array.

`width`

  Specifies the width of the texture subimage.

`height`

  Specifies the height of the texture subimage.

`depth`

  Specifies the depth of the texture subimage.

`format`

  Specifies the format of the pixel data. The following symbolic values are accepted: `GL_RED`, `GL_RG`, `GL_RGB`, `GL_BGR`, `GL_RGBA`, `GL_DEPTH_COMPONENT`, and `GL_STENCIL_INDEX`.

`type`

  Specifies the data type of the pixel data. The following symbolic values are accepted: `GL_UNSIGNED_BYTE`, `GL_BYTE`, `GL_UNSIGNED_SHORT`, `GL_SHORT`, `GL_UNSIGNED_INT`, `GL_INT`, `GL_FLOAT`, `GL_UNSIGNED_BYTE_3_3_2`, `GL_UNSIGNED_BYTE_2_3_3_REV`, `GL_UNSIGNED_SHORT_5_6_5`, `GL_UNSIGNED_SHORT_5_6_5_REV`, `GL_UNSIGNED_SHORT_4_4_4_4`, `GL_UNSIGNED_SHORT_4_4_4_4_REV`, `GL_UNSIGNED_SHORT_5_5_5_1`, `GL_UNSIGNED_SHORT_1_5_5_5_REV`, `GL_UNSIGNED_INT_8_8_8_8`, `GL_UNSIGNED_INT_8_8_8_8_REV`, `GL_UNSIGNED_INT_10_10_10_2`, and `GL_UNSIGNED_INT_2_10_10_10_REV`.

`pixels`

  Specifies a pointer to the image data in memory.

## Description

Texturing maps a portion of a specified texture image onto each graphical primitive for which texturing is enabled.

`glTexSubImage3D` and `glTextureSubImage3D` redefine a contiguous subregion of an existing three-dimensional or two-dimensioanl array texture image. The texels referenced by `pixels` replace the portion of the existing texture array with x indices `xoffset` and xoffset + width - 1 , inclusive, y indices `yoffset` and yoffset + height - 1 , inclusive, and z indices `zoffset` and zoffset + depth - 1 , inclusive. For three-dimensional textures, the z index refers to the third dimension. For two-dimensional array textures, the z index refers to the slice index. This region may not include any texels outside the range of the texture array as it was originally specified. It is not an error to specify a subtexture with zero width, height, or depth but such a specification has no effect.

If a non-zero named buffer object is bound to the `GL_PIXEL_UNPACK_BUFFER` target (see glBindBuffer) while a texture image is specified, `pixels` is treated as a byte offset into the buffer object's data store.

## Notes

The glPixelStore modes affect texture images.

`glTexSubImage3D` and `glTextureSubImage3D` specify a three-dimensional or two-dimensional array subtexture for the current texture unit, specified with glActiveTexture.

`GL_STENCIL_INDEX` is accepted for `format` only if the GL version is 4.4 or higher.

## Errors

`GL_INVALID_ENUM` is generated if `target` or the effective target of `texture` is not `GL_TEXTURE_3D` or `GL_TEXTURE_2D_ARRAY`.

`GL_INVALID_OPERATION` is generated by `glTextureSubImage3D` if `texture` is not the name of an existing texture object.

`GL_INVALID_ENUM` is generated if `format` is not an accepted format constant.

`GL_INVALID_ENUM` is generated if `type` is not a type constant.

`GL_INVALID_VALUE` is generated if `level` is less than 0.

`GL_INVALID_VALUE` may be generated if `level` is greater than log 2 max, where max is the returned value of `GL_MAX_TEXTURE_SIZE`.

`GL_INVALID_VALUE` is generated if xoffset < - b , xoffset + width > w - b , yoffset < - b , or yoffset + height > h - b , or zoffset < - b , or zoffset + depth > d - b , where w is the `GL_TEXTURE_WIDTH`, h is the `GL_TEXTURE_HEIGHT`, d is the `GL_TEXTURE_DEPTH` and b is the border width of the texture image being modified. Note that w, h, and d include twice the border width.

`GL_INVALID_VALUE` is generated if `width`, `height`, or `depth` is less than 0.

`GL_INVALID_OPERATION` is generated if the texture array has not been defined by a previous glTexImage3D or glTexStorage3D operation.

`GL_INVALID_OPERATION` is generated if `type` is one of `GL_UNSIGNED_BYTE_3_3_2`, `GL_UNSIGNED_BYTE_2_3_3_REV`, `GL_UNSIGNED_SHORT_5_6_5`, or `GL_UNSIGNED_SHORT_5_6_5_REV` and `format` is not `GL_RGB`.

`GL_INVALID_OPERATION` is generated if `type` is one of `GL_UNSIGNED_SHORT_4_4_4_4`, `GL_UNSIGNED_SHORT_4_4_4_4_REV`, `GL_UNSIGNED_SHORT_5_5_5_1`, `GL_UNSIGNED_SHORT_1_5_5_5_REV`, `GL_UNSIGNED_INT_8_8_8_8`, `GL_UNSIGNED_INT_8_8_8_8_REV`, `GL_UNSIGNED_INT_10_10_10_2`, or `GL_UNSIGNED_INT_2_10_10_10_REV` and `format` is neither `GL_RGBA` nor `GL_BGRA`.

`GL_INVALID_OPERATION` is generated if `format` is `GL_STENCIL_INDEX` and the base internal format is not `GL_STENCIL_INDEX`.

`GL_INVALID_OPERATION` is generated if a non-zero buffer object name is bound to the `GL_PIXEL_UNPACK_BUFFER` target and the buffer object's data store is currently mapped.

`GL_INVALID_OPERATION` is generated if a non-zero buffer object name is bound to the `GL_PIXEL_UNPACK_BUFFER` target and the data would be unpacked from the buffer object such that the memory reads required would exceed the data store size.

`GL_INVALID_OPERATION` is generated if a non-zero buffer object name is bound to the `GL_PIXEL_UNPACK_BUFFER` target and `pixels` is not evenly divisible into the number of bytes needed to store in memory a datum indicated by `type`.

## Associated Gets

glGetTexImage

glGet with argument `GL_PIXEL_UNPACK_BUFFER_BINDING`

## Version Support

| OpenGL Version
--- | ---
Function / Feature Name | 2.0 | 2.1 | 3.0 | 3.1 | 3.2 | 3.3 | 4.0 | 4.1 | 4.2 | 4.3 | 4.4 | 4.5
`glTexSubImage3D` | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔
`glTextureSubImage3D` | - | - | - | - | - | - | - | - | - | - | - | ✔

## See Also

glActiveTexture, glCopyTexImage1D, glCopyTexImage2D, glCopyTexSubImage1D, glCopyTexSubImage2D, glCopyTexSubImage3D, glPixelStore, glTexImage1D, glTexImage2D, glTexImage3D, glTexSubImage1D, glTexSubImage2D, glTexParameter

## Copyright

Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2014 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.