logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

glStencilMask - control the front and back writing of individual bits in the stencil planes

Associated Gets

glGet() with argument GL_STENCIL_WRITEMASK, GL_STENCIL_BACK_WRITEMASK, or GL_STENCIL_BITS

C Specification

voidglStencilMask(GLuintmask);

Description

glStencilMask controls the writing of individual bits in the stencil planes. The least significant n bits
       of mask, where n is the number of bits in the stencil buffer, specify a mask. Where a 1 appears in the
       mask, it's possible to write to the corresponding bit in the stencil buffer. Where a 0 appears, the
       corresponding bit is write-protected. Initially, all bits are enabled for writing.

       There can be two separate mask writemasks; one affects back-facing polygons, and the other affects
       front-facing polygons as well as other non-polygon primitives.  glStencilMask() sets both front and back
       stencil writemasks to the same values. Use glStencilMaskSeparate() to set front and back stencil
       writemasks to different values.

Name

       glStencilMask - control the front and back writing of individual bits in the stencil planes

Notes

glStencilMask() is the same as calling glStencilMaskSeparate() with face set to GL_FRONT_AND_BACK.

Parameters

mask
           Specifies a bit mask to enable and disable writing of individual bits in the stencil planes.
           Initially, the mask is all 1's.

See Also

glColorMask(), glDepthMask(), glStencilFunc(), glStencilFuncSeparate(), glStencilMaskSeparate(),
       glStencilOp(), glStencilOpSeparate()

Version Support

       ┌───────────────┬───────────────────────────────────────────────────────────────────────┐
       │               │                OpenGLVersion                                         │
       ├───────────────┼─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┤
       │ Function2.02.13.03.13.23.34.04.14.24.34.44.5 │
       │ /             │     │     │     │     │     │     │     │     │     │     │     │     │
       │ Feature       │     │     │     │     │     │     │     │     │     │     │     │     │
       │ Name          │     │     │     │     │     │     │     │     │     │     │     │     │
       ├───────────────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
       │ glStencilMask │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │
       └───────────────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘

See Also