WebGLRenderingContext.clearStencil()

The WebGLRenderingContext.clearStencil() method of the WebGL API specifies the clear value for the stencil buffer.

This specifies what stencil value to use when calling the clear() method.

Syntax

void gl.clearStencil(s);

Parameters

s
A GLint specifying the index used when the stencil buffer is cleared. Default value: 0.

Return value

None.

Examples

gl.clearStencil(1);

To get the current stencil clear value, query the STENCIL_CLEAR_VALUE constant.

gl.getParameter(gl.STENCIL_CLEAR_VALUE);
// 1

Specifications

Specification Status Comment
WebGL 1.0
The definition of 'clearStencil' in that specification.
Recommendation Initial definition.
OpenGL ES 2.0
The definition of 'glClearStencil' in that specification.
Standard Man page of the OpenGL API.

Browser compatibility

BCD tables only load in the browser

See also