GLAPI/glTexSubImage2D: Difference between revisions
m Renaming category: 'GL 4 API Texturing' to 'Core API Ref Texturing'. |
m Bot: Adding better formatting. |
||
| Line 8: | Line 8: | ||
== Function Definition == | == Function Definition == | ||
void '''glTexSubImage2D'''(GLenum | void '''glTexSubImage2D'''(GLenum {{param|target}}, GLint {{param|level}}, GLint {{param|xoffset}}, GLint {{param|yoffset}}, GLsizei {{param|width}}, GLsizei {{param|height}}, GLenum {{param|format}}, GLenum {{param|type}}, const GLvoid * {{param|data}}); | ||
; target | ; target | ||
| Line 31: | Line 31: | ||
== Description == | == Description == | ||
Texturing maps a portion of a specified texture image onto each graphical primitive for which texturing is enabled. To enable and disable two-dimensional texturing, call | Texturing maps a portion of a specified texture image onto each graphical primitive for which texturing is enabled. To enable and disable two-dimensional texturing, call {{apifunc|glEnable}} and {{apifunc|glDisable}} with argument {{code|GL_TEXTURE_2D}}. | ||
'''glTexSubImage2D''' redefines a contiguous subregion of an existing two-dimensional texture image. The texels referenced by | '''glTexSubImage2D''' redefines a contiguous subregion of an existing two-dimensional texture image. The texels referenced by {{param|data}} replace the portion of the existing texture array with x indices {{param|xoffset}} and ''xoffset'' + ''width'' - 1, inclusive, and y indices {{param|yoffset}} and ''yoffset'' + ''height'' - 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 or height, but such a specification has no effect. | ||
If a non-zero named buffer object is bound to the {{code|GL_PIXEL_UNPACK_BUFFER}} target (see | If a non-zero named buffer object is bound to the {{code|GL_PIXEL_UNPACK_BUFFER}} target (see {{apifunc|glBindBuffer}}) while a texture image is specified, {{param|data}} is treated as a byte offset into the buffer object's data store. | ||
== Notes == | == Notes == | ||
{{apifunc|glPixelStore}} modes affect texture images. | |||
'''glTexSubImage2D''' specifies a two-dimensional subtexture for the current texture unit, specified with | '''glTexSubImage2D''' specifies a two-dimensional subtexture for the current texture unit, specified with {{apifunc|glActiveTexture}}. | ||
== Errors == | == Errors == | ||
{{code|GL_INVALID_ENUM}} is generated if | {{code|GL_INVALID_ENUM}} is generated if {{param|target}} is not {{code|GL_TEXTURE_2D}}, {{code|GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{code|GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{code|GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{code|GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{code|GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, or {{code|GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}. | ||
{{code|GL_INVALID_ENUM}} is generated if | {{code|GL_INVALID_ENUM}} is generated if {{param|format}} is not an accepted format constant. | ||
{{code|GL_INVALID_ENUM}} is generated if | {{code|GL_INVALID_ENUM}} is generated if {{param|type}} is not a type constant. | ||
{{code|GL_INVALID_VALUE}} is generated if | {{code|GL_INVALID_VALUE}} is generated if {{param|level}} is less than 0. | ||
{{code|GL_INVALID_VALUE}} may be generated if | {{code|GL_INVALID_VALUE}} may be generated if {{param|level}} is greater than log<sub>2</sub>(''max''), where ''max'' is the returned value of {{code|GL_MAX_TEXTURE_SIZE}}. | ||
{{code|GL_INVALID_VALUE}} is generated if ''xoffset'' < 0, (''xoffset'' + ''width'') > ''w'', ''yoffset'' < 0, or (''yoffset'' + ''height'') > ''h'', where ''w'' is the {{code|GL_TEXTURE_WIDTH}} and ''h'' is the {{code|GL_TEXTURE_HEIGHT}}. | {{code|GL_INVALID_VALUE}} is generated if ''xoffset'' < 0, (''xoffset'' + ''width'') > ''w'', ''yoffset'' < 0, or (''yoffset'' + ''height'') > ''h'', where ''w'' is the {{code|GL_TEXTURE_WIDTH}} and ''h'' is the {{code|GL_TEXTURE_HEIGHT}}. | ||
{{code|GL_INVALID_VALUE}} is generated if | {{code|GL_INVALID_VALUE}} is generated if {{param|width}} or {{param|height}} is less than 0. | ||
{{code|GL_INVALID_OPERATION}} is generated if the texture array has not been defined by a previous | {{code|GL_INVALID_OPERATION}} is generated if the texture array has not been defined by a previous {{apifunc|glTexImage2D}} operation. | ||
{{code|GL_INVALID_OPERATION}} is generated if | {{code|GL_INVALID_OPERATION}} is generated if {{param|type}} is one of {{code|GL_UNSIGNED_BYTE_3_3_2}}, {{code|GL_UNSIGNED_BYTE_2_3_3_REV}}, {{code|GL_UNSIGNED_SHORT_5_6_5}}, or {{code|GL_UNSIGNED_SHORT_5_6_5_REV}} and {{param|format}} is not {{code|GL_RGB}}. | ||
{{code|GL_INVALID_OPERATION}} is generated if | {{code|GL_INVALID_OPERATION}} is generated if {{param|type}} is one of {{code|GL_UNSIGNED_SHORT_4_4_4_4}}, {{code|GL_UNSIGNED_SHORT_4_4_4_4_REV}}, {{code|GL_UNSIGNED_SHORT_5_5_5_1}}, {{code|GL_UNSIGNED_SHORT_1_5_5_5_REV}}, {{code|GL_UNSIGNED_INT_8_8_8_8}}, {{code|GL_UNSIGNED_INT_8_8_8_8_REV}}, {{code|GL_UNSIGNED_INT_10_10_10_2}}, or {{code|GL_UNSIGNED_INT_2_10_10_10_REV}} and {{param|format}} is neither {{code|GL_RGBA}} nor {{code|GL_BGRA}}. | ||
{{code|GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{code|GL_PIXEL_UNPACK_BUFFER}} target and the buffer object's data store is currently mapped. | {{code|GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{code|GL_PIXEL_UNPACK_BUFFER}} target and the buffer object's data store is currently mapped. | ||
| Line 69: | Line 69: | ||
{{code|GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{code|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. | {{code|GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{code|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. | ||
{{code|GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{code|GL_PIXEL_UNPACK_BUFFER}} target and | {{code|GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{code|GL_PIXEL_UNPACK_BUFFER}} target and {{param|data}} is not evenly divisible into the number of bytes needed to store in memory a datum indicated by {{param|type}}. | ||
== Associated Gets == | == Associated Gets == | ||
{{apifunc|glGetTexImage}} | |||
{{apifunc|glGet}} with argument {{code|GL_PIXEL_UNPACK_BUFFER_BINDING}} | |||
== See Also == | == See Also == | ||
{{apifunc|glActiveTexture}}, {{apifunc|glCopyTexImage1D}}, {{apifunc|glCopyTexImage2D}}, {{apifunc|glCopyTexSubImage1D}}, {{apifunc|glCopyTexSubImage2D}}, {{apifunc|glCopyTexSubImage3D}}, {{apifunc|glPixelStore}}, {{apifunc|glTexImage1D}}, {{apifunc|glTexImage2D}}, {{apifunc|glTexImage3D}}, {{apifunc|glTexSubImage1D}}, {{apifunc|glTexSubImage3D}}, {{apifunc|glTexParameter}} | |||
== Copyright == | == Copyright == | ||
Revision as of 01:26, 29 April 2012
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 1.0 | |
glTexSubImage2D: specify a two-dimensional texture subimage
Function Definition
void glTexSubImage2D(GLenum target, GLint level, GLint xoffset, GLint yoffset, GLsizei width, GLsizei height, GLenum format, GLenum type, const GLvoid * data);
- target
- Specifies the target texture. Must be GL_TEXTURE_2D, GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_NEGATIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_POSITIVE_Z, or GL_TEXTURE_CUBE_MAP_NEGATIVE_Z.
- 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.
- width
- Specifies the width of the texture subimage.
- height
- Specifies the height 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, and GL_BGRA.
- 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.
- data
- 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 two-dimensional texturing, call glEnable and glDisable with argument GL_TEXTURE_2D.
glTexSubImage2D redefines a contiguous subregion of an existing two-dimensional texture image. The texels referenced by data replace the portion of the existing texture array with x indices xoffset and xoffset + width - 1, inclusive, and y indices yoffset and yoffset + height - 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 or height, 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, data is treated as a byte offset into the buffer object's data store.
Notes
glPixelStore modes affect texture images.
glTexSubImage2D specifies a two-dimensional subtexture for the current texture unit, specified with glActiveTexture.
Errors
GL_INVALID_ENUM is generated if target is not GL_TEXTURE_2D, GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_NEGATIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_POSITIVE_Z, or GL_TEXTURE_CUBE_MAP_NEGATIVE_Z.
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 log2(max), where max is the returned value of GL_MAX_TEXTURE_SIZE.
GL_INVALID_VALUE is generated if xoffset < 0, (xoffset + width) > w, yoffset < 0, or (yoffset + height) > h, where w is the GL_TEXTURE_WIDTH and h is the GL_TEXTURE_HEIGHT.
GL_INVALID_VALUE is generated if width or height is less than 0.
GL_INVALID_OPERATION is generated if the texture array has not been defined by a previous glTexImage2D 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 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 data is not evenly divisible into the number of bytes needed to store in memory a datum indicated by type.
Associated Gets
glGet with argument GL_PIXEL_UNPACK_BUFFER_BINDING
See Also
glActiveTexture, glCopyTexImage1D, glCopyTexImage2D, glCopyTexSubImage1D, glCopyTexSubImage2D, glCopyTexSubImage3D, glPixelStore, glTexImage1D, glTexImage2D, glTexImage3D, glTexSubImage1D, glTexSubImage3D, glTexParameter
Copyright
Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.