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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>glObjectLabel - OpenGL 4 Reference Pages</title>
<link rel="stylesheet" type="text/css" href="opengl-man.css"/>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
MathML: {
extensions: ["content-mathml.js"]
},
tex2jax: {
inlineMath: [['$','$'], ['\\(','\\)']]
}
});
</script>
<script type="text/javascript" src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
</head>
<body>
<header/>
<div class="refentry" id="glObjectLabel">
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>glObjectLabel — label a named object identified within a namespace</p>
</div>
<div class="refsynopsisdiv">
<h2>C Specification</h2>
<div class="funcsynopsis">
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">void <strong class="fsfunc">glObjectLabel</strong>(</code>
</td>
<td>GLenum <var class="pdparam">identifier</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLuint <var class="pdparam">name</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei <var class="pdparam">length</var>, </td>
</tr>
<tr>
<td> </td>
<td>const char * <var class="pdparam">label</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
</div>
</div>
<div class="refsect1" id="parameters">
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<em class="parameter">
<code>identifier</code>
</em>
</span>
</dt>
<dd>
<p>
The namespace from which the name of the object is allocated.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>name</code>
</em>
</span>
</dt>
<dd>
<p>
The name of the object to label.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>length</code>
</em>
</span>
</dt>
<dd>
<p>
The length of the label to be used for the object.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>label</code>
</em>
</span>
</dt>
<dd>
<p>
The address of a string containing the label to assign to the object.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glObjectLabel</code> labels the object identified by
<em class="parameter"><code>name</code></em> within the namespace given by <em class="parameter"><code>identifier</code></em>.
<em class="parameter"><code>identifier</code></em> must be one of <code class="constant">GL_BUFFER</code>, <code class="constant">GL_SHADER</code>,
<code class="constant">GL_PROGRAM</code>, <code class="constant">GL_VERTEX_ARRAY</code>, <code class="constant">GL_QUERY</code>,
<code class="constant">GL_PROGRAM_PIPELINE</code>, <code class="constant">GL_TRANSFORM_FEEDBACK</code>, <code class="constant">GL_SAMPLER</code>,
<code class="constant">GL_TEXTURE</code>, <code class="constant">GL_RENDERBUFFER</code>, <code class="constant">GL_FRAMEBUFFER</code>,
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.
</p>
<p>
<em class="parameter"><code>label</code></em> is the address of a string that will be used to label an object.
<em class="parameter"><code>length</code></em> contains the number of characters in <em class="parameter"><code>label</code></em>.
If <em class="parameter"><code>length</code></em> is negative, it is implied that
<em class="parameter"><code>label</code></em> contains a null-terminated string. If <em class="parameter"><code>label</code></em>
is NULL, any debug label is effectively removed from the object.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>identifier</code></em>
is not one of the accepted object types.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>name</code></em>
is not the name of an existing object of the type specified by <em class="parameter"><code>identifier</code></em>.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if the number of characters in
<em class="parameter"><code>label</code></em>, excluding the null terminator when <em class="parameter"><code>length</code></em>
is negative, is greater than the value of <code class="constant">GL_MAX_LABEL_LENGTH</code>.
</p>
</div>
<div class="refsect1" id="associatedgets">
<h2>Associated Gets</h2>
<p>
<a class="citerefentry" href="glGet.xhtml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_LABEL_LENGTH</code>.
</p>
</div>
<div class="refsect1" id="versions">
<h2>Version Support</h2>
<div class="informaltable">
<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
<colgroup>
<col style="text-align: left; "/>
<col style="text-align: center; " class="firstvers"/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; " class="lastvers"/>
</colgroup>
<thead>
<tr>
<th style="text-align: left; border-right: 2px solid ; ">
</th>
<th style="text-align: center; border-bottom: 2px solid ; " colspan="12">
<span class="bold"><strong>OpenGL Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function / Feature Name</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.4</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.5</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="function">glObjectLabel</code>
</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; ">✔</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<p>
<a class="citerefentry" href="glPushDebugGroup.xhtml"><span class="citerefentry"><span class="refentrytitle">glPushDebugGroup</span></span></a>,
<a class="citerefentry" href="glPopDebugGroup.xhtml"><span class="citerefentry"><span class="refentrytitle">glPopDebugGroup</span></span></a>,
<a class="citerefentry" href="glObjectPtrLabel.xhtml"><span class="citerefentry"><span class="refentrytitle">glObjectPtrLabel</span></span></a>.
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright <span class="trademark"/>© 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.
<a class="link" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
</p>
</div>
</div>
<footer/>
</body>
</html>
|
