The WebGLRenderingContext.clear()
method of the WebGL API clears buffers to preset values.
The preset values can be set by clearColor()
, clearDepth()
or clearStencil()
.
The scissor box, dithering, and buffer writemasks can affect the clear()
method.
void gl.clear(mask);
mask
GLbitfield
bitwise OR mask that indicates the buffers to be cleared. Possible values are: gl.COLOR_BUFFER_BIT
gl.DEPTH_BUFFER_BIT
gl.STENCIL_BUFFER_BIT
None.
If mask is not one of the listed possible values, a gl.INVALID_ENUM
error is thrown.
The clear()
method accepts multiple values.
gl.clear(gl.DEPTH_BUFFER_BIT); gl.clear(gl.DEPTH_BUFFER_BIT | gl.COLOR_BUFFER_BIT);
To get the current clear values, query the COLOR_CLEAR_VALUE
, DEPTH_CLEAR_VALUE
, and STENCIL_CLEAR_VALUE
constants.
gl.getParameter(gl.COLOR_CLEAR_VALUE); gl.getParameter(gl.DEPTH_CLEAR_VALUE); gl.getParameter(gl.STENCIL_CLEAR_VALUE);
Specification | Status | Comment |
---|---|---|
WebGL 1.0 The definition of 'clear' in that specification. | Recommendation | Initial definition. |
OpenGL ES 2.0 The definition of 'glClear' in that specification. | Standard | Man page of the OpenGL API. |
Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|---|
Basic support | 9 | 12 | 4 | 11 | 12 | 5.1 |
Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | IE mobile | Opera Android | iOS Safari |
---|---|---|---|---|---|---|---|
Basic support | Yes | 25 | Yes | Yes | 11 | 12 | 8.1 |
WebGLRenderingContext.clearColor()
WebGLRenderingContext.clearDepth()
WebGLRenderingContext.clearStencil()
© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/clear