WebGLRenderingContext.clear()
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
JavaScript
Copy Code
void <var>gl</var>.clear(<var>mask</var>);
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
Errors thrown
If mask is not one of the listed possible values, a gl.INVALID_ENUM
error is thrown.
Return value
None.
Examples
The clear()
method accepts multiple values.
JavaScript
Copy Code
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.
JavaScript
Copy Code
gl.getParameter(gl.COLOR_CLEAR_VALUE); gl.getParameter(gl.DEPTH_CLEAR_VALUE); gl.getParameter(gl.STENCIL_CLEAR_VALUE);
Specifications
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. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | 9 | 4.0 (2.0) | 11 | 12 | 5.1 |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | ? | 25 | (Yes) | ? | 12 | 8.1 |
See also
WebGLRenderingContext.clearColor()
WebGLRenderingContext.clearDepth()
WebGLRenderingContext.clearStencil()
License
© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/webglrenderingcontext/clear