WebGLRenderingContext: stencilMask() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

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

js
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 (undefined).

Examples

js
gl.stencilMask(110101);

To get the current stencil masks, query the STENCIL_WRITEMASK, STENCIL_BACK_WRITEMASK, or STENCIL_BITS constants.

js
gl.getParameter(gl.STENCIL_WRITEMASK);
// 110101
gl.getParameter(gl.STENCIL_BACK_WRITEMASK);
// 110101
gl.getParameter(gl.STENCIL_BITS);
// 0

Specifications

Specification
WebGL Specification
# 5.14.3

Browser compatibility

BCD tables only load in the browser

See also