TheWebGLRenderingContext.bindFramebuffer() method of theWebGL API binds to the specified target the providedWebGLFramebuffer, or, if theframebuffer argument is null, the defaultWebGLFramebuffer, which is associated with the canvas rendering context.

Syntax

bindFramebuffer(target, framebuffer)

Parameters

target

AGLenum specifying the binding point (target). Possible values:

gl.FRAMEBUFFER

Collection buffer data storage of color, alpha,depth and stencil buffers used as both a destination for drawing and as a source for reading (see below).

When using aWebGL 2 context,the following values are available additionally:

gl.DRAW_FRAMEBUFFER

Used as a destination for drawing operations such asgl.draw*,gl.clear* andgl.blitFramebuffer.

gl.READ_FRAMEBUFFER

Used as a source for reading operations such asgl.readPixels andgl.blitFramebuffer.

framebuffer

AWebGLFramebuffer object to bind, ornull for binding theHTMLCanvasElement orOffscreenCanvas object associated with the rendering context.

Return value

None (undefined).

Exceptions

Agl.INVALID_ENUM error is thrown iftarget is notgl.FRAMEBUFFER,gl.DRAW_FRAMEBUFFER, orgl.READ_FRAMEBUFFER.

Examples

Binding a frame buffer

const canvas = document.getElementById("canvas");const gl = canvas.getContext("webgl");const framebuffer = gl.createFramebuffer();gl.bindFramebuffer(gl.FRAMEBUFFER, framebuffer);

Getting current bindings

To check the current frame buffer binding, query theFRAMEBUFFER_BINDINGconstant.

gl.getParameter(gl.FRAMEBUFFER_BINDING);

Specifications

Browser compatibility

See also

• WebGLRenderingContext.createFramebuffer()
• WebGLRenderingContext.deleteFramebuffer()
• WebGLRenderingContext.isFramebuffer()
• Other buffers:WebGLBuffer,WebGLRenderbuffer