Opentk/Source/Bind/Specifications/Docs/glIsList.xml
2009-03-08 00:46:58 +00:00

74 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="glIsList">
<refmeta>
<refmetainfo>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
</refmetainfo>
<refentrytitle>glIsList</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glIsList</refname>
<refpurpose>determine if a name corresponds to a display list</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>GLboolean <function>glIsList</function></funcdef>
<paramdef>GLuint <parameter>list</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>list</parameter></term>
<listitem>
<para>
Specifies a potential display list name.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glIsList</function> returns <constant>GL_TRUE</constant> if <parameter>list</parameter> is the name
of a display list and returns <constant>GL_FALSE</constant> if it is not, or if an error occurs.
</para>
<para>
A name returned by <citerefentry><refentrytitle>glGenLists</refentrytitle></citerefentry>, but not yet associated with a display list
by calling <citerefentry><refentrytitle>glNewList</refentrytitle></citerefentry>, is not the name of a display list.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated if <function>glIsList</function>
is executed between the execution of
<citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glCallList</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glCallLists</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glDeleteLists</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glGenLists</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glNewList</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>