WebGLRenderingContext: copyTexSubImage2D() method
The WebGLRenderingContext.copyTexSubImage2D()
method of
the WebGL API copies pixels from the current
WebGLFramebuffer
into an existing 2D texture sub-image.
Syntax
js
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 n-th 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 (undefined
).
Examples
js
gl.copyTexSubImage2D(gl.TEXTURE_2D, 0, 0, 0, 0, 0, 16, 16);
Specifications
Specification |
---|
WebGL Specification # 5.14.8 |
Browser compatibility
BCD tables only load in the browser