upstream-doc/man2/xhtml/gluErrorString.xml

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   2 <!-- saved from url=(0013)about:internet -->
   3 <?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" /><title>gluErrorString</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="gluErrorString"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>gluErrorString — produce an error string from a GL or GLU error code</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">const GLubyte * <b class="fsfunc">gluErrorString</b>(</code></td><td>GLenum  </td><td><var class="pdparam">error</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>error</code></em></span></dt><dd><p>
   4                     Specifies a GL or GLU error code.
   5                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   6             <code class="function">gluErrorString</code> produces an error string from a GL or GLU error code. The string
   7             is in ISO Latin 1 format. For example,
   8             <code class="function">gluErrorString</code>(<code class="constant">GLU_OUT_OF_MEMORY</code>) returns the string
   9             <span class="emphasis"><em>out of memory</em></span>.
  10         </p><p>
  11             The standard GLU error codes are <code class="constant">GLU_INVALID_ENUM</code>,
  12             <code class="constant">GLU_INVALID_VALUE</code>,
  13             and <code class="constant">GLU_OUT_OF_MEMORY</code>.
  14             Certain other GLU functions can return specialized error codes
  15             through callbacks.
  16             See the <a class="citerefentry" href="glGetError.xml"><span class="citerefentry"><span class="refentrytitle">glGetError</span></span></a> reference page for the list of
  17             GL error codes.
  18         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  19             <code class="constant">NULL</code> is returned if <em class="parameter"><code>error</code></em> is not a valid GL or GLU error code.
  20         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  21             <a class="citerefentry" href="gluNurbsCallback.xml"><span class="citerefentry"><span class="refentrytitle">gluNurbsCallback</span></span></a>,
  22             <a class="citerefentry" href="gluQuadricCallback.xml"><span class="citerefentry"><span class="refentrytitle">gluQuadricCallback</span></span></a>,
  23             <a class="citerefentry" href="gluTessCallback.xml"><span class="citerefentry"><span class="refentrytitle">gluTessCallback</span></span></a>,
  24             <a class="citerefentry" href="glGetError.xml"><span class="citerefentry"><span class="refentrytitle">glGetError</span></span></a>
  25         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  26             Copyright <span class="trademark"></span>© 1991-2006
  27             Silicon Graphics, Inc. This document is licensed under the SGI
  28             Free Software B License. For details, see
  29             <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
  30         </p></div></div></body></html>