TheWebGLRenderingContext.clear() method of theWebGL API clears buffers to preset values.

The preset values can be set byclearColor(),clearDepth() orclearStencil().

The scissor box, dithering, and buffer writemasks can affect theclear() method. For example, if buffer writing is disabled viacolorMask(),depthMask(), orstencilMask(),clear() has no effect on the corresponding buffer.

Syntax

clear(mask)

Parameters

mask

AGLbitfield bitwise OR mask that indicates the buffers to becleared. Possible values are:

• gl.COLOR_BUFFER_BIT
• gl.DEPTH_BUFFER_BIT
• gl.STENCIL_BUFFER_BIT

Return value

None (undefined).

Exceptions

Ifmask is not one of the listed possible values, agl.INVALID_ENUM error is thrown.

Examples

Theclear() 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 theCOLOR_CLEAR_VALUE,DEPTH_CLEAR_VALUE, andSTENCIL_CLEAR_VALUE constants.

gl.getParameter(gl.COLOR_CLEAR_VALUE);gl.getParameter(gl.DEPTH_CLEAR_VALUE);gl.getParameter(gl.STENCIL_CLEAR_VALUE);

Specifications

Browser compatibility

See also

• WebGLRenderingContext.clearColor()
• WebGLRenderingContext.clearDepth()
• WebGLRenderingContext.clearStencil()