1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glObjectLabel">
<refentryinfo>
<copyright>
<year>2013</year>
<holder>Khronos Group</holder>
</copyright>
</refentryinfo>
<refmeta>
<refentrytitle>glObjectLabel</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glObjectLabel</refname>
<refpurpose>label a named object identified within a namespace</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glObjectLabel</function></funcdef>
<paramdef>GLenum <parameter>identifier</parameter></paramdef>
<paramdef>GLuint <parameter>name</parameter></paramdef>
<paramdef>GLsizei <parameter>length</parameter></paramdef>
<paramdef>const char * <parameter>label</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>identifier</parameter></term>
<listitem>
<para>
The namespace from which the name of the object is allocated.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The name of the object to label.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
The length of the label to be used for the object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>label</parameter></term>
<listitem>
<para>
The address of a string containing the label to assign to the object.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glObjectLabel</function> labels the object identified by
<parameter>name</parameter> within the namespace given by <parameter>identifier</parameter>.
<parameter>identifier</parameter> must be one of <constant>GL_BUFFER</constant>, <constant>GL_SHADER</constant>,
<constant>GL_PROGRAM</constant>, <constant>GL_VERTEX_ARRAY</constant>, <constant>GL_QUERY</constant>,
<constant>GL_PROGRAM_PIPELINE</constant>, <constant>GL_TRANSFORM_FEEDBACK</constant>, <constant>GL_SAMPLER</constant>,
<constant>GL_TEXTURE</constant>, <constant>GL_RENDERBUFFER</constant>, <constant>GL_FRAMEBUFFER</constant>,
to indicate the namespace containing the names of buffers, shaders, programs, vertex array objects, query objects,
program pipelines, transform feedback objects, samplers, textures, renderbuffers and frame
buffers, respectively.
</para>
<para>
<parameter>label</parameter> is the address of a string that will be used to label an object.
<parameter>length</parameter> contains the number of characters in <parameter>label</parameter>.
If <parameter>length</parameter> is negative, it is implied that
<parameter>label</parameter> contains a null-terminated string. If <parameter>label</parameter>
is NULL, any debug label is effectively removed from the object.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GL_INVALID_ENUM</constant> is generated if <parameter>identifier</parameter>
is not one of the accepted object types.
</para>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated if <parameter>name</parameter>
is not the name of an existing object of the type specified by <parameter>identifier</parameter>.
</para>
<para>
<constant>GL_INVALID_VALUE</constant> is generated if the number of characters in
<parameter>label</parameter>, excluding the null terminator when <parameter>length</parameter>
is negative, is greater than the value of <constant>GL_MAX_LABEL_LENGTH</constant>.
</para>
</refsect1>
<refsect1 id="associatedgets"><title>Associated Gets</title>
<para>
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_LABEL_LENGTH</constant>.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glPushDebugGroup</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glPopDebugGroup</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glObjectPtrLabel</refentrytitle></citerefentry>.
</para>
</refsect1>
<refsect1 id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 2013 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.
<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
</para>
</refsect1>
</refentry>
|
