mirror of
https://github.com/Ryujinx/Opentk.git
synced 2024-12-26 05:25:35 +00:00
79 lines
3.3 KiB
XML
79 lines
3.3 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
|
|
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
|
|
<refentry id="gluErrorString">
|
|
<refmeta>
|
|
<refmetainfo>
|
|
<copyright>
|
|
<year>1991-2006</year>
|
|
<holder>Silicon Graphics, Inc.</holder>
|
|
</copyright>
|
|
</refmetainfo>
|
|
<refentrytitle>gluErrorString</refentrytitle>
|
|
<manvolnum>3G</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>gluErrorString</refname>
|
|
<refpurpose>produce an error string from a GL or GLU error code</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv><title>C Specification</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>const GLubyte * <function>gluErrorString</function></funcdef>
|
|
<paramdef>GLenum <parameter>error</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<!-- eqn: ignoring delim $$ -->
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>error</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies a GL or GLU error code.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 id="description"><title>Description</title>
|
|
<para>
|
|
<function>gluErrorString</function> produces an error string from a GL or GLU error code. The string
|
|
is in ISO Latin 1 format. For example,
|
|
<function>gluErrorString</function>(<constant>GLU_OUT_OF_MEMORY</constant>) returns the string
|
|
<emphasis>out of memory</emphasis>.
|
|
</para>
|
|
<para>
|
|
The standard GLU error codes are <constant>GLU_INVALID_ENUM</constant>,
|
|
<constant>GLU_INVALID_VALUE</constant>,
|
|
and <constant>GLU_OUT_OF_MEMORY</constant>.
|
|
Certain other GLU functions can return specialized error codes
|
|
through callbacks.
|
|
See the <citerefentry><refentrytitle>glGetError</refentrytitle></citerefentry> reference page for the list of
|
|
GL error codes.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="errors"><title>Errors</title>
|
|
<para>
|
|
<constant>NULL</constant> is returned if <parameter>error</parameter> is not a valid GL or GLU error code.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="seealso"><title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>gluNurbsCallback</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>gluQuadricCallback</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>gluTessCallback</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glGetError</refentrytitle></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
|
<para>
|
|
Copyright <trademark class="copyright"></trademark> 1991-2006
|
|
Silicon Graphics, Inc. This document is licensed under the SGI
|
|
Free Software B License. For details, see
|
|
<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|