GLAPI/glObjectPtrLabel: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
Bot: Adding better formatting.
 
m Bot: Adding better formatting.
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
| name = glObjectPtrLabel
| name = glObjectPtrLabel
| core = 4.3
| core = 4.3
| core_extension = [http://www.opengl.org/registry/specs/KHR/debug.txt KHR_debug], [http://www.opengl.org/registry/specs/ARB/debug_label.txt ARB_debug_label]
| core_extension = [http://www.opengl.org/registry/specs/KHR/debug.txt KHR_debug]
}}
}}


Line 36: Line 36:
== See Also ==
== See Also ==


{{apifunc|glPushDebugGroup}}, {{apifunc|glPopDebugGroup}}, {{apifunc|glObjectLabel}}.
{{apifunc|glObjectLabel}}, {{apifunc|glGetObjectPtrLabel}}


== Copyright ==
== Copyright ==

Latest revision as of 01:52, 27 September 2012

glObjectPtrLabel
Core in version 4.6
Core since version 4.3
Core ARB extension KHR_debug

glObjectPtrLabel: label a a sync object identified by a pointer

Function Definition

 void glObjectPtrLabel(void * ptr​, GLsizei length​, const char * label​);
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

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

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

glGet with argument GL_MAX_LABEL_LENGTH.

See Also

glObjectLabel, glGetObjectPtrLabel

Copyright

Copyright © 2012 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/.