The WebGLRenderingContext.copyTexImage2D() method of the WebGL API copies pixels from the current WebGLFramebuffer into a 2D texture image.
Syntax
void gl.copyTexImage2D(target, level, internalformat, x, y, width, height, border);
Parameters
target- A
GLenumspecifying the binding point (target) of the active texture. Possible values:gl.TEXTURE_2D: A two-dimensional texture.gl.TEXTURE_CUBE_MAP_POSITIVE_X: Positive X face for a cube-mapped texture.gl.TEXTURE_CUBE_MAP_NEGATIVE_X: Negative X face for a cube-mapped texture.gl.TEXTURE_CUBE_MAP_POSITIVE_Y: Positive Y face for a cube-mapped texture.gl.TEXTURE_CUBE_MAP_NEGATIVE_Y: Negative Y face for a cube-mapped texture.gl.TEXTURE_CUBE_MAP_POSITIVE_Z: Positive Z face for a cube-mapped texture.gl.TEXTURE_CUBE_MAP_NEGATIVE_Z: Negative Z face for a cube-mapped texture.
level- A
GLintspecifying the level of detail. Level 0 is the base image level and level n is the nth mipmap reduction level. internalformat- A
GLintspecifying the color components in the texture. Possible values:gl.ALPHA: Discards the red, green and blue components and reads the alpha component.gl.RGB: Discards the alpha components and reads the red, green and blue components.gl.RGBA: Red, green, blue and alpha components are read from the color buffer.gl.LUMINANCE: Each color component is a luminance component, alpha is 1.0.gl.LUMINANCE_ALPHA: Each component is a luminance/alpha component.
x- A
GLintspecifying the x coordinate of the lower left corner where to start copying. y- A
GLintspecifying the y coordinate of the lower left corner where to start copying. width- A
GLsizeispecifying the width of the texture. height- A
GLsizeispecifying the height of the texture. border- A
GLintspecifying the width of the border. Must be 0.
Return value
None.
Examples
gl.copyTexImage2D(gl.TEXTURE_2D, 0, gl.RGBA, 0, 0, 512, 512, 0);
Specifications
| Specification | Status | Comment |
|---|---|---|
| WebGL 1.0 The definition of 'copyTexImage2D' in that specification. |
Recommendation | Initial definition. |
| OpenGL ES 2.0 The definition of 'glCopyTexImage2D' in that specification. |
Standard | Man page of the (similar) OpenGL API. |
Browser compatibility
| Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|---|
| Basic support | 9 | 12 | 4.0 (2.0) | 11 | 12 | 5.1 |
| Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | Firefox OS | IE Mobile | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|---|---|
| Basic support | ? | 25 | 4.0 (2.0) | 1.0 | ? | 12 | 8.0 |