WebGLRenderingContext: clear() method
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.
Syntax
Parameters
-
mask
-
A 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
Return value
Exceptions
If mask is not one of the listed possible values, a gl.INVALID_ENUM
error is thrown.
Examples
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);
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
clear |
9 |
12 |
4 |
11 |
12 |
5.1 |
4.4.3 |
25 |
4 |
12 |
8 |
1.5 |
See also