WebGL2RenderingContext.blitFramebuffer()

The WebGL2RenderingContext.blitFramebuffer() method of the WebGL 2 API transfers a block of pixels from the read framebuffer to the draw framebuffer. Read and draw framebuffers are bound using WebGLRenderingContext.bindFramebuffer().

Syntax

void gl.blitFramebuffer(srcX0, srcY0, srcX1, srcY1,
                        dstX0, dstY0, dstX1, dstY1,
                        mask, filter);

Parameters

srcX0, srcY0, srcX1, srcY1
A GLint specifying the bounds of the source rectangle.
dstX0, dstY0, dstX1, dstY1
A GLint specifying the bounds of the destination rectangle.
mask
A GLbitfield specifying a bitwise OR mask indicating which buffers are to be copied. Possible values:
  • gl.COLOR_BUFFER_BIT
  • gl.DEPTH_BUFFER_BIT
  • gl.STENCIL_BUFFER_BIT
filter
A GLenum specifying the interpolation to be applied if the image is stretched. Possible values:
  • gl.NEAREST
  • gl.LINEAR

Return value

None.

Examples

gl.blitFramebuffer(0, 0, canvas.width, canvas.height,
                   0, 0, canvas.width, canvas.height,
                   gl.COLOR_BUFFER_BIT, gl.NEAREST);

Specifications

Specification Status Comment
WebGL 2.0
The definition of 'blitFramebuffer' in that specification.
Editor's Draft Initial definition for WebGL.
OpenGL ES 3.0
The definition of 'glBlitFramebuffer' in that specification.
Standard Man page of the (similar) OpenGL API.

Browser compatibility

BCD tables only load in the browser

See also