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 togl.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
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
bindFramebuffer | Chrome Full support 9 | Edge Full support 12 | Firefox Full support 4 | IE Full support 11 | Opera Full support 12 | Safari Full support 5.1 | WebView Android Full support Yes | Chrome Android Full support 25 | Firefox Android Full support Yes | Opera Android Full support 12 | Safari iOS Full support 8 | Samsung Internet Android Full support 1.5 |
WebGL2 | Chrome Full support 56 | Edge Full support 79 | Firefox Full support 51 | IE No support No | Opera Full support 43 | Safari No support No | WebView Android Full support 58 | Chrome Android Full support 58 | Firefox Android Full support 51 | Opera Android Full support 43 | Safari iOS No support No | Samsung Internet Android Full support 7.0 |
Legend
- Full support
- Full support
- No support
- No support