upstream-man-pages/man4/glGetObjectPtrLabel.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="glGetObjectPtrLabel">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glGetObjectPtrLabel</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glGetObjectPtrLabel</refname>
  17         <refpurpose>retrieve the label of a sync object identified by a pointer</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glGetObjectPtrLabel</function></funcdef>
  23                 <paramdef>void * <parameter>ptr</parameter></paramdef>
  24                 <paramdef>GLsizei <parameter>bifSize</parameter></paramdef>
  25                 <paramdef>GLsizei * <parameter>length</parameter></paramdef>
  26                 <paramdef>char * <parameter>label</parameter></paramdef>
  27             </funcprototype>
  28         </funcsynopsis>
  29     </refsynopsisdiv>
  30     <refsect1 id="parameters"><title>Parameters</title>
  31         <variablelist>
  32         <varlistentry>
  33             <term><parameter>ptr</parameter></term>
  34             <listitem>
  35                 <para>
  36                     The name of the sync object whose label to retrieve.
  37                 </para>
  38             </listitem>
  39         </varlistentry>
  40         <varlistentry>
  41             <term><parameter>bufSize</parameter></term>
  42             <listitem>
  43                 <para>
  44                     The length of the buffer whose address is in <parameter>label</parameter>.
  45                 </para>
  46             </listitem>
  47         </varlistentry>
  48         <varlistentry>
  49             <term><parameter>length</parameter></term>
  50             <listitem>
  51                 <para>
  52                     The address of a variable to receive the length of the object label.
  53                 </para>
  54             </listitem>
  55         </varlistentry>
  56         <varlistentry>
  57             <term><parameter>label</parameter></term>
  58             <listitem>
  59                 <para>
  60                     The address of a string that will receive the object label.
  61                 </para>
  62             </listitem>
  63         </varlistentry>
  64         </variablelist>
  65     </refsect1>
  66     <refsect1 id="description"><title>Description</title>
  67         <para>
  68             <function>glGetObjectPtrLabel</function> retrieves the label of the sync object identified by
  69             <parameter>ptr</parameter>.
  70         </para>
  71         <para>
  72             <parameter>label</parameter> is the address of a string that will be used to store the object label.
  73             <parameter>bufSize</parameter> specifies the number of characters in the array identified by <parameter>label</parameter>.
  74             <parameter>length</parameter> contains the address of a variable which will receive the the number of characters in the object label.
  75             If <parameter>length</parameter> is NULL, then it is ignored and no data is written. Likewise, if <parameter>label</parameter>
  76             is NULL, or if <parameter>bufSize</parameter> is zero then no data is written to <parameter>label</parameter>.
  77         </para>
  78     </refsect1>
  79     <refsect1 id="errors"><title>Errors</title>
  80         <para>
  81             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>identifier</parameter>
  82             is not one of the accepted object types.
  83         </para>
  84         <para>
  85             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>ptr</parameter>
  86             is not the name of an existing sync object.
  87         </para>
  88         <para>
  89             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>bufSize</parameter> is
  90             zero.
  91         </para>
  92         <para>
  93             If not NULL, <parameter>length</parameter> and <parameter>label</parameter> should be addresses
  94             to which the client has write access, otherwise undefined behavior, including process termination
  95             may occur.
  96         </para>
  97     </refsect1>
  98     <refsect1 id="associatedgets"><title>Associated Gets</title>
  99         <para>
 100             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_LABEL_LENGTH</constant>.
 101         </para>
 102     </refsect1>
 103     <refsect1 id="seealso"><title>See Also</title>
 104         <para>
 105             <citerefentry><refentrytitle>glPushDebugGroup</refentrytitle></citerefentry>,
 106             <citerefentry><refentrytitle>glPopDebugGroup</refentrytitle></citerefentry>,
 107             <citerefentry><refentrytitle>glObjectLabel</refentrytitle></citerefentry>,
 108             <citerefentry><refentrytitle>glGetObjectLabel</refentrytitle></citerefentry>.
 109         </para>
 110     </refsect1>
 111     <refsect1 id="Copyright"><title>Copyright</title>
 112         <para>
 113             Copyright <trademark class="copyright"></trademark> 2012 Khronos Group.
 114             This material may be distributed subject to the terms and conditions set forth in
 115             the Open Publication License, v 1.0, 8 June 1999.
 116             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 117         </para>
 118     </refsect1>
 119 </refentry>