WebGLRenderingContext.copyTexSubImage2D()

The WebGLRenderingContext.copyTexSubImage2D() method of the WebGL API copies pixels from the current WebGLFramebuffer into an existing 2D texture sub-image.

Syntax

void gl.copyTexSubImage2D(target, level, xoffset, yoffset, x, y, width, height);

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.
xoffset
A GLint specifying the horizontal offset within the texture image.
yoffset
A GLint specifying the vertical offset within the texture image.
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.

Return value

None.

Examples

gl.copyTexSubImage2D(gl.TEXTURE_2D, 0, 0,0, 0, 0, 16, 16);

Specifications

Specification Status Comment
WebGL 1.0
The definition of 'copyTexSubImage2D' in that specification.		 Recommendation Initial definition.
OpenGL ES 2.0
The definition of 'glCopyTexSubImage2D' in that specification. 		Standard Man page of the (similar) OpenGL API.

Browser compatibility

BCD tables only load in the browser

See also