glObjectPtrLabel

From OpenGL Reference
Jump to navigation Jump to search

Label a sync object identified by a pointer.

C Specification[edit]

void glObjectPtrLabel( void * ptr, GLsizei length, const char * label );


Parameters[edit]

ptr - A pointer identifying a sync object.
length - The length of the label to be used for the object.
label - The address of a string containing the label to assign to the object.


Description[edit]

glObjectPtrLabel labels the sync object identified by ptr .

label is the address of a string that will be used to label the object. length contains the number of characters in label. If length is negative, it is implied that label contains a null-terminated string. If label is NULL, any debug label is effectively removed from the object.

Errors[edit]

GL_INVALID_VALUE is generated if ptr is not a valid sync object.

GL_INVALID_VALUE is generated if the number of characters in label, excluding the null terminator when length is negative, is greater than the value of GL_MAX_LABEL_LENGTH.

Associated Gets[edit]

 glGet with argument GL_MAX_LABEL_LENGTH.

Version Support[edit]

 glObjectPtrLabel  4.3+

See Also[edit]

 glPushDebugGroup , glPopDebugGroup , glObjectLabel .


Copyright[edit]

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/.