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