WebGLRenderingContext.framebufferRenderbuffer()

The WebGLRenderingContext.framebufferRenderbuffer() method of the WebGL API attaches a WebGLRenderbuffer object to a WebGLFramebuffer object.

Syntax

void <var>gl</var>.framebufferRenderbuffer(<var>target</var>, <var>attachment</var>, <var>renderbuffertarget</var>, <var>renderbuffer</var>);

Parameters

target

A GLenum specifying the binding point (target) for the framebuffer. 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.

attachment

A GLenum specifying the attachment point for the render buffer. Possible values:

• gl.COLOR_ATTACHMENT0: color buffer.
• gl.DEPTH_ATTACHMENT: depth buffer.
• gl.STENCIL_ATTACHMENT: stencil buffer.
• When using a WebGL 2 context, the following values are available additionally:
  • gl.DEPTH_STENCIL_ATTACHMENT: depth and stencil buffer.
  • Copy Code

    gl.COLOR_ATTACHMENT1<br>
         gl.COLOR_ATTACHMENT2<br>
         gl.COLOR_ATTACHMENT3<br>
         gl.COLOR_ATTACHMENT4<br>
         gl.COLOR_ATTACHMENT5<br>
         gl.COLOR_ATTACHMENT6<br>
         gl.COLOR_ATTACHMENT7<br>
         gl.COLOR_ATTACHMENT8<br>
         gl.COLOR_ATTACHMENT9<br>
         gl.COLOR_ATTACHMENT10<br>
         gl.COLOR_ATTACHMENT11<br>
         gl.COLOR_ATTACHMENT12<br>
         gl.COLOR_ATTACHMENT13<br>
         gl.COLOR_ATTACHMENT14<br>
         gl.COLOR_ATTACHMENT15

• When using the WEBGL_draw_buffers extension:
  • ext.COLOR_ATTACHMENT0_WEBGL (same as gl.COLOR_ATTACHMENT0)
    
    Copy Code

    ext.COLOR_ATTACHMENT1_WEBGL<br>
         ext.COLOR_ATTACHMENT2_WEBGL<br>
         ext.COLOR_ATTACHMENT3_WEBGL<br>
         ext.COLOR_ATTACHMENT4_WEBGL<br>
         ext.COLOR_ATTACHMENT5_WEBGL<br>
         ext.COLOR_ATTACHMENT6_WEBGL<br>
         ext.COLOR_ATTACHMENT7_WEBGL<br>
         ext.COLOR_ATTACHMENT8_WEBGL<br>
         ext.COLOR_ATTACHMENT9_WEBGL<br>
         ext.COLOR_ATTACHMENT10_WEBGL<br>
         ext.COLOR_ATTACHMENT11_WEBGL<br>
         ext.COLOR_ATTACHMENT12_WEBGL<br>
         ext.COLOR_ATTACHMENT13_WEBGL<br>
         ext.COLOR_ATTACHMENT14_WEBGL<br>
         ext.COLOR_ATTACHMENT15_WEBGL

renderbuffertarget

A GLenum specifying the binding point (target) for the render buffer. Possible values:

• gl.RENDERBUFFER: Buffer data storage for single images in a renderable internal format.

renderbuffer

A WebGLRenderbuffer object to attach.

Return value

None.

Exceptions

• A gl.INVALID_ENUM error is thrown if target is not gl.FRAMEBUFFER, gl.DRAW_FRAMEBUFFER, or gl.READ_FRAMEBUFFER.
• A gl.INVALID_ENUM error is thrown if renderbuffertarget is not gl.RENDERBUFFER.
• A gl.INVALID_ENUM error is thrown if attachment is not one of the allowed enums.

Examples

gl.framebufferRenderbuffer(gl.FRAMEBUFFER, gl.COLOR_ATTACHMENT0, gl.RENDERBUFFER, renderbuffer);

Specifications

Browser compatibility

[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

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