Documentation de Gambas - /comp/gb.opengl/gl/copyteximage2d

/comp/gb.opengl/gl/copyteximage2d

# Gl.CopyTexImage2D (gb.opengl)

Static Sub CopyTexImage2D ( Target As Integer, Level As Integer, Format As Integer, X As Integer, Y As Integer, Width As Integer, Height As Integer, Border As Integer )

Copy pixels into a 2D texture image.

### 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.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.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. Must be 0 or 2 n + 2 ⁡ border for some integer n.

height

  Specifies the height of the texture image. Must be 0 or 2 m + 2 ⁡ border for some integer m.

border

  Specifies the width of the border. Must be either 0 or 1.

### Description

Gl.CopyTexImage2D 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 + 2 ⁡ border and a height of height + 2 ⁡ border 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 Gl.ReadPixels 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 Gl.PixelMap 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.

### 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 is less than 0 or greater than Gl.MAX_TEXTURE_SIZE.

Gl.INVALID_VALUE is generated if non-power-of-two textures are not supported and the width or depth cannot be represented as 2 k + 2 ⁡ border for some integer k.

Gl.INVALID_VALUE is generated if border is not 0 or 1.

Gl.INVALID_VALUE is generated if internalformat is not an accepted format.

Gl.INVALID_OPERATION is generated if internalformat is Gl.DEPTH_COMPONENT, Gl.DEPTH_COMPONENT16, Gl.DEPTH_COMPONENT24, or Gl.DEPTH_COMPONENT32 and there is no depth buffer.

### Associated Gets

Gl.GetTexImage

### See also

- Gl.CopyTexImage1D,

Gl.CopyTexSubImage1D, Gl.CopyTexSubImage2D, Gl.PixelStore, Gl.TexImage1D, Gl.TexImage2D, Gl.TexSubImage1D, Gl.TexSubImage2D, Gl.TexParameter

See original documentation on OpenGL website