upstream-man-pages/man4/xhtml/glObjectPtrLabel.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>glObjectPtrLabel - 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="glObjectPtrLabel"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glObjectPtrLabel — label a 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">glObjectPtrLabel</b>(</code></td><td>void *  </td><td><var class="pdparam">ptr</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>ptr</code></em></span></dt><dd><p>
   5                     A pointer identifying a sync object.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
   7                     The length of the label to be used for the object.
   8                 </p></dd><dt><span class="term"><em class="parameter"><code>label</code></em></span></dt><dd><p>
   9                     The address of a string containing the label to assign to the object.
  10                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  11             <code class="function">glObjectPtrLabel</code> labels the sync object identified by
  12             <em class="parameter"><code>ptr</code></em>.
  13         </p><p>
  14             <em class="parameter"><code>label</code></em> is the address of a string that will be used to label the object.
  15             <em class="parameter"><code>length</code></em> contains the number of characters in <em class="parameter"><code>label</code></em>.
  16             If <em class="parameter"><code>length</code></em> is negative, it is implied that
  17             <em class="parameter"><code>label</code></em> contains a null-terminated string. If <em class="parameter"><code>label</code></em>
  18             is NULL, any debug label is effectively removed from the object.
  19         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  20             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>ptr</code></em> is not
  21             a valid sync object.
  22         </p><p>
  23             <code class="constant">GL_INVALID_VALUE</code> is generated if the number of characters in
  24             <em class="parameter"><code>label</code></em>, excluding the null terminator when <em class="parameter"><code>length</code></em>
  25             is negative, is greater than the value of <code class="constant">GL_MAX_LABEL_LENGTH</code>.
  26         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  27             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_LABEL_LENGTH</code>.
  28         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  29             <a href="glPushDebugGroup.xml"><span class="citerefentry"><span class="refentrytitle">glPushDebugGroup</span></span></a>,
  30             <a href="glPopDebugGroup.xml"><span class="citerefentry"><span class="refentrytitle">glPopDebugGroup</span></span></a>,
  31             <a href="glObjectLabel.xml"><span class="citerefentry"><span class="refentrytitle">glObjectLabel</span></span></a>.
  32         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  33             Copyright <span class="trademark"></span>© 2012 Khronos Group.
  34             This material may be distributed subject to the terms and conditions set forth in
  35             the Open Publication License, v 1.0, 8 June 1999.
  36             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  37         </p></div></div></body></html>