web api instance method
WebGLRenderingContext: clearStencil() method
Available in 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
clearStencil(s)
Parameters
s- : A
GLintspecifying the index used when the stencil buffer is cleared. Default value: 0.
- : A
Return value
None (undefined).
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
SpecificationsStandards references are available on the canonical MDN page.
Browser compatibility
Browser compatibilityCompatibility data is available on the canonical MDN page.