WebGLRenderingContext.stencilMask()
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
JavaScript
Copy Code
void <var>gl</var>.stencilMask(<var>mask</var>);
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
JavaScript
Copy Code
gl.stencilMask(110101);
To get the current stencil masks, query the STENCIL_WRITEMASK
, STENCIL_BACK_WRITEMASK
, or STENCIL_BITS
constants.
JavaScript
Copy Code
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.0 The definition of 'stencilMask' in that specification. |
Recommendation | Initial definition. |
OpenGL ES 2.0 The definition of 'glStencilMask' 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
WebGLRenderingContext.colorMask()
WebGLRenderingContext.depthMask()
WebGLRenderingContext.stencilMaskSeparate()
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/stencilmask