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.

SyntaxEdit

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.

ExamplesEdit

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

SpecificationsEdit

Browser compatibilityEdit

See alsoEdit

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