MDN wants to learn about developers like you: https://qsurvey.mozilla.com/s3/MDN-dev-survey-2018-1

Our volunteers haven't translated this article into Português (Europeu) yet. Join us and help get the job done!
You can also read the article in English (US).

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

Return value

None.

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

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

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support912411125.1
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidIE mobileOpera AndroidiOS Safari
Basic support Yes25 Yes Yes11128.1

See also

Etiquetas do documento e contribuidores

 Contribuidores para esta página: fscholz, teoli
 Última atualização por: fscholz,