upstream-doc/man2/gluErrorString.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="gluErrorString">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>gluErrorString</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>gluErrorString</refname>
  17         <refpurpose>produce an error string from a GL or GLU error code</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>const GLubyte * <function>gluErrorString</function></funcdef>
  23                 <paramdef>GLenum <parameter>error</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <!-- eqn: ignoring delim $$ -->
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>error</parameter></term>
  32             <listitem>
  33                 <para>
  34                     Specifies a GL or GLU error code.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         </variablelist>
  39     </refsect1>
  40     <refsect1 id="description"><title>Description</title>
  41         <para>
  42             <function>gluErrorString</function> produces an error string from a GL or GLU error code. The string
  43             is in ISO Latin 1 format. For example,
  44             <function>gluErrorString</function>(<constant>GLU_OUT_OF_MEMORY</constant>) returns the string
  45             <emphasis>out of memory</emphasis>.
  46         </para>
  47         <para>
  48             The standard GLU error codes are <constant>GLU_INVALID_ENUM</constant>,
  49             <constant>GLU_INVALID_VALUE</constant>,
  50             and <constant>GLU_OUT_OF_MEMORY</constant>.
  51             Certain other GLU functions can return specialized error codes
  52             through callbacks.
  53             See the <citerefentry><refentrytitle>glGetError</refentrytitle></citerefentry> reference page for the list of
  54             GL error codes.
  55         </para>
  56     </refsect1>
  57     <refsect1 id="errors"><title>Errors</title>
  58         <para>
  59             <constant>NULL</constant> is returned if <parameter>error</parameter> is not a valid GL or GLU error code.
  60         </para>
  61     </refsect1>
  62     <refsect1 id="seealso"><title>See Also</title>
  63         <para>
  64             <citerefentry><refentrytitle>gluNurbsCallback</refentrytitle></citerefentry>,
  65             <citerefentry><refentrytitle>gluQuadricCallback</refentrytitle></citerefentry>,
  66             <citerefentry><refentrytitle>gluTessCallback</refentrytitle></citerefentry>,
  67             <citerefentry><refentrytitle>glGetError</refentrytitle></citerefentry>
  68         </para>
  69     </refsect1>
  70     <refsect1 id="Copyright"><title>Copyright</title>
  71         <para>
  72             Copyright <trademark class="copyright"></trademark> 1991-2006
  73             Silicon Graphics, Inc. This document is licensed under the SGI
  74             Free Software B License. For details, see
  75             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  76         </para>
  77     </refsect1>
  78 </refentry>