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 |
---|
WebGL Specification (WebGL) # 5.14.3 |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
clearStencil |
9 |
12 |
4 |
11 |
12 |
5.1 |
≤37 |
25 |
Yes |
12 |
8 |
1.5 |
See also
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/clearStencil