glCopyTexImage2D - OpenGL ES 3 Reference Pages

## Name

glCopyTexImage2D — copy pixels into a 2D texture image

## C Specification

`void glCopyTexImage2D(` | GLenum target,
| GLint level,
| GLenum internalformat,
| GLint x,
| GLint y,
| GLsizei width,
| GLsizei height,
| GLint border`)`;

## Parameters

`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_ALPHA`, `GL_LUMINANCE`, `GL_LUMINANCE_ALPHA`, `GL_RGB`, `GL_RGBA`, `GL_R8`, `GL_RG8`, `GL_RGB565`, `GL_RGB8`, `GL_RGBA4`, `GL_RGB5_A1`, `GL_RGBA8`, `GL_RGB10_A2`, `GL_SRGB8`, `GL_SRGB8_ALPHA8`, `GL_R8I`, `GL_R8UI`, `GL_R16I`, `GL_R16UI`, `GL_R32I`, `GL_R32UI`, `GL_RG8I`, `GL_RG8UI`, `GL_RG16I`, `GL_RG16UI`, `GL_RG32I`, `GL_RG32UI`, `GL_RGBA8I`, `GL_RGBA8UI`, `GL_RGB10_A2UI`, `GL_RGBA16I`, `GL_RGBA16UI`, `GL_RGBA32I`, `GL_RGBA32UI`.

`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`

  Specifies the width of the border. 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 after conversion to RGBA values. The error `GL_INVALID_OPERATION` is generated if integer RGBA data is required and the format of the current color buffer is not integer; or if floating- or fixed-point RGBA data is required and the format of the current color buffer is integer.

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.

## Notes

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

## 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 log 2 ⁢ max , where max is the returned value of `GL_MAX_TEXTURE_SIZE`.

`GL_INVALID_VALUE` is generated if `width` or `height` 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.

## API Version Support

| OpenGL ES API Version
--- | ---
Function Name | 2.0 | 3.0
glCopyTexImage2D | ✔ | ✔

## See Also

glCopyTexSubImage2D, glPixelStorei, glTexImage2D, 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/.