WebGLRenderingContext.bindFramebuffer()

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

Syntax

JavaScript
void <var>gl</var>.bindFramebuffer(<var>target</var>, <var>framebuffer</var>);

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

JavaScript
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.

JavaScript
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

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari
Basic support 9 12 4.0 (2.0) 11 12 5.1
WebGL 2 No support [2] No support Nightly build [1] No support No support No support
Feature Android Chrome for Android Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile
Basic support ? 25 4.0 (2.0) 1.0 ? 12 8.0
WebGL 2 No support No support No support No support No support No support No support

[1] WebGL 2 is enabled by default in Firefox Nightly. To enable it in a release version of Firefox, set the preference webgl.enable-prototype-webgl2 to true in about:config.

[2] 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

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/webglrenderingcontext/bindframebuffer

API Method Reference WebGL WebGLRenderingContext