GLAPI/glCopyTexImage2D: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
← Older edit
m Bot: Adjusting API page category.
 
(8 intermediate revisions by 2 users not shown)
Line 8: Line 8:
== Function Definition ==
== Function Definition ==


   void '''glCopyTexImage2D'''(GLenum ''target'', GLint ''level'', GLenum ''internalformat'', GLint ''x'', GLint ''y'', GLsizei ''width'', GLsizei ''height'', GLint ''border'');
   void '''glCopyTexImage2D'''(GLenum {{param|target}}, GLint {{param|level}}, GLenum {{param|internalformat}}, GLint {{param|x}}, GLint {{param|y}}, GLsizei {{param|width}}, GLsizei {{param|height}}, GLint {{param|border}});


; 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}}, or {{enum|GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}.
; 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.
; internalformat
; internalformat
: Specifies the internal format of the texture. Must be one of the following symbolic constants: {{code|GL_COMPRESSED_RED}}, {{code|GL_COMPRESSED_RG}}, {{code|GL_COMPRESSED_RGB}}, {{code|GL_COMPRESSED_RGBA}}. {{code|GL_COMPRESSED_SRGB}}, {{code|GL_COMPRESSED_SRGB_ALPHA}}. {{code|GL_DEPTH_COMPONENT}}, {{code|GL_DEPTH_COMPONENT16}}, {{code|GL_DEPTH_COMPONENT24}}, {{code|GL_DEPTH_COMPONENT32}}, {{code|GL_RED}}, {{code|GL_RG}}, {{code|GL_RGB}}, {{code|GL_R3_G3_B2}}, {{code|GL_RGB4}}, {{code|GL_RGB5}}, {{code|GL_RGB8}}, {{code|GL_RGB10}}, {{code|GL_RGB12}}, {{code|GL_RGB16}}, {{code|GL_RGBA}}, {{code|GL_RGBA2}}, {{code|GL_RGBA4}}, {{code|GL_RGB5_A1}}, {{code|GL_RGBA8}}, {{code|GL_RGB10_A2}}, {{code|GL_RGBA12}}, {{code|GL_RGBA16}}, {{code|GL_SRGB}}, {{code|GL_SRGB8}}, {{code|GL_SRGB_ALPHA}}, or {{code|GL_SRGB8_ALPHA8}}.
: Specifies the internal format of the texture. Must be one of the following symbolic constants: {{enum|GL_COMPRESSED_RED}}, {{enum|GL_COMPRESSED_RG}}, {{enum|GL_COMPRESSED_RGB}}, {{enum|GL_COMPRESSED_RGBA}}. {{enum|GL_COMPRESSED_SRGB}}, {{enum|GL_COMPRESSED_SRGB_ALPHA}}. {{enum|GL_DEPTH_COMPONENT}}, {{enum|GL_DEPTH_COMPONENT16}}, {{enum|GL_DEPTH_COMPONENT24}}, {{enum|GL_DEPTH_COMPONENT32}}, {{enum|GL_STENCIL_INDEX8}}, {{enum|GL_RED}}, {{enum|GL_RG}}, {{enum|GL_RGB}}, {{enum|GL_R3_G3_B2}}, {{enum|GL_RGB4}}, {{enum|GL_RGB5}}, {{enum|GL_RGB8}}, {{enum|GL_RGB10}}, {{enum|GL_RGB12}}, {{enum|GL_RGB16}}, {{enum|GL_RGBA}}, {{enum|GL_RGBA2}}, {{enum|GL_RGBA4}}, {{enum|GL_RGB5_A1}}, {{enum|GL_RGBA8}}, {{enum|GL_RGB10_A2}}, {{enum|GL_RGBA12}}, {{enum|GL_RGBA16}}, {{enum|GL_SRGB}}, {{enum|GL_SRGB8}}, {{enum|GL_SRGB_ALPHA}}, or {{enum|GL_SRGB8_ALPHA8}}.
; x, y
; x, y
: Specify the window coordinates of the lower left corner of the rectangular region of pixels to be copied.
: Specify the window coordinates of the lower left corner of the rectangular region of pixels to be copied.
Line 27: Line 27:
== Description ==
== Description ==


'''glCopyTexImage2D''' defines a two-dimensional texture image, or cube-map texture image with pixels from the current {{code|GL_READ_BUFFER}}.
'''glCopyTexImage2D''' defines a two-dimensional texture image, or cube-map texture image with pixels from the current {{enum|GL_READ_BUFFER}}.


The screen-aligned pixel rectangle with lower left corner at (''x'', ''y''), with a width of ''width'' and a height of ''height'', defines the texture array at the mipmap level specified by ''level''. ''internalformat'' specifies the internal format of the texture array.
The screen-aligned pixel rectangle with lower left corner at ({{param|x}}, {{param|y}}) and with a width of {{param|width}} and a height of {{param|height}} defines the texture array at the mipmap level specified by {{param|level}}. {{param|internalformat}} specifies the internal format of the texture array.


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.


Pixel ordering is such that lower x and y screen coordinates correspond to lower s and t texture coordinates.
Pixel ordering is such that lower x and y screen coordinates correspond to lower s and t texture coordinates.


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


When ''internalformat'' is one of the sRGB types, the GL does not automatically convert the source pixels to the sRGB color space. In this case, the '''glPixelMap''' function can be used to accomplish the conversion.
When {{param|internalformat}} is one of the sRGB types, the GL does not automatically convert the source pixels to the sRGB color space. In this case, the '''glPixelMap''' function can be used to accomplish the conversion.


== Notes ==
== Notes ==


1, 2, 3, and 4 are not accepted values for ''internalformat''.
1, 2, 3, and 4 are not accepted values for {{param|internalformat}}.


An image with height or width of 0 indicates a NULL texture.
An image with height or width of 0 indicates a NULL texture.
{{enum|GL_STENCIL_INDEX8}} is accepted for {{param|internalformat}} only if the GL version is 4.4 or higher.


== 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}}, or {{enum|GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}.
 
{{enum|GL_INVALID_VALUE}} is generated if {{param|level}} is less than 0.
 
{{enum|GL_INVALID_VALUE}} may be generated if {{param|level}} is greater than log<sub>2</sub>(max}, where max is the returned value of {{enum|GL_MAX_TEXTURE_SIZE}}.
 
{{enum|GL_INVALID_VALUE}} is generated if {{param|width}} is less than 0 or greater than {{enum|GL_MAX_TEXTURE_SIZE}}.


{{code|GL_INVALID_VALUE}} is generated if ''level'' is less than 0.
{{enum|GL_INVALID_VALUE}} is generated if {{param|border}} is not 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}} is generated if {{param|internalformat}} is not an accepted format.


{{code|GL_INVALID_VALUE}} is generated if ''width'' is less than 0 or greater than {{code|GL_MAX_TEXTURE_SIZE}}.
{{enum|GL_INVALID_OPERATION}} is generated if {{param|internalformat}} includes a depth component and the current [[Framebuffer]] has no depth buffer.


{{code|GL_INVALID_VALUE}} is generated if ''border'' is not 0.
{{enum|GL_INVALID_OPERATION}} is generated if {{param|internalformat}} is a [[Image Format|non-normalized integer format]] and the current read color buffer does not use an integer format.


{{code|GL_INVALID_VALUE}} is generated if ''internalformat'' is not an accepted format.
{{enum|GL_INVALID_OPERATION}} is generated if {{param|internalformat}} is a floating-point or normalized integer format, and the current read color buffer does not use a floating-point or normalized integer format.


{{code|GL_INVALID_OPERATION}} is generated if ''internalformat'' is {{code|GL_DEPTH_COMPONENT}}, {{code|GL_DEPTH_COMPONENT16}}, {{code|GL_DEPTH_COMPONENT24}}, or {{code|GL_DEPTH_COMPONENT32}} and there is no depth buffer.


== Associated Gets ==
== Associated Gets ==


[[GLAPI/glGetTexImage|glGetTexImage]]
{{apifunc|glGetTexImage}}


== See Also ==
== See Also ==


[[GLAPI/glCopyTexImage1D|glCopyTexImage1D]], [[GLAPI/glCopyTexSubImage1D|glCopyTexSubImage1D]], [[GLAPI/glCopyTexSubImage2D|glCopyTexSubImage2D]], [[GLAPI/glPixelStore|glPixelStore]], [[GLAPI/glTexImage1D|glTexImage1D]], [[GLAPI/glTexImage2D|glTexImage2D]], [[GLAPI/glTexSubImage1D|glTexSubImage1D]], [[GLAPI/glTexSubImage2D|glTexSubImage2D]], [[GLAPI/glTexParameter|glTexParameter]]
{{apifunc|glActiveTexture}}, {{apifunc|glBindTexture}}, {{apifunc|glBindFramebuffer}}, {{apifunc|glCopyTexImage1D}}, {{apifunc|glCopyImageSubData}}, {{apifunc|glCopyTexSubImage1D}}, {{apifunc|glCopyTexSubImage2D}}, {{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|CopyTexImage2D]]
[[Category:Core API Reference|CopyTexImage2D]]
[[Category:GL 4 API Texturing|CopyTexImage2D]]
[[Category:Core API Ref Texturing|CopyTexImage2D]]
[[Category:Texture Object API State Functions|CopyTexImage2D]]

Latest revision as of 21:36, 5 February 2021

glCopyTexImage2D
Core in version 4.6
Core since version 1.0

glCopyTexImage2D: copy pixels into a 2D texture image

Function Definition

 void glCopyTexImage2D(GLenum target​, GLint level​, GLenum internalformat​, GLint x​, GLint y​, GLsizei width​, GLsizei height​, GLint border​);
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.
internalformat
Specifies the internal format of the texture. Must be one of the following symbolic constants: GL_COMPRESSED_RED, GL_COMPRESSED_RG, GL_COMPRESSED_RGB, GL_COMPRESSED_RGBA. GL_COMPRESSED_SRGB, GL_COMPRESSED_SRGB_ALPHA. GL_DEPTH_COMPONENT, GL_DEPTH_COMPONENT16, GL_DEPTH_COMPONENT24, GL_DEPTH_COMPONENT32, GL_STENCIL_INDEX8, GL_RED, GL_RG, GL_RGB, GL_R3_G3_B2, GL_RGB4, GL_RGB5, GL_RGB8, GL_RGB10, GL_RGB12, GL_RGB16, GL_RGBA, GL_RGBA2, GL_RGBA4, GL_RGB5_A1, GL_RGBA8, GL_RGB10_A2, GL_RGBA12, GL_RGBA16, GL_SRGB, GL_SRGB8, GL_SRGB_ALPHA, or GL_SRGB8_ALPHA8.
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 image.
height
Specifies the height of the texture image.
border
This value must be 0.

Description

glCopyTexImage2D defines a two-dimensional texture image, or cube-map texture image with pixels from the current GL_READ_BUFFER.

The screen-aligned pixel rectangle with lower left corner at (x​, y​) and with a width of width​ and a height of height​ defines the texture array at the mipmap level specified by level​. internalformat​ specifies the internal format of the texture array.

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.

Pixel ordering is such that lower x and y screen coordinates correspond to lower s and t texture coordinates.

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

When internalformat​ is one of the sRGB types, the GL does not automatically convert the source pixels to the sRGB color space. In this case, the glPixelMap function can be used to accomplish the conversion.

Notes

1, 2, 3, and 4 are not accepted values for internalformat​.

An image with height or width of 0 indicates a NULL texture.

GL_STENCIL_INDEX8 is accepted for internalformat​ only if the GL version is 4.4 or higher.

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_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 width​ is less than 0 or greater than GL_MAX_TEXTURE_SIZE.

GL_INVALID_VALUE is generated if border​ is not 0.

GL_INVALID_VALUE is generated if internalformat​ is not an accepted format.

GL_INVALID_OPERATION is generated if internalformat​ includes a depth component and the current Framebuffer has no depth buffer.

GL_INVALID_OPERATION is generated if internalformat​ is a non-normalized integer format and the current read color buffer does not use an integer format.

GL_INVALID_OPERATION is generated if internalformat​ is a floating-point or normalized integer format, and the current read color buffer does not use a floating-point or normalized integer format.


Associated Gets

glGetTexImage

See Also

glActiveTexture, glBindTexture, glBindFramebuffer, glCopyTexImage1D, glCopyImageSubData, glCopyTexSubImage1D, glCopyTexSubImage2D, 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.

Retrieved from "https://wikis.khronos.org/opengl/index.php?title=GLAPI/glCopyTexImage2D&oldid=14769"