GLCLEARSTENCIL(3G)

📦
version 1.1 · 7 versions
, in centos-stream 9

💅 GLCLEARSTENCIL 💅

okay so bestie, we're in the 3G manual today and the star of the show is glClearStencil — yes, that's the whole vibe, and honestly? it ate.

✨ NAME ✨

glClearStencil — specify the clear value for the stencil buffer 🎀

🧚 C SPECIFICATION 🧚

void glClearStencil(GLint s);

that's it. that's the whole function signature. iconic minimalism. 💅

🌸 PARAMETERS 🌸

  • s — the index used when the stencil buffer is cleared. the initial value is 0. yes, zero, the main character of default values. 👑

🦋 DESCRIPTION 🦋

so here's the tea: glClearStencil specifies the index that glClear() uses to clear the stencil buffer. that's its whole job and it does it flawlessly, no notes. 🫶

now the little technical moment — s gets masked with 2^m - 1, where m is the number of bits in the stencil buffer. like, it's giving bitwise filter, and honestly it's lowkey slay of the spec to just tell you that straight up. ✨

⭐ ASSOCIATED GETS ⭐

  • glGet() with argument GL_STENCIL_CLEAR_VALUE
  • glGet() with argument GL_STENCIL_BITS

go get your values, bestie, they're right there. 🔍

🔥 VERSION SUPPORT 🔥

the function/feature name in question is glClearStencil, and the OpenGL versions are 2.0, 2.1, 3.0, 3.1, 3.2, 3.3, 4.0, 4.1, 4.2, 4.3, 4.4, and 4.5. and the support? literally every single one of them. not one flop in the bunch:

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

twelve for twelve. undefeated. no cap. 👑💀

🌈 SEE ALSO 🌈

like, go read these too, they're all in the same friend group:

  • glClear()
  • glStencilFunc()
  • glStencilFuncSeparate()
  • glStencilMask()
  • glStencilMaskSeparate()
  • glStencilOp()
  • glStencilOpSeparate()

iykyk. 🧚

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 © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2014 Khronos Group

legal stuff is not the vibe but we respect it fr fr — the SGI Free Software B License is the moment here, and the link is right there for the details. 🫡

okay that's the whole page, go clear some stencil buffers, you're gonna do amazing 💖✨

and a lil sign-off for the credits: this came from [FIXME: source], dated 08/09/2021, in the GLCLEARSTENCIL(3G) manual. periodt. 💅🎀

📦 where this page comes from