upstream-man-pages/man2/glInitNames.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="glInitNames">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glInitNames</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glInitNames</refname>
  17         <refpurpose>initialize the name stack</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glInitNames</function></funcdef>
  23                 <paramdef> <parameter>void</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="description"><title>Description</title>
  28         <para>
  29             The name stack is used during selection mode to allow sets of rendering
  30             commands to be uniquely identified.
  31             It consists of an ordered set of unsigned integers.
  32             <function>glInitNames</function> causes the name stack to be initialized to its default empty state.
  33         </para>
  34         <para>
  35             The name stack is always empty while the render mode is not <constant>GL_SELECT</constant>.
  36             Calls to <function>glInitNames</function> while the render mode is not <constant>GL_SELECT</constant> are ignored.
  37         </para>
  38     </refsect1>
  39     <refsect1 id="errors"><title>Errors</title>
  40         <para>
  41             <constant>GL_INVALID_OPERATION</constant> is generated if <function>glInitNames</function>
  42             is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding execution of
  43             <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
  44         </para>
  45     </refsect1>
  46     <refsect1 id="associatedgets"><title>Associated Gets</title>
  47         <para>
  48             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_NAME_STACK_DEPTH</constant>
  49         </para>
  50         <para>
  51             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_NAME_STACK_DEPTH</constant>
  52         </para>
  53     </refsect1>
  54     <refsect1 id="seealso"><title>See Also</title>
  55         <para>
  56             <citerefentry><refentrytitle>glLoadName</refentrytitle></citerefentry>,
  57             <citerefentry><refentrytitle>glPushName</refentrytitle></citerefentry>,
  58             <citerefentry><refentrytitle>glRenderMode</refentrytitle></citerefentry>,
  59             <citerefentry><refentrytitle>glSelectBuffer</refentrytitle></citerefentry>
  60         </para>
  61     </refsect1>
  62     <refsect1 id="Copyright"><title>Copyright</title>
  63         <para>
  64             Copyright <trademark class="copyright"></trademark> 1991-2006
  65             Silicon Graphics, Inc. This document is licensed under the SGI
  66             Free Software B License. For details, see
  67             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  68         </para>
  69     </refsect1>
  70 </refentry>