This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The WebGL2RenderingContext.clearBuffer[fiuv]()
methods of the WebGL 2 API clear buffers from the currently bound framebuffer.
Syntax
void gl.clearBufferfv(buffer, drawbuffer, values, optional srcOffset); void gl.clearBufferiv(buffer, drawbuffer, values, optional srcOffset); void gl.clearBufferuiv(buffer, drawbuffer, values, optional srcOffset); 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. values
- 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
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.
Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|---|
Basic support | 56 | No | 51 | No | 43 | No |
SharedArrayBuffer as a parameter | 60 | ? | ? | ? | 47 | ? |
Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | IE mobile | Opera Android | iOS Safari |
---|---|---|---|---|---|---|---|
Basic support | 58 | 58 | No | 51 | No | 43 | No |
SharedArrayBuffer as a parameter | 60 | 60 | ? | ? | ? | 47 | ? |