WebGLRenderingContext: clearStencil() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Note: This feature is available in Web Workers.

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

js
clearStencil(s)

Parameters

s

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

Return value

None (undefined).

Examples

js
gl.clearStencil(1);

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

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

Specifications

Specification
WebGL Specification
# 5.14.3

Browser compatibility

BCD tables only load in the browser

See also