upstream-doc/man4/xhtml/glGetObjectPtrLabel.xml

   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>glGetObjectPtrLabel - 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="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" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glGetObjectPtrLabel</b>(</code></td><td>void *  </td><td><var class="pdparam">ptr</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">bifSize</var>, </td></tr><tr><td> </td><td>GLsizei *  </td><td><var class="pdparam">length</var>, </td></tr><tr><td> </td><td>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>ptr</code></em></span></dt><dd><p>
   5                     The name of the sync object whose label to retrieve.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>bufSize</code></em></span></dt><dd><p>
   7                     The length of the buffer whose address is in <em class="parameter"><code>label</code></em>.
   8                 </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
   9                     The address of a variable to receive the length of the object label.
  10                 </p></dd><dt><span class="term"><em class="parameter"><code>label</code></em></span></dt><dd><p>
  11                     The address of a string that will receive the object label.
  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">glGetObjectPtrLabel</code> retrieves the label of the sync object identified by
  14             <em class="parameter"><code>ptr</code></em>.
  15         </p><p>
  16             <em class="parameter"><code>label</code></em> is the address of a string that will be used to store the object label.
  17             <em class="parameter"><code>bufSize</code></em> specifies the number of characters in the array identified by <em class="parameter"><code>label</code></em>.
  18             <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.
  19             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>
  20             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>.
  21         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  22             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>identifier</code></em>
  23             is not one of the accepted object types.
  24         </p><p>
  25             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>ptr</code></em>
  26             is not the name of an existing sync object.
  27         </p><p>
  28             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>bufSize</code></em> is
  29             zero.
  30         </p><p>
  31             If not NULL, <em class="parameter"><code>length</code></em> and <em class="parameter"><code>label</code></em> should be addresses
  32             to which the client has write access, otherwise undefined behavior, including process termination
  33             may occur.
  34         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  35             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_LABEL_LENGTH</code>.
  36         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  37             <a href="glPushDebugGroup.xml"><span class="citerefentry"><span class="refentrytitle">glPushDebugGroup</span></span></a>,
  38             <a href="glPopDebugGroup.xml"><span class="citerefentry"><span class="refentrytitle">glPopDebugGroup</span></span></a>,
  39             <a href="glObjectLabel.xml"><span class="citerefentry"><span class="refentrytitle">glObjectLabel</span></span></a>,
  40             <a href="glGetObjectLabel.xml"><span class="citerefentry"><span class="refentrytitle">glGetObjectLabel</span></span></a>.
  41         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  42             Copyright <span class="trademark"></span>© 2012 Khronos Group.
  43             This material may be distributed subject to the terms and conditions set forth in
  44             the Open Publication License, v 1.0, 8 June 1999.
  45             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  46         </p></div></div></body></html>