WebGL2RenderingContext.blitFramebuffer()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The WebGL2RenderingContext.blitFramebuffer() method of the WebGL 2 API transfers a block of pixels from the read framebuffer to the draw framebuffer.

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

Feature Chrome Edge Firefox Internet Explorer Opera Safari Servo
Basic SupportNo support1No support51.0No supportNo supportNo supportNo support
Feature Android Chrome for Android Edge Mobile Firefox for Android IE Mobile Opera Mobile Safari Mobile
Basic SupportNo supportNo supportNo supportNo supportNo supportNo supportNo support

1. To use an experimental implementation of WebGL 2 in Chrome, you have to start Chrome with the runtime flag --enable-unsafe-es3-apis.

See also

Document Tags and Contributors

 Contributors to this page: teoli, JeremiePelletier, fscholz
 Last updated by: teoli,