upstream-man-pages/man2/glCallList.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="glCallList">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glCallList</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glCallList</refname>
  17         <refpurpose>execute a display list</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glCallList</function></funcdef>
  23                 <paramdef>GLuint <parameter>list</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>list</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Specifies the integer name of the display list to be executed.
  34                 </para>
  35             </listitem>
  36         </varlistentry>
  37         </variablelist>
  38     </refsect1>
  39     <refsect1 id="description"><title>Description</title>
  40         <para>
  41             <function>glCallList</function> causes the named display list to be executed.
  42             The commands saved in the display list are executed in order,
  43             just as if they were called without using a display list.
  44             If <parameter>list</parameter> has not been defined as a display list,
  45             <function>glCallList</function> is ignored.
  46         </para>
  47         <para>
  48             <function>glCallList</function> can appear inside a display list.
  49             To avoid the possibility of infinite recursion resulting from display lists
  50             calling one another,
  51             a limit is placed on the nesting level of display
  52             lists during display-list execution.
  53             This limit is at least 64, and it depends on the implementation.
  54         </para>
  55         <para>
  56             GL state is not saved and restored across a call to <function>glCallList</function>.
  57             Thus,
  58             changes made to GL state during the execution of a display list
  59             remain after execution of the display list is completed.
  60             Use <citerefentry><refentrytitle>glPushAttrib</refentrytitle></citerefentry>,
  61             <citerefentry><refentrytitle>glPopAttrib</refentrytitle></citerefentry>,
  62             <citerefentry><refentrytitle>glPushMatrix</refentrytitle></citerefentry>,
  63             and <citerefentry><refentrytitle>glPopMatrix</refentrytitle></citerefentry> to preserve GL state across <function>glCallList</function> calls.
  64         </para>
  65     </refsect1>
  66     <refsect1 id="notes"><title>Notes</title>
  67         <para>
  68             Display lists can be executed between a call to <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
  69             and the corresponding call to <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>,
  70             as long as the display list includes only commands that are allowed
  71             in this interval.
  72         </para>
  73     </refsect1>
  74     <refsect1 id="associatedgets"><title>Associated Gets</title>
  75         <para>
  76             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_LIST_NESTING</constant>
  77         </para>
  78         <para>
  79             <citerefentry><refentrytitle>glIsList</refentrytitle></citerefentry>
  80         </para>
  81     </refsect1>
  82     <refsect1 id="seealso"><title>See Also</title>
  83         <para>
  84             <function>glCallLists</function>,
  85             <citerefentry><refentrytitle>glDeleteLists</refentrytitle></citerefentry>,
  86             <citerefentry><refentrytitle>glGenLists</refentrytitle></citerefentry>,
  87             <citerefentry><refentrytitle>glNewList</refentrytitle></citerefentry>,
  88             <citerefentry><refentrytitle>glPushAttrib</refentrytitle></citerefentry>,
  89             <citerefentry><refentrytitle>glPushMatrix</refentrytitle></citerefentry>
  90         </para>
  91     </refsect1>
  92     <refsect1 id="Copyright"><title>Copyright</title>
  93         <para>
  94             Copyright <trademark class="copyright"></trademark> 1991-2006
  95             Silicon Graphics, Inc. This document is licensed under the SGI
  96             Free Software B License. For details, see
  97             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  98         </para>
  99     </refsect1>
 100 </refentry>