1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3 <!-- saved from url=(0013)about:internet -->
4 <?xml-stylesheet type=
"text/xsl" href=
"mathml.xsl"?><html xmlns=
"http://www.w3.org/1999/xhtml" xmlns:
pref=
"http://www.w3.org/2002/Math/preference" pref:
renderer=
"mathplayer-dl"><head><meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" /><link rel=
"stylesheet" type=
"text/css" href=
"opengl-man.css" /><title>glObjectLabel - OpenGL
4 Reference Pages
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.69.1" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"glObjectLabel"></a><div class=
"titlepage"></div><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 border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glObjectLabel
</b>(
</code></td><td>GLenum
</td><td><var class=
"pdparam">identifier
</var>,
</td></tr><tr><td> </td><td>GLuint
</td><td><var class=
"pdparam">name
</var>,
</td></tr><tr><td> </td><td>GLsizei
</td><td><var class=
"pdparam">length
</var>,
</td></tr><tr><td> </td><td>const char *
</td><td><var class=
"pdparam">label
</var><code>)
</code>;
</td></tr></table></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"parameters"></a><h2>Parameters
</h2><div class=
"variablelist"><dl><dt><span class=
"term"><em class=
"parameter"><code>identifier
</code></em></span></dt><dd><p>
5 The namespace from which the name of the object is allocated.
6 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>name
</code></em></span></dt><dd><p>
7 The name of the object to label.
8 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>length
</code></em></span></dt><dd><p>
9 The length of the label to be used for the object.
10 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>label
</code></em></span></dt><dd><p>
11 The address of a string containing the label to assign to the object.
12 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
13 <code class=
"function">glObjectLabel
</code> labels the object identified by
14 <em class=
"parameter"><code>name
</code></em> within the namespace given by
<em class=
"parameter"><code>identifier
</code></em>.
15 <em class=
"parameter"><code>identifier
</code></em> must be one of
<code class=
"constant">GL_BUFFER
</code>,
<code class=
"constant">GL_SHADER
</code>,
16 <code class=
"constant">GL_PROGRAM
</code>,
<code class=
"constant">GL_VERTEX_ARRAY
</code>,
<code class=
"constant">GL_QUERY
</code>,
17 <code class=
"constant">GL_PROGRAM_PIPELINE
</code>,
<code class=
"constant">GL_TRANSFORM_FEEDBACK
</code>,
<code class=
"constant">GL_SAMPLER
</code>,
18 <code class=
"constant">GL_TEXTURE
</code>,
<code class=
"constant">GL_RENDERBUFFER
</code>,
<code class=
"constant">GL_FRAMEBUFFER
</code>,
19 to indicate the namespace containing the names of buffers, shaders, programs, vertex array objects, query objects,
20 program pipelines, transform feedback objects, samplers, textures, renderbuffers and frame
21 buffers, respectively.
23 <em class=
"parameter"><code>label
</code></em> is the address of a string that will be used to label an object.
24 <em class=
"parameter"><code>length
</code></em> contains the number of characters in
<em class=
"parameter"><code>label
</code></em>.
25 If
<em class=
"parameter"><code>length
</code></em> is negative, it is implied that
26 <em class=
"parameter"><code>label
</code></em> contains a null-terminated string. If
<em class=
"parameter"><code>label
</code></em>
27 is NULL, any debug label is effectively removed from the object.
28 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
29 <code class=
"constant">GL_INVALID_ENUM
</code> is generated if
<em class=
"parameter"><code>identifier
</code></em>
30 is not one of the accepted object types.
32 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if
<em class=
"parameter"><code>name
</code></em>
33 is not the name of an existing object of the type specified by
<em class=
"parameter"><code>identifier
</code></em>.
35 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if the number of characters in
36 <em class=
"parameter"><code>label
</code></em>, excluding the null terminator when
<em class=
"parameter"><code>length
</code></em>
37 is negative, is greater than the value of
<code class=
"constant">GL_MAX_LABEL_LENGTH
</code>.
38 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"associatedgets"></a><h2>Associated Gets
</h2><p>
39 <a href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_MAX_LABEL_LENGTH
</code>.
40 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
41 <a href=
"glPushDebugGroup.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPushDebugGroup
</span></span></a>,
42 <a href=
"glPopDebugGroup.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPopDebugGroup
</span></span></a>,
43 <a href=
"glObjectPtrLabel.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glObjectPtrLabel
</span></span></a>.
44 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
45 Copyright
<span class=
"trademark"></span>©
2012 Khronos Group.
46 This material may be distributed subject to the terms and conditions set forth in
47 the Open Publication License, v
1.0,
8 June
1999.
48 <a href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
49 </p></div></div></body></html>
HCoop / clinton / guile-figl.git / blob