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.0The definition of 'clearStencil' in that specification. | Recommendation | Initial definition. |
OpenGL ES 2.0The definition of 'glClearStencil' in that specification. | Standard | Man page of the OpenGL API. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
clearStencil
|
Chrome
Full support 9 |
Edge
Full support 12 |
Firefox
Full support 4 |
IE
Full support 11 |
Opera
Full support 12 |
Safari
Full support 5.1 |
WebView Android
Full support Yes |
Chrome Android
Full support 25 |
Firefox Android
Full support Yes |
Opera Android
Full support 12 |
Safari iOS
Full support 8 |
Samsung Internet Android
Full support 1.5 |
Legend
- Full support
- Full support
See also
WebGLRenderingContext.clearStencil() by Mozilla Contributors is licensed under CC-BY-SA 2.5.