WebGLRenderingContext.bindFramebuffer()

The WebGLRenderingContext.bindFramebuffer() method of the WebGL API binds a given WebGLFramebuffer to a target.

Syntax

void gl.bindFramebuffer(target, framebuffer);

Parameters

target
A GLenum specifying the binding point (target). Possible values:
  • gl.FRAMEBUFFER: Collection buffer data storage of color, alpha, depth and stencil buffers used to render an image.
  • When using a WebGL 2 context, the following values are available additionally:
    • gl.DRAW_FRAMEBUFFER: Equivalent to gl.FRAMEBUFFER. Used as a destination for drawing, rendering, clearing, and writing operations.
    • gl.READ_FRAMEBUFFER: Used as a source for reading operations.
framebuffer
A WebGLFramebuffer object to bind.

Return value

None.

Exceptions

A gl.INVALID_ENUM error is thrown if target is not gl.FRAMEBUFFER, gl.DRAW_FRAMEBUFFER, or gl.READ_FRAMEBUFFER.

Examples

Binding a frame buffer

var canvas = document.getElementById('canvas');
var gl = canvas.getContext('webgl');
var framebuffer = gl.createFramebuffer();

gl.bindFramebuffer(gl.FRAMEBUFFER, framebuffer);

Getting current bindings

To check the current frame buffer binding, query the FRAMEBUFFER_BINDING constant.

gl.getParameter(gl.FRAMEBUFFER_BINDING);

Specifications

Specification Status Comment
WebGL 1.0
The definition of 'bindFramebuffer' in that specification.
Recommendation Initial definition for WebGL.
OpenGL ES 2.0
The definition of 'glBindFramebuffer' in that specification.
Standard Man page of the OpenGL API.
WebGL 2.0
The definition of 'bindFrameBuffer' in that specification.
Editor's Draft Updated definition for WebGL 2.
Adds: gl.DRAW_FRAMEBUFFER and gl.READ_FRAMEBUFFER
OpenGL ES 3.0
The definition of 'glBindFramebuffer' in that specification.
Standard Man page of the (similar) OpenGL ES 3 API.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support912411125.1
WebGL256 No51 No43 No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidIE mobileOpera AndroidiOS Safari
Basic support Yes25 Yes Yes11128.1
WebGL25858 No51 No43 No

See also

Document Tags and Contributors

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