upstream-man-pages/man2/glGenLists.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="glGenLists">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glGenLists</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glGenLists</refname>
  17         <refpurpose>generate a contiguous set of empty display lists</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>GLuint <function>glGenLists</function></funcdef>
  23                 <paramdef>GLsizei <parameter>range</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>range</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Specifies the number of contiguous empty display lists
  34                     to be generated.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         </variablelist>
  39     </refsect1>
  40     <refsect1 id="description"><title>Description</title>
  41         <para>
  42             <function>glGenLists</function> has one argument, <parameter>range</parameter>.
  43             It returns an integer <emphasis>n</emphasis> such that <parameter>range</parameter> contiguous
  44             empty display lists,
  45             named
  46             <inlineequation><mml:math><mml:mi mathvariant="italic">n</mml:mi></mml:math></inlineequation>,
  47             <inlineequation><mml:math>
  48                 <!-- eqn: n+1:-->
  49                 <mml:mrow>
  50                     <mml:mi mathvariant="italic">n</mml:mi>
  51                     <mml:mo>+</mml:mo>
  52                     <mml:mn>1</mml:mn>
  53                 </mml:mrow>
  54             </mml:math></inlineequation>,
  55             <inlineequation><mml:math>
  56                 <!-- eqn: ...:-->
  57                 <mml:mi mathvariant="italic">...</mml:mi>
  58             </mml:math></inlineequation>,
  59             <inlineequation><mml:math>
  60                 <!-- eqn: n + range - 1:-->
  61                 <mml:mrow>
  62                     <mml:mi mathvariant="italic">n</mml:mi>
  63                     <mml:mo>+</mml:mo>
  64                     <mml:mi mathvariant="italic">range</mml:mi>
  65                     <mml:mo>-</mml:mo>
  66                     <mml:mn>1</mml:mn>
  67                 </mml:mrow>
  68             </mml:math></inlineequation>,
  69             are created.
  70             If <parameter>range</parameter> is 0,
  71             if there is no group of <parameter>range</parameter> contiguous names available,
  72             or if any error is generated,
  73             no display lists are generated,
  74             and 0 is returned.
  75         </para>
  76     </refsect1>
  77     <refsect1 id="errors"><title>Errors</title>
  78         <para>
  79             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>range</parameter> is negative.
  80         </para>
  81         <para>
  82             <constant>GL_INVALID_OPERATION</constant> is generated if <function>glGenLists</function>
  83             is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
  84             and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
  85         </para>
  86     </refsect1>
  87     <refsect1 id="associatedgets"><title>Associated Gets</title>
  88         <para>
  89             <citerefentry><refentrytitle>glIsList</refentrytitle></citerefentry>
  90         </para>
  91     </refsect1>
  92     <refsect1 id="seealso"><title>See Also</title>
  93         <para>
  94             <citerefentry><refentrytitle>glCallList</refentrytitle></citerefentry>,
  95             <citerefentry><refentrytitle>glCallLists</refentrytitle></citerefentry>,
  96             <citerefentry><refentrytitle>glDeleteLists</refentrytitle></citerefentry>,
  97             <citerefentry><refentrytitle>glNewList</refentrytitle></citerefentry>
  98         </para>
  99     </refsect1>
 100     <refsect1 id="Copyright"><title>Copyright</title>
 101         <para>
 102             Copyright <trademark class="copyright"></trademark> 1991-2006
 103             Silicon Graphics, Inc. This document is licensed under the SGI
 104             Free Software B License. For details, see
 105             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 106         </para>
 107     </refsect1>
 108 </refentry>