Web/API/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.
When using the OVR_multiview2 extension, the following value can be returned additionally:
- ext.FRAMEBUFFER_INCOMPLETE_VIEW_TARGETS_OVR: If baseViewIndex is not the same for all framebuffer attachment points where the value of FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE is not NONE, the framebuffer is considered incomplete.

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.0The definition of 'checkFramebufferStatus' in that specification.	Recommendation	Initial definition for WebGL.
OpenGL ES 2.0The definition of 'glCheckFramebufferStatus' in that specification.	Standard	Man page of the OpenGL API.
WebGL 2.0The definition of 'checkFramebufferStatus' in that specification.	Editor's Draft	Updated definition for WebGL 2.
OpenGL ES 3.0The definition of 'glCheckFramebufferStatus' 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.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`checkFramebufferStatus`	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