GLSTENCILMASK(3G)

🌸 NAME 🌸

okay bestie, this is the glStencilMask manual page, and it lives in the GLSTENCILMASK(3G) glow-up zone ([FIXME: manual] set, no cap). It's literally about controlling the front and back writing of individual bits in the stencil planes. iconic behavior only 💅✨

🎀 C SPECIFICATION 🎀

void glStencilMask(GLuint mask);

🦋 PARAMETERS 🦋

• mask — a bit mask that enables and disables writing of individual bits in the stencil planes. Initially, the mask is all 1's. periodt 💖

✨ DESCRIPTION ✨

glStencilMask controls the writing of individual bits in the stencil planes, and yes, it's giving very precise little bit-level gatekeeper energy. 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. slay 🔥

There can be two separate mask writemasks (that's the wording, bestie, we don't make the rules): 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. iykyk 🫶

💜 NOTES 💜

glStencilMask() is the same as calling glStencilMaskSeparate() with face set to GL_FRONT_AND_BACK. no extra drama, just facts 💀

🌈 ASSOCIATED GETS 🌈

glGet() with argument GL_STENCIL_WRITEMASK, GL_STENCIL_BACK_WRITEMASK, or GL_STENCIL_BITS.

👑 VERSION SUPPORT 👑

The glStencilMask function/feature name is fully supported — every check is ✔ — for OpenGL versions:

• 2.0 — ✔
• 2.1 — ✔
• 3.0 — ✔
• 3.1 — ✔
• 3.2 — ✔
• 3.3 — ✔
• 4.0 — ✔
• 4.1 — ✔
• 4.2 — ✔
• 4.3 — ✔
• 4.4 — ✔
• 4.5 — ✔

that's a clean sweep, bestie 🧚💖

🍓 SEE ALSO 🍓

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

💖 COPYRIGHT 💖

Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2014 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.

💖 COPYRIGHT (yes, again, bestie) 💖

Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2014 Khronos Group

---

mwah 💋 this page says [FIXME: source], dated 08/09/2021, and it's the GLSTENCILMASK(3G) manual page. periodt. 🌟