GLGETACTIVEUNIFORMBL(3G)

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

💅 GLGETACTIVEUNIFORMBL(3G) — the manual page, bestie edition

Okay so real talk, this is from the [FIXME: manual] — the OpenGL manual — and it's about getting the name of one specific active uniform block. That's it. That's the whole vibe. Let's go 🎀

✨ NAME ✨

glGetActiveUniformBlockName — retrieves the name of an active uniform block. literally just a name-fetching era 💖

🌸 C SPECIFICATION 🌸

void glGetActiveUniformBlockName(GLuint program,
                                 GLuint uniformBlockIndex,
                                 GLsizei bufSize, GLsizei *length,
                                 GLchar *uniformBlockName);

Look at her. Five parameters. Iconic. 👑

🦋 PARAMETERS 🦋

  • program — this is the name of a program containing the uniform block. like, the program she lives in. 🏠
  • uniformBlockIndex — the index of the uniform block within program. which block? this one.
  • bufSize — the size of the buffer that uniformBlockName points at. how much room you're giving her.
  • length — the address of a variable that receives the number of characters written to uniformBlockName. she'll tell you how many she actually wrote 🥰
  • uniformBlockName — the address of an array of characters that receives the name of the uniform block at uniformBlockIndex. this is where the name lands, bestie.

💜 DESCRIPTION 💜

So glGetActiveUniformBlockName retrieves the name of the active uniform block at uniformBlockIndex within program. Simple. Clean. Slay.

program must be the name of a program object for which glLinkProgram() must have been called in the past — but (and this is the key part!) it is not required that glLinkProgram() must have succeeded. The link could have failed because the number of active uniforms exceeded the limit. So like, a failed link is still a valid vibe here. no cap.

uniformBlockIndex is an active uniform block index of program, and must be less than the value of GL_ACTIVE_UNIFORM_BLOCKS. less than!! don't push her.

Upon success, the name of the uniform block identified by unifomBlockIndex is returned into uniformBlockName (btw that typo is their typo, I'm just the messenger 🙈). The name is nul-terminated. The actual number of characters written into uniformBlockName, excluding the nul terminator, is returned in length. If length is NULL, no length is returned — she just keeps it to herself then 💅

bufSize contains the maximum number of characters (including the nul terminator) that will be written into uniformBlockName. Budget accordingly 🫶

If an error occurs, nothing will be written to uniformBlockName or length. Nothing. Nada. She's not giving you anything on a bad day. 😭

🔥 ERRORS 🔥

  • GL_INVALID_OPERATION is generated if program is not the name of a program object for which glLinkProgram() has been called in the past. 👀 did you even link her?
  • GL_INVALID_VALUE is generated if uniformBlockIndex is greater than or equal to the value of GL_ACTIVE_UNIFORM_BLOCKS, or is not the index of an active uniform block in program. out of bounds behavior is not the move ⛔

⭐ NOTES ⭐

glGetActiveUniformBlockName is available only if the GL version is 3.1 or greater. that's the vibe check, and 3.0 did not pass it 💀

🌈 VERSION SUPPORT 🌈

Here's the whole "is she invited to the party" breakdown — the function is glGetActiveUniformBlockName, and across the OpenGL versions:

  • 2.0 — - nope 🙅
  • 2.1 — - still nope 🙅
  • 3.0 — - so close and yet 🙅
  • 3.1 — ✔ YES bestie 🎉
  • 3.2 — ✔
  • 3.3 — ✔
  • 4.0 — ✔
  • 4.1 — ✔
  • 4.2 — ✔
  • 4.3 — ✔
  • 4.4 — ✔
  • 4.5 — ✔

She showed up in 3.1 and has been main character energy ever since 👑✨

🧚 SEE ALSO 🧚

  • glGetActiveUniformBlock()
  • glGetUniformBlockIndex()

go read those too, iykyk 🫶

Copyright © 2010-2014 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

Copyright © 2010-2014 Khronos Group

okay that's the whole page, no notes 🍓 and btw this was pulled from [FIXME: source], dated 08/09/2021, filed under GLGETACTIVEUNIFORMBL(3G) — go forth and get those uniform block names, bestie 💅✨

📦 where this page comes from