upstream-man-pages/man2/xhtml/glPushName.xml

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   2 <!-- saved from url=(0013)about:internet -->
   3 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>glPushName</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glPushName"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glPushName — push and pop the name stack</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glPushName</b>(</code></td><td>GLuint  </td><td><var class="pdparam">name</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>name</code></em></span></dt><dd><p>
   4                     Specifies a name that will be pushed onto the name stack.
   5                 </p></dd></dl></div></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glPopName</b>(</code></td><td>  </td><td><var class="pdparam">void</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   6             The name stack is used during selection mode to allow sets of rendering
   7             commands to be uniquely identified.
   8             It consists of an ordered set of unsigned integers and is initially empty.
   9         </p><p>
  10             <code class="function">glPushName</code> causes <em class="parameter"><code>name</code></em> to be pushed onto the name stack.
  11             <a class="citerefentry" href="glPopName.xml"><span class="citerefentry"><span class="refentrytitle">glPopName</span></span></a> pops one name off the top of the stack.
  12         </p><p>
  13             The maximum name stack depth is implementation-dependent; call
  14             <code class="constant">GL_MAX_NAME_STACK_DEPTH</code> to find out the value for a particular
  15             implementation. It is an
  16             error to push a name onto a full stack
  17             or to pop a name off an empty stack.
  18             It is also an error to manipulate the name stack between the execution of
  19             <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
  20             In any of these cases, the error flag is set and no other change is
  21             made to GL state.
  22         </p><p>
  23             The name stack is always empty while the render mode is not <code class="constant">GL_SELECT</code>.
  24             Calls to <code class="function">glPushName</code> or <a class="citerefentry" href="glPopName.xml"><span class="citerefentry"><span class="refentrytitle">glPopName</span></span></a> while the render mode is not
  25             <code class="constant">GL_SELECT</code> are ignored.
  26         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  27             <code class="constant">GL_STACK_OVERFLOW</code> is generated if <code class="function">glPushName</code> is called while the
  28             name stack is full.
  29         </p><p>
  30             <code class="constant">GL_STACK_UNDERFLOW</code> is generated if <a class="citerefentry" href="glPopName.xml"><span class="citerefentry"><span class="refentrytitle">glPopName</span></span></a> is called while the
  31             name stack is empty.
  32         </p><p>
  33             <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glPushName</code> or <a class="citerefentry" href="glPopName.xml"><span class="citerefentry"><span class="refentrytitle">glPopName</span></span></a>
  34             is executed between a call to <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding call to
  35             <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
  36         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  37             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_NAME_STACK_DEPTH</code>
  38         </p><p>
  39             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_NAME_STACK_DEPTH</code>
  40         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  41             <a class="citerefentry" href="glInitNames.xml"><span class="citerefentry"><span class="refentrytitle">glInitNames</span></span></a>,
  42             <a class="citerefentry" href="glLoadName.xml"><span class="citerefentry"><span class="refentrytitle">glLoadName</span></span></a>,
  43             <a class="citerefentry" href="glRenderMode.xml"><span class="citerefentry"><span class="refentrytitle">glRenderMode</span></span></a>,
  44             <a class="citerefentry" href="glSelectBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glSelectBuffer</span></span></a>
  45         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  46             Copyright <span class="trademark"></span>© 1991-2006
  47             Silicon Graphics, Inc. This document is licensed under the SGI
  48             Free Software B License. For details, see
  49             <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
  50         </p></div></div></body></html>