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.

See full compatibility

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

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

gl.stencilMaskSeparate(gl.FRONT, 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
WebGL Specification # 5.14.3

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS
`stencilMaskSeparate`	Chrome – Full support Chrome 9 (Release date: 2011-02-03) footnote Full support	Edge – Full support Edge 12 (Release date: 2015-07-29) footnote Full support	Firefox – Full support Firefox 4 (Release date: 2011-03-22) footnote Full support	Opera – Full support Opera 12 (Release date: 2012-06-14) footnote Full support	Safari – Full support Safari 5.1 (Release date: 2011-07-20) footnote Full support	Chrome Android – Full support Chrome Android 25 (Release date: 2013-02-27) footnote Full support	Firefox for Android – Full support Firefox for Android 4 (Release date: 2011-03-29) footnote Full support	Opera Android – Full support Opera Android 12 (Release date: 2012-02-25) footnote Full support	Safari on iOS – Full support Safari on iOS 8 (Release date: 2014-09-17) footnote Full support	Samsung Internet – Full support Samsung Internet 1.5 (Release date: 2013-09-25) footnote Full support	WebView Android – Full support WebView Android 4.4.3 (Release date: 2014-06-02) footnote Full support	WebView on iOS – Full support WebView on iOS 8 (Release date: 2014-09-17) footnote Full support

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

Full support: Full support