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
JavaScript
Copy Code
void <var>gl</var>.clearStencil(<var>s</var>);
Parameters
s
- A
GLint
specifying the index used when the stencil buffer is cleared. Default value: 0.
Return value
None.
Examples
JavaScript
Copy Code
gl.clearStencil(1);
To get the current stencil clear value, query the STENCIL_CLEAR_VALUE
constant.
JavaScript
Copy Code
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
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | 9 | 4.0 (2.0) | 11 | 12 | 5.1 |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | ? | 25 | (Yes) | ? | 12 | 8.1 |
See also
License
© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/webglrenderingcontext/clearstencil