Difference between revisions of "GLAPI/glCopyTexSubImage2D"

From OpenGL Wiki
Jump to navigation Jump to search
m (Bot: Adjusting API page category.)
 
(11 intermediate revisions by 2 users not shown)
Line 8: Line 8:
 
== Function Definition ==
 
== Function Definition ==
  
   void '''glCopyTexSubImage2D'''(GLenum ''target'', GLint ''level'', GLint ''xoffset'', GLint ''yoffset'', GLint ''x'', GLint ''y'', GLsizei ''width'', GLsizei ''height'');
+
   void '''glCopyTexSubImage2D'''(GLenum {{param|target}}, GLint {{param|level}}, GLint {{param|xoffset}}, GLint {{param|yoffset}}, GLint {{param|x}}, GLint {{param|y}}, GLsizei {{param|width}}, GLsizei {{param|height}});
  
 
; target
 
; target
: Specifies the target texture. Must be {{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}}.
+
: Specifies the target texture. Must be {{enum|GL_TEXTURE_2D}}, {{enum|GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{enum|GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{enum|GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{enum|GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{enum|GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, {{enum|GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}, or {{enum|GL_TEXTURE_1D_ARRAY}}.
 
; level
 
; level
 
: Specifies the level-of-detail number. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image.
 
: Specifies the level-of-detail number. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image.
Line 27: Line 27:
 
== Description ==
 
== Description ==
  
'''glCopyTexSubImage2D''' replaces a rectangular portion of a two-dimensional texture image or cube-map texture image with pixels from the current {{code|GL_READ_BUFFER}} (rather than from main memory, as is the case for [[GLAPI/glTexSubImage2D|glTexSubImage2D]]).
+
'''glCopyTexSubImage2D''' replaces a rectangular portion of a two-dimensional texture image, cube-map texture image or a linear portion of a number of slices of a one-dimensional array texture with pixels from the current {{enum|GL_READ_BUFFER}} (rather than from main memory, as is the case for {{apifunc|glTexSubImage2D}}).
  
The screen-aligned pixel rectangle with lower left corner at (''x'', ''y'') and with width ''width'' and height ''height'' replaces the portion of the texture array with x indices ''xoffset'' through ''xoffset + width - 1'', inclusive, and y indices ''yoffset'' through ''yoffset + height - 1'', inclusive, at the mipmap level specified by ''level''.
+
The screen-aligned pixel rectangle with lower left corner at (''x'', ''y'') and with width {{param|width}} and height {{param|height}} replaces the portion of the texture array with x indices {{param|xoffset}} through ''xoffset + width - 1'', inclusive, and y indices {{param|yoffset}} through ''yoffset + height - 1'', inclusive, at the mipmap level specified by {{param|level}}.
  
The pixels in the rectangle are processed exactly as if [[GLAPI/glReadPixels|glReadPixels]] had been called, but the process stops just before final conversion. At this point, all pixel component values are clamped to the range [0, 1] and then converted to the texture's internal format for storage in the texel array.
+
The pixels in the rectangle are processed exactly as if {{apifunc|glReadPixels}} had been called, but the process stops just before final conversion. At this point, all pixel component values are clamped to the range [0, 1] and then converted to the texture's internal format for storage in the texel array.
  
 
The destination rectangle in the texture array may not include any texels outside 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.
 
The destination rectangle in the texture array may not include any texels outside 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 any of the pixels within the specified rectangle of the current {{code|GL_READ_BUFFER}} are outside the read window associated with the current rendering context, then the values obtained for those pixels are undefined.
+
When {{param|target}} is {{enum|GL_TEXTURE_1D_ARRAY}} then the y coordinate and height are treated as the start slice and number of slices to modify.
  
No change is made to the ''internalformat'', ''width'', ''height'', or ''border'' parameters of the specified texture array or to texel values outside the specified subregion.
+
If any of the pixels within the specified rectangle of the current {{enum|GL_READ_BUFFER}} are outside the read window associated with the current rendering context, then the values obtained for those pixels are undefined.
 +
 
 +
No change is made to the ''internalformat'', ''width'', or ''height'', parameters of the specified texture array or to texel values outside the specified subregion.
  
 
== Notes ==
 
== Notes ==
  
[[GLAPI/glPixelStore|glPixelStore]] modes affect texture images.
+
{{apifunc|glPixelStore}} modes affect texture images.
  
 
== Errors ==
 
== Errors ==
  
{{code|GL_INVALID_ENUM}} is generated if ''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}}.
+
{{enum|GL_INVALID_ENUM}} is generated if {{param|target}} is not {{enum|GL_TEXTURE_2D}}, {{enum|GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{enum|GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{enum|GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{enum|GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{enum|GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, {{enum|GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}, or {{enum|GL_TEXTURE_1D_ARRAY}}.
  
{{code|GL_INVALID_OPERATION}} is generated if the texture array has not been defined by a previous [[GLAPI/glTexImage2D|glTexImage2D]] or [[GLAPI/glCopyTexImage2D|glCopyTexImage2D]] operation.
+
{{enum|GL_INVALID_OPERATION}} is generated if the texture array has not been defined by a previous {{apifunc|glTexImage2D}} or {{apifunc|glCopyTexImage2D}} operation.
  
{{code|GL_INVALID_VALUE}} is generated if ''level'' is less than 0.
+
{{enum|GL_INVALID_VALUE}} is generated if {{param|level}} is less than 0.
  
{{code|GL_INVALID_VALUE}} may be generated if ''level'' is greater than log<sub>2</sub>(max), where ''max'' is the returned value of {{code|GL_MAX_TEXTURE_SIZE}}.
+
{{enum|GL_INVALID_VALUE}} may be generated if ''level'' is greater than log<sub>2</sub>(max), where ''max'' is the returned value of {{enum|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}} of the texture image being modified.
+
{{enum|GL_INVALID_VALUE}} is generated if xoffset < 0, xoffset + width > w, yoffset < 0, or yoffset + height > h, where w is the {{enum|GL_TEXTURE_WIDTH}} and h is the {{enum|GL_TEXTURE_HEIGHT}} of the texture image being modified.
  
 
== Associated Gets ==
 
== Associated Gets ==
  
[[GLAPI/glGetTexImage|glGetTexImage]]
+
{{apifunc|glGetTexImage}}
  
 
== See Also ==
 
== See Also ==
  
[[GLAPI/glCopyTexImage1D|glCopyTexImage1D]], [[GLAPI/glCopyTexImage2D|glCopyTexImage2D]], [[GLAPI/glCopyTexSubImage1D|glCopyTexSubImage1D]], [[GLAPI/glCopyTexSubImage3D|glCopyTexSubImage3D]], [[GLAPI/glPixelStore|glPixelStore]], [[GLAPI/glReadBuffer|glReadBuffer]], [[GLAPI/glTexImage1D|glTexImage1D]], [[GLAPI/glTexImage2D|glTexImage2D]], [[GLAPI/glTexImage3D|glTexImage3D]], [[GLAPI/glTexParameter|glTexParameter]], [[GLAPI/glTexSubImage1D|glTexSubImage1D]], [[GLAPI/glTexSubImage2D|glTexSubImage2D]], [[GLAPI/glTexSubImage3D|glTexSubImage3D]]
+
{{apifunc|glActiveTexture}}, {{apifunc|glBindTexture}}, {{apifunc|glBindFramebuffer}}, {{apifunc|glCopyImageSubData}}, {{apifunc|glCopyTexSubImage1D}}, {{apifunc|glCopyTexSubImage3D}}, {{apifunc|glCopyTexImage2D}}, {{apifunc|glReadBuffer}}
  
 
== Copyright ==
 
== 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/ http://oss.sgi.com/projects/FreeB/].
+
Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2012-2013 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see [https://khronos.org/registry/OpenGL-Refpages/LICENSES/LicenseRef-FreeB.txt LicenseRef-FreeB].
  
[[Category:API Reference 4|CopyTexSubImage2D]]
+
[[Category:Core API Reference|CopyTexSubImage2D]]
[[Category:GL 4 API Texturing|CopyTexSubImage2D]]
+
[[Category:Core API Ref Texturing|CopyTexSubImage2D]]
 +
[[Category:Texture Object API State Functions|CopyTexSubImage2D]]

Latest revision as of 21:35, 5 February 2021

glCopyTexSubImage2D
Core in version 4.6
Core since version 1.0

glCopyTexSubImage2D: copy a two-dimensional texture subimage

Function Definition

 void glCopyTexSubImage2D(GLenum target​, GLint level​, GLint xoffset​, GLint yoffset​, GLint x​, GLint y​, GLsizei width​, GLsizei height​);
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, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z, or GL_TEXTURE_1D_ARRAY.
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.
x, y
Specify the window coordinates of the lower left corner of the rectangular region of pixels to be copied.
width
Specifies the width of the texture subimage.
height
Specifies the height of the texture subimage.

Description

glCopyTexSubImage2D replaces a rectangular portion of a two-dimensional texture image, cube-map texture image or a linear portion of a number of slices of a one-dimensional array texture with pixels from the current GL_READ_BUFFER (rather than from main memory, as is the case for glTexSubImage2D).

The screen-aligned pixel rectangle with lower left corner at (x, y) and with width width​ and height height​ replaces the portion of the texture array with x indices xoffset​ through xoffset + width - 1, inclusive, and y indices yoffset​ through yoffset + height - 1, inclusive, at the mipmap level specified by level​.

The pixels in the rectangle are processed exactly as if glReadPixels had been called, but the process stops just before final conversion. At this point, all pixel component values are clamped to the range [0, 1] and then converted to the texture's internal format for storage in the texel array.

The destination rectangle in the texture array may not include any texels outside 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.

When target​ is GL_TEXTURE_1D_ARRAY then the y coordinate and height are treated as the start slice and number of slices to modify.

If any of the pixels within the specified rectangle of the current GL_READ_BUFFER are outside the read window associated with the current rendering context, then the values obtained for those pixels are undefined.

No change is made to the internalformat, width, or height, parameters of the specified texture array or to texel values outside the specified subregion.

Notes

glPixelStore modes affect texture images.

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, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z, or GL_TEXTURE_1D_ARRAY.

GL_INVALID_OPERATION is generated if the texture array has not been defined by a previous glTexImage2D or glCopyTexImage2D operation.

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 of the texture image being modified.

Associated Gets

glGetTexImage

See Also

glActiveTexture, glBindTexture, glBindFramebuffer, glCopyImageSubData, glCopyTexSubImage1D, glCopyTexSubImage3D, glCopyTexImage2D, glReadBuffer

Copyright

Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2012-2013 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see LicenseRef-FreeB.