WebGLRenderingContext.copyTexImage2D()
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
GLenum
specifying 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
GLint
specifying the level of detail. Level 0 is the base image level and level n is the nth mipmap reduction level. internalformat
- A
GLenum
specifying 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
GLint
specifying the x coordinate of the lower left corner where to start copying. y
- A
GLint
specifying the y coordinate of the lower left corner where to start copying. width
- A
GLsizei
specifying the width of the texture. height
- A
GLsizei
specifying the height of the texture. border
- A
GLint
specifying 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
BCD tables only load in the browser
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.