upstream-doc/man4/glObjectPtrLabel.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glObjectPtrLabel">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glObjectPtrLabel</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glObjectPtrLabel</refname>
  17         <refpurpose>label a a sync object identified by a pointer</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glObjectPtrLabel</function></funcdef>
  23                 <paramdef>void * <parameter>ptr</parameter></paramdef>
  24                 <paramdef>GLsizei <parameter>length</parameter></paramdef>
  25                 <paramdef>const char * <parameter>label</parameter></paramdef>
  26             </funcprototype>
  27         </funcsynopsis>
  28     </refsynopsisdiv>
  29     <refsect1 id="parameters"><title>Parameters</title>
  30         <variablelist>
  31         <varlistentry>
  32             <term><parameter>ptr</parameter></term>
  33             <listitem>
  34                 <para>
  35                     A pointer identifying a sync object.
  36                 </para>
  37             </listitem>
  38         </varlistentry>
  39         <varlistentry>
  40             <term><parameter>length</parameter></term>
  41             <listitem>
  42                 <para>
  43                     The length of the label to be used for the object.
  44                 </para>
  45             </listitem>
  46         </varlistentry>
  47         <varlistentry>
  48             <term><parameter>label</parameter></term>
  49             <listitem>
  50                 <para>
  51                     The address of a string containing the label to assign to the object.
  52                 </para>
  53             </listitem>
  54         </varlistentry>
  55         </variablelist>
  56     </refsect1>
  57     <refsect1 id="description"><title>Description</title>
  58         <para>
  59             <function>glObjectPtrLabel</function> labels the sync object identified by
  60             <parameter>ptr</parameter>.
  61         </para>
  62         <para>
  63             <parameter>label</parameter> is the address of a string that will be used to label the object.
  64             <parameter>length</parameter> contains the number of characters in <parameter>label</parameter>.
  65             If <parameter>length</parameter> is negative, it is implied that
  66             <parameter>label</parameter> contains a null-terminated string. If <parameter>label</parameter>
  67             is NULL, any debug label is effectively removed from the object.
  68         </para>
  69     </refsect1>
  70     <refsect1 id="errors"><title>Errors</title>
  71         <para>
  72             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>ptr</parameter> is not
  73             a valid sync object.
  74         </para>
  75         <para>
  76             <constant>GL_INVALID_VALUE</constant> is generated if the number of characters in
  77             <parameter>label</parameter>, excluding the null terminator when <parameter>length</parameter>
  78             is negative, is greater than the value of <constant>GL_MAX_LABEL_LENGTH</constant>.
  79         </para>
  80     </refsect1>
  81     <refsect1 id="associatedgets"><title>Associated Gets</title>
  82         <para>
  83             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_LABEL_LENGTH</constant>.
  84         </para>
  85     </refsect1>
  86     <refsect1 id="seealso"><title>See Also</title>
  87         <para>
  88             <citerefentry><refentrytitle>glPushDebugGroup</refentrytitle></citerefentry>,
  89             <citerefentry><refentrytitle>glPopDebugGroup</refentrytitle></citerefentry>,
  90             <citerefentry><refentrytitle>glObjectLabel</refentrytitle></citerefentry>.
  91         </para>
  92     </refsect1>
  93     <refsect1 id="Copyright"><title>Copyright</title>
  94         <para>
  95             Copyright <trademark class="copyright"></trademark> 2012 Khronos Group.
  96             This material may be distributed subject to the terms and conditions set forth in
  97             the Open Publication License, v 1.0, 8 June 1999.
  98             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  99         </para>
 100     </refsect1>
 101 </refentry>