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.clearBuffer[fiuv]()
methods of the WebGL 2 API clear buffers from the currently bound framebuffer.
Syntax
void gl.clearBufferiv(buffer, drawBuffer, value); void gl.clearBufferuiv(buffer, drawBuffer, value); void gl.clearBufferfv(buffer, drawBuffer, value); void gl.clearBufferfi(buffer, drawBuffer, depth, stencil);
Parameters
buffer
- A
GLenum
specifying the buffer to clear. Possible values are:gl.COLOR
: Color buffer.gl.DEPTH
: Depth buffer.gl.STENCIL
: Stencil buffer.gl.DEPTH_STENCIL
: clears depth and stencil buffers (used withclearBufferfi
).
drawBuffer
- A
GLint
specifying the draw buffer to clear. value
- An
Array
ofGLint
,GLuint
orGLfloat
values or
anInt32Array
,Uint32Array
orFloat32Array
specifying the values to clear to. depth
- A
GLfloat
specifying the value to clear a depth render buffer to. stencil
- A
GLint
specifying the value to clear the stencil render buffer to.
Return value
None.
Examples
gl.clearBufferiv(gl.COLOR, 0, new Int32Array([r, g, b, a])); gl.clearBufferuiv(gl.COLOR, 0, new Uint32Array([r, g, b, a])); gl.clearBufferfv(gl.COLOR, 0, new Float32Array([r, g, b, a])); gl.clearBufferfv(gl.COLOR, 0, [0.0, 0.0, 0.0, 0.0]); gl.clearBufferfi(gl.DEPTH_STENCIL, 0, 1.0, 0);
Specifications
Specification | Status | Comment |
---|---|---|
WebGL 2.0 The definition of 'clearBuffer[fiuv]()' in that specification. |
Editor's Draft | Initial definition for WebGL. |
OpenGL ES 3.0 The definition of 'glClearBuffer' 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
.