WebGLRenderingContext: clearStencil() method
WebGL
WebGL
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 GLint specifying the index used when the stencil buffer is cleared. Default value: 0.
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
Browser compatibility
See also
- WebGLRenderingContext.clear()
- WebGLRenderingContext.clearColor()
- WebGLRenderingContext.clearDepth()