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
GLintspecifying 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.0 The definition of 'clearStencil' in that specification. |
Recommendation | Initial definition. |
| OpenGL ES 2.0 The 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.
| Feature | Chrome | Firefox | Edge | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|---|
| Basic Support | 9 | 4.0 | 12 | 11 | 12 | 5.1 |
| Feature | Android | Chrome for Android | Edge mobile | Firefox for Android | IE mobile | Opera Android | iOS Safari |
|---|---|---|---|---|---|---|---|
| Basic Support | (Yes) | 25 | (Yes) | (Yes) | 11 | 12 | 8.1 |