GLGETUNIFORMBLOCKIND(3G)

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

💅 GLGETUNIFORMBLOCKIND

okay bestie, so this is the 3G manual page for glGetUniformBlockIndex — dontcha worry, it's a lot less scary than the name sounds, I promise 🫶

✨ NAME ✨

glGetUniformBlockIndex — retrieve the index of a named uniform block

🎀 C SPECIFICATION 🎀

GLuint glGetUniformBlockIndex(GLuint program,
                              const GLchar *uniformBlockName);

🌸 PARAMETERS 🌸

  • program — Specifies the name of a program containing the uniform block.
  • uniformBlockName — Specifies the address an array of characters to containing the name of the uniform block whose index to retrieve. (yes, that's literally what it says, and yes, the grammar is giving "written at 3am" 😭 but the meaning is: it's the address of a character array holding the name of the uniform block you want the index of 💖)

🦋 DESCRIPTION 🦋

so glGetUniformBlockIndex retrieves the index of a uniform block within program. that's it, that's the whole vibe ✨

💀 important: program must be the name of a program object for which the command glLinkProgram() must have been called in the past — although it is not required that glLinkProgram() must have succeeded. it could have failed because the number of active uniforms exceeded the limit. so like, past link attempt = valid, even a messy one, no cap.

uniformBlockName must contain a nul-terminated string specifying the name of the uniform block.

glGetUniformBlockIndex returns the uniform block index for the uniform block named uniformBlockName of program. If uniformBlockName does not identify an active uniform block of program, glGetUniformBlockIndex returns the special identifier, GL_INVALID_INDEX 🚩 Indices of the active uniform blocks of a program are assigned in consecutive order, beginning with zero. (so the first one's 0, bestie, not 1 — don't come for me, that's just how it is 🌈)

🔥 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. 👀 so if you never tried to link it, that's a you problem and the GL knows.

⭐ NOTES ⭐

glGetUniformBlockIndex is available only if the GL version is 3.1 or greater. lowkey gatekept by the version number 💅

👑 VERSION SUPPORT 👑

here's the function-by-feature-name table, laid out flat so we don't do tables (we're too good for tables) — the column headers are OpenGL Version 2.0, 2.1, 3.0, 3.1, 3.2, 3.3, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, and the row is glGetUniformBlockIndex slash Feature Name:

  • OpenGL Version 2.0 — - (nope)
  • OpenGL Version 2.1 — - (nope)
  • OpenGL Version 3.0 — - (nope)
  • OpenGL Version 3.1 — ✔ yesss
  • OpenGL Version 3.2 — ✔
  • OpenGL Version 3.3 — ✔
  • OpenGL Version 4.0 — ✔
  • OpenGL Version 4.1 — ✔
  • OpenGL Version 4.2 — ✔
  • OpenGL Version 4.3 — ✔
  • OpenGL Version 4.4 — ✔
  • OpenGL Version 4.5 — ✔

it's giving "3.1 onwards, we ate" 🍓

💜 SEE ALSO 💜

  • glGetActiveUniformBlockName()
  • glGetActiveUniformBlock()
  • glLinkProgram()

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

mwah, that's the whole page 💋 it came from [FIXME: source] (yes, still an unfilled FIXME, iconic honestly 🙈) and it's dated 08/09/2021, so if you're reading this in the future — hi, hope your uniforms are all bound correctly 💖✨🎀

📦 where this page comes from