WebGLRenderingContext.stencilMaskSeparate()

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

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

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 Status Comment
WebGL 1.0
The definition of 'stencilMaskSeparate' in that specification.
Recommendation Initial definition.
OpenGL ES 2.0
The definition of 'glStencilMaskSeparate' in that specification.
Standard Man page of the OpenGL API.

Browser compatibility

Feature Chrome Edge Firefox Internet Explorer Opera Safari Servo
Basic Support9124.011125.1No support
Feature Android Chrome for Android Edge Mobile Firefox for Android IE Mobile Opera Mobile Safari Mobile
Basic Support(Yes)25(Yes)4.0128.1

See also

Document Tags and Contributors

 Contributors to this page: teoli, fscholz
 Last updated by: teoli,