Opentk/Source/Bind/Specifications/Docs/glCallList.xml

101 lines
4.6 KiB
XML
Raw Normal View History

<?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="glCallList">
<refmeta>
<refmetainfo>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
</refmetainfo>
<refentrytitle>glCallList</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glCallList</refname>
<refpurpose>execute a display list</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glCallList</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 the integer name of the display list to be executed.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glCallList</function> causes the named display list to be executed.
The commands saved in the display list are executed in order,
just as if they were called without using a display list.
If <parameter>list</parameter> has not been defined as a display list,
<function>glCallList</function> is ignored.
</para>
<para>
<function>glCallList</function> can appear inside a display list.
To avoid the possibility of infinite recursion resulting from display lists
calling one another,
a limit is placed on the nesting level of display
lists during display-list execution.
This limit is at least 64, and it depends on the implementation.
</para>
<para>
GL state is not saved and restored across a call to <function>glCallList</function>.
Thus,
changes made to GL state during the execution of a display list
remain after execution of the display list is completed.
Use <citerefentry><refentrytitle>glPushAttrib</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glPopAttrib</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glPushMatrix</refentrytitle></citerefentry>,
and <citerefentry><refentrytitle>glPopMatrix</refentrytitle></citerefentry> to preserve GL state across <function>glCallList</function> calls.
</para>
</refsect1>
<refsect1 id="notes"><title>Notes</title>
<para>
Display lists can be executed between a call to <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
and the corresponding call to <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>,
as long as the display list includes only commands that are allowed
in this interval.
</para>
</refsect1>
<refsect1 id="associatedgets"><title>Associated Gets</title>
<para>
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_LIST_NESTING</constant>
</para>
<para>
<citerefentry><refentrytitle>glIsList</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<function>glCallLists</function>,
<citerefentry><refentrytitle>glDeleteLists</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glGenLists</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glNewList</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glPushAttrib</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glPushMatrix</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>