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

void gl.clear(mask);

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.

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

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 Edge Firefox Internet Explorer Opera Safari Servo
Basic Support9124.011125.1No support
Feature Android Chrome for Android Edge Mobile Firefox for Android IE Mobile Opera Mobile Safari Mobile
Basic Support(Yes)25(Yes)4.011128.1

See also

Document Tags and Contributors

 Contributors to this page: teoli, fscholz
 Last updated by: teoli,