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

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.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

See also

• WebGLRenderingContext.colorMask()
• WebGLRenderingContext.depthMask()
• WebGLRenderingContext.stencilMaskSeparate()