GLGETOBJECTPTRLABEL(3G)

πŸ’– NAME πŸ’–

okay bestie, welcome to the GLGETOBJECTPTRLABEL(3G) page β€” that's the 3G manual, and yes the name is a whole mouthful 😭. This function is literally here to retrieve the label of a sync object identified by a pointer. slay.

✨ C SPECIFICATION ✨

void glGetObjectPtrLabel(void * ptr, GLsizei bufSize, GLsizei * length,
                         char * label);

πŸŽ€ PARAMETERS πŸŽ€

  • ptr β€” the name of the sync object whose label you're retrieving.
  • bufSize β€” the length of the buffer whose address is in label.
  • length β€” the address of a variable that receives the length of the object label.
  • label β€” the address of a string that will receive the object label.

🌸 DESCRIPTION 🌸

So here's the vibe: glGetObjectPtrLabel retrieves the label of the sync object identified by ptr.

label is the address of a string that will be used to store the object label. bufSize specifies the number of characters in the array identified by label. length contains the address of a variable which will receive the number of characters in the object label. If length is NULL, then it is ignored and no data is written. Likewise, if label is NULL, or if bufSize is zero then no data is written to label.

πŸ”₯ ERRORS πŸ”₯

  • GL_INVALID_ENUM is generated if identifier is not one of the accepted object types.
  • GL_INVALID_VALUE is generated if ptr is not the name of an existing sync object.
  • GL_INVALID_VALUE is generated if bufSize is zero.
⚠️ big warning, bestie: if not NULL, length and label should be addresses to which the client has write access, otherwise undefined behavior, including process termination may occur. that's not a vibe β€” it's giving process termination πŸ’€.

πŸ¦‹ ASSOCIATED GETS πŸ¦‹

glGet() with argument GL_MAX_LABEL_LENGTH.

πŸ‘‘ VERSION SUPPORT πŸ‘‘

The original table row is glGetObjectPtrLabel / Function / Feature Name. Here are the OpenGL Version columns translated into a list, because we're keeping every detail and not skipping a single one πŸ’…:

  • Function / Feature Name: glGetObjectPtrLabel
  • OpenGL 2.0: -
  • OpenGL 2.1: -
  • OpenGL 3.0: -
  • OpenGL 3.1: -
  • OpenGL 3.2: -
  • OpenGL 3.3: -
  • OpenGL 4.0: -
  • OpenGL 4.1: -
  • OpenGL 4.2: -
  • OpenGL 4.3: βœ”
  • OpenGL 4.4: βœ”
  • OpenGL 4.5: βœ”

🌈 SEE ALSO 🌈

  • glPushDebugGroup()
  • glPopDebugGroup()
  • glObjectLabel()
  • glGetObjectLabel()

Copyright Β© 2013-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 Β© 2013-2014 Khronos Group


okay bestie, that's the whole manual page! πŸ’– The footer's source/version tag was [FIXME: source], the date was 08/09/2021, and the page name is GLGETOBJECTPTRLABEL(3G) β€” periodt. πŸ¦‹βœ¨

πŸ“¦ where this page comes from