WebGLRenderingContext.checkFramebufferStatus

The WebGLRenderingContext.checkFramebufferStatus() method of the WebGL API returns the completeness status of the WebGLFramebuffer object.

Syntax

GLenum gl.checkFramebufferStatus(target);

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.

Return value

A GLenum indicating the completeness status of the framebuffer or 0 if an error occurs. Possible enum return values:

• gl.FRAMEBUFFER_COMPLETE: The framebuffer is ready to display.
• gl.FRAMEBUFFER_INCOMPLETE_ATTACHMENT: The attachment types are mismatched or not all framebuffer attachment points are framebuffer attachment complete.
• gl.FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT: There is no attachment.
• gl.FRAMEBUFFER_INCOMPLETE_DIMENSIONS: Height and width of the attachment are not the same.
• gl.FRAMEBUFFER_UNSUPPORTED: The format of the attachment is not supported or if depth and stencil attachments are not the same renderbuffer.
• When using a WebGL 2 context, the following values can be returned additionally:
  • gl.FRAMEBUFFER_INCOMPLETE_MULTISAMPLE: The values of gl.RENDERBUFFER_SAMPLES are different among attached renderbuffers, or are non-zero if the attached images are a mix of renderbuffers and textures.

Examples

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

// ...

gl.checkFramebufferStatus(gl.FRAMEBUFFER);

Specifications

Specification	Status	Comment
WebGL 1.0 The definition of 'checkFramebufferStatus' in that specification.	Recommendation	Initial definition for WebGL.
OpenGL ES 2.0 The definition of 'glCheckFramebufferStatus' in that specification.	Standard	Man page of the OpenGL API.
WebGL 2.0 The definition of 'checkFramebufferStatus' in that specification.	Editor's Draft	Updated definition for WebGL 2.
OpenGL ES 3.0 The definition of 'glCheckFramebufferStatus' in that specification.	Standard	Man page of the (similar) OpenGL ES 3 API.

Browser compatibility

See also

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