This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.
The WebGL2RenderingContext.invalidateFramebuffer()
method of the WebGL 2 API invalidates the contents of attachments in a framebuffer.
Syntax
void gl.invalidateFramebuffer(target, attachments);
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.gl.DRAW_FRAMEBUFFER
: Equivalent togl.FRAMEBUFFER
.gl.READ_FRAMEBUFFER
: Used as a source for reading operations.
attachments
- An
Array
ofGLenum
specifying the attachment points to invalidate. Possible values:gl.COLOR_ATTACHMENT{0-15}
: Invalidates one of the framebuffer's color buffers.gl.DEPTH_ATTACHMENT
: Invalidates the framebuffer's depth buffer.gl.STENCIL_ATTACHMENT
: Invalidates the framebuffer's stencil buffer.gl.DEPTH_STENCIL_ATTACHMENT
: Invalidates both the framebuffer's depth and stencil buffer.
Return value
None.
Examples
gl.invalidateFramebuffer(gl.READ_FRAMEBUFFER, [gl.COLOR_ATTACHMENT0, gl.COLOR_ATTACHMENT1]);
Specifications
Specification | Status | Comment |
---|---|---|
WebGL 2.0 The definition of 'invalidateFramebuffer' in that specification. |
Editor's Draft | Initial definition for WebGL. |
OpenGL ES 3.0 The definition of 'glInvalidateFramebuffer' in that specification. |
Standard | Man page of the (similar) OpenGL API. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | No support [2] | Nightly build [1] | No support | No support | No support |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | No support | No support | No support | No support | No support | No support |
[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
.