The WebGLRenderingContext.stencilMask()
method of the WebGL API controls enabling and disabling of both the front and back writing of individual bits in the stencil planes.
The WebGLRenderingContext.stencilMaskSeparate()
method can set front and back stencil writemasks to different values.
Syntax
void gl.stencilMask(mask);
Parameters
mask
- A
GLuint
specifying a bit mask to enable or disable writing of individual bits in the stencil planes. By default, the mask is all 1.
Return value
None.
Examples
gl.stencilMask(110101);
To get the current stencil masks, query the STENCIL_WRITEMASK
, STENCIL_BACK_WRITEMASK
, or STENCIL_BITS
constants.
gl.getParameter(gl.STENCIL_WRITEMASK);
// 110101
gl.getParameter(gl.STENCIL_BACK_WRITEMASK);
// 110101
gl.getParameter(gl.STENCIL_BITS);
// 0
Specifications
Specification | Status | Comment |
WebGL 1.0The definition of 'stencilMask' in that specification. | Recommendation | Initial definition. |
OpenGL ES 2.0The definition of 'glStencilMask' 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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
stencilMask
|
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.colorMask()
WebGLRenderingContext.depthMask()
WebGLRenderingContext.stencilMaskSeparate()
WebGLRenderingContext.stencilMask() by Mozilla Contributors is licensed under CC-BY-SA 2.5.