glTexSubImage3D(3G) OpenGL Reference glTexSubImage3D(3G)NAMEglTexSubImage3D - 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 )
PARAMETERS
target Specifies the target texture. Must be GL_TEXTURE_3D.
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_COLOR_INDEX, GL_RED, GL_GREEN, GL_BLUE,
GL_ALPHA, GL_RGB, GL_BGR, GL_RGBA, GL_BGRA, GL_ABGR_EXT,
GL_LUMINANCE, and GL_LUMINANCE_ALPHA.
type Specifies the data type of the pixel data. The following
symbolic values are accepted: GL_UNSIGNED_BYTE, GL_BYTE,
GL_BITMAP, 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,
Page 1
glTexSubImage3D(3G) OpenGL Reference glTexSubImage3D(3G)
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. To enable and disable three-
dimensional texturing, call glEnable and glDisable with argument
GL_TEXTURE_3D.
glTexSubImage3D redefines a contiguous subregion of an existing three-
dimensional 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. 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.
Normally glTexSubImage3D is synchronous: OpenGL executes a
glTexSubImage3D command in the order it is issued in the OpenGL command
stream. Calling glEnable with parameter GL_ASYNC_TEX_IMAGE_SGIX causes
subsequent glTexSubImage3D commands to be asynchronous as defined by the
SGIX_async extension. An asynchronous glTexSubImage3D command samples
the OpenGL state vector at the point in the OpenGL command stream where
the command is issued, but the results of the command (e.g. availability
of texels for use in rasterization) do not happen until some unspecified
time in the future. In particular, the order of the asynchronous command
relative to other OpenGL commands issued later in the command stream is
undefined. An implementation may choose to execute asynchronous commands
in parallel with the normal command stream or at some convenient time in
the future.
Calling glDisable with parameter GL_ASYNC_TEX_IMAGE_SGIX restores the
default synchronous behavior for subsequent glTexSubImage3D commands. It
does not affect any pending asynchronous glTexImage commands, or wait for
their completion.
When an asynchronous glTexSubImage3D command is issued, it is associated
with the current value of GL_ASYNC_MARKER_SGIX as defined by the
SGIX_async extension. A program can determine if an asynchronous
glTexSubImage3D command has completed by using the glFinishAsyncSGIX or
glPollAsyncSGIX commands.
There is a maximum number of asynchronous glTexImage commands that can be
outstanding at any one time, defined by the implementation. This value
can be queried with glGetIntegerv with argument
GL_MAX_ASYNC_TEX_IMAGE_SGIX.
Page 2
glTexSubImage3D(3G) OpenGL Reference glTexSubImage3D(3G)NOTESglTexSubImage3D is available only if the GL version is 1.2 or greater.
Texturing has no effect in color index mode.
glPixelStore and glPixelTransfer modes affect texture images in exactly
the way they affect glDrawPixels.
Formats GL_BGR, and GL_BGRA and types 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 are available only if the GL version is
1.2 or greater.
GL_ABGR_EXT is valid only if the EXT_abgr extension is supported.
When the GL_ARB_imaging extension is supported, the RGBA components
specified in pixels may be processed by the imaging pipeline. See
glTexImage3D for specific details.
ERRORS
GL_INVALID_ENUM is generated if target is not GL_TEXTURE_3D.
GL_INVALID_OPERATION is generated if the texture array has not been
defined by a previous glTexImage3D operation.
GL_INVALID_VALUE is generated if level is less than 0.
GL_INVALID_VALUE may be generated if level is greater than log max, where
2
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_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_ENUM is generated if type is GL_BITMAP and format is not
GL_COLOR_INDEX.
Page 3
glTexSubImage3D(3G) OpenGL Reference glTexSubImage3D(3G)
GL_INVALID_OPERATION is generated if glTexSubImage3D is executed between
the execution of glBegin and the corresponding execution of glEnd.
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 not GL_RGBA, GL_BGRA or GL_ABGR_EXT.
GL_INVALID_OPERATION is generated if GL_ASYNC_TEX_IMAGE_SGIX is enabled
and the number of asynchronous glTexImage commands that have been issued
but not queried (using glFinishAsyncSGIX or glPollAsyncSGIX) exceeds
GL_MAX_ASYNC_TEX_IMAGE_SGIX.
ASSOCIATED GETS
glGetTexImage
glIsEnabled with argument GL_TEXTURE_3D
MACHINE DEPENDENCIES
The SGIX_async and SGIX_async_pixel extensions are implemented only on
Octane2 VPro systems.
SEE ALSO
glCopyTexImage1D, glCopyTexImage2D, glCopyTexSubImage1D,
glCopyTexSubImage2D, glCopyTexSubImage3D, glDrawPixels, glPixelStore,
glPixelTransfer, glTexEnv, glTexGen, glTexImage1D, glTexImage2D,
glTexImage3D, glTexSubImage1D, glTexSubImage2D, glTexParameter,
glAsyncMarkerSGIX, glDeleteAsyncMarkersSGIX, glFinishAsyncSGIX,
glGenAsyncMarkersSGIX, glIsAsyncMarkerSGIX, glPollAsyncSGIX
Page 4
