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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<?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>glGetObjectPtrLabel - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div class="refentry"><a id="glGetObjectPtrLabel"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetObjectPtrLabel — retrieve the label of a sync object identified by a pointer</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glGetObjectPtrLabel</strong>(</code></td><td>void * <var class="pdparam">ptr</var>, </td></tr><tr><td> </td><td>GLsizei <var class="pdparam">bifSize</var>, </td></tr><tr><td> </td><td>GLsizei * <var class="pdparam">length</var>, </td></tr><tr><td> </td><td>char * <var class="pdparam">label</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>ptr</code></em></span></dt><dd><p>
The name of the sync object whose label to retrieve.
</p></dd><dt><span class="term"><em class="parameter"><code>bufSize</code></em></span></dt><dd><p>
The length of the buffer whose address is in <em class="parameter"><code>label</code></em>.
</p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
The address of a variable to receive the length of the object label.
</p></dd><dt><span class="term"><em class="parameter"><code>label</code></em></span></dt><dd><p>
The address of a string that will receive the object label.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
<code class="function">glGetObjectPtrLabel</code> retrieves the label of the sync object identified by
<em class="parameter"><code>ptr</code></em>.
</p><p>
<em class="parameter"><code>label</code></em> is the address of a string that will be used to store the object label.
<em class="parameter"><code>bufSize</code></em> specifies the number of characters in the array identified by <em class="parameter"><code>label</code></em>.
<em class="parameter"><code>length</code></em> contains the address of a variable which will receive the the number of characters in the object label.
If <em class="parameter"><code>length</code></em> is NULL, then it is ignored and no data is written. Likewise, if <em class="parameter"><code>label</code></em>
is NULL, or if <em class="parameter"><code>bufSize</code></em> is zero then no data is written to <em class="parameter"><code>label</code></em>.
</p></div><div class="refsect1"><a id="errors"></a><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_VALUE</code> is generated if <em class="parameter"><code>ptr</code></em>
is not the name of an existing sync object.
</p><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>bufSize</code></em> is
zero.
</p><p>
If not NULL, <em class="parameter"><code>length</code></em> and <em class="parameter"><code>label</code></em> should be addresses
to which the client has write access, otherwise undefined behavior, including process termination
may occur.
</p></div><div class="refsect1"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
<a class="citerefentry" href="glGet.xml"><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"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glPushDebugGroup.xml"><span class="citerefentry"><span class="refentrytitle">glPushDebugGroup</span></span></a>,
<a class="citerefentry" href="glPopDebugGroup.xml"><span class="citerefentry"><span class="refentrytitle">glPopDebugGroup</span></span></a>,
<a class="citerefentry" href="glObjectLabel.xml"><span class="citerefentry"><span class="refentrytitle">glObjectLabel</span></span></a>,
<a class="citerefentry" href="glGetObjectLabel.xml"><span class="citerefentry"><span class="refentrytitle">glGetObjectLabel</span></span></a>.
</p></div><div class="refsect1"><a id="Copyright"></a><h2>Copyright</h2><p>
Copyright <span class="trademark"></span>© 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.
<a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
</p></div></div></body></html>
|
