WebGLRenderingContext: stencilMaskSeparate() 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.

Note: This feature is available in Web Workers.

The WebGLRenderingContext.stencilMaskSeparate() method of the WebGL API controls enabling and disabling of front and/or back writing of individual bits in the stencil planes.

The WebGLRenderingContext.stencilMask() method can set both, the front and back stencil writemasks to one value at the same time.

Syntax

js
stencilMaskSeparate(face, mask)

Parameters

face

A GLenum specifying whether the front and/or back stencil writemask is updated. The possible values are:

  • gl.FRONT
  • gl.BACK
  • gl.FRONT_AND_BACK
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.stencilMaskSeparate(gl.FRONT, 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

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
stencilMaskSeparate

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

See also