upstream-doc/man2/xhtml/glMultiDrawElements.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>glMultiDrawElements</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glMultiDrawElements"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glMultiDrawElements — render multiple sets of primitives by specifying indices of array data elements</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">glMultiDrawElements</b>(</code></td><td>GLenum  </td><td><var class="pdparam">mode</var>, </td></tr><tr><td> </td><td>const GLsizei *  </td><td><var class="pdparam">count</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">type</var>, </td></tr><tr><td> </td><td>const GLvoid **  </td><td><var class="pdparam">indices</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">primcount</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>mode</code></em></span></dt><dd><p>
   4                     Specifies what kind of primitives to render.
   5                     Symbolic constants
   6                     <code class="constant">GL_POINTS</code>,
   7                     <code class="constant">GL_LINE_STRIP</code>,
   8                     <code class="constant">GL_LINE_LOOP</code>,
   9                     <code class="constant">GL_LINES</code>,
  10                     <code class="constant">GL_TRIANGLE_STRIP</code>,
  11                     <code class="constant">GL_TRIANGLE_FAN</code>,
  12                     <code class="constant">GL_TRIANGLES</code>,
  13                     <code class="constant">GL_QUAD_STRIP</code>,
  14                     <code class="constant">GL_QUADS</code>,
  15                     and <code class="constant">GL_POLYGON</code> are accepted.
  16                 </p></dd><dt><span class="term"><em class="parameter"><code>count</code></em></span></dt><dd><p>
  17                     Points to an array of the elements counts.
  18                 </p></dd><dt><span class="term"><em class="parameter"><code>type</code></em></span></dt><dd><p>
  19                     Specifies the type of the values in <em class="parameter"><code>indices</code></em>. Must be one of
  20                     <code class="constant">GL_UNSIGNED_BYTE</code>, <code class="constant">GL_UNSIGNED_SHORT</code>, or
  21                     <code class="constant">GL_UNSIGNED_INT</code>.
  22                 </p></dd><dt><span class="term"><em class="parameter"><code>indices</code></em></span></dt><dd><p>
  23                     Specifies a pointer to the location where the indices are stored.
  24                 </p></dd><dt><span class="term"><em class="parameter"><code>primcount</code></em></span></dt><dd><p>
  25                     Specifies the size of the <em class="parameter"><code>count</code></em> array.
  26                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  27             <code class="function">glMultiDrawElements</code> specifies multiple sets of geometric primitives with very few subroutine
  28             calls. Instead of calling a GL function to pass each individual vertex,
  29             normal, texture coordinate, edge flag, or color, you can prespecify
  30             separate arrays of vertices, normals, and so on, and use them to construct a
  31             sequence of primitives with a single call to <code class="function">glMultiDrawElements</code>.
  32         </p><p>
  33             <code class="function">glMultiDrawElements</code> is identical in operation to <a class="citerefentry" href="glDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a> except that
  34             <em class="parameter"><code>primcount</code></em> separate lists of elements are specified.
  35         </p><p>
  36             Vertex attributes that are modified by <code class="function">glMultiDrawElements</code> have an
  37             unspecified value after <code class="function">glMultiDrawElements</code> returns. For example, if
  38             <code class="constant">GL_COLOR_ARRAY</code> is enabled, the value of the current color is
  39             undefined after <code class="function">glMultiDrawElements</code> executes. Attributes that aren't
  40             modified maintain their previous values.
  41         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  42             <code class="function">glMultiDrawElements</code> is available only if the GL version is 1.4 or greater.
  43         </p><p>
  44             <code class="function">glMultiDrawElements</code> is included in display lists. If <code class="function">glMultiDrawElements</code> is entered into a
  45             display list,
  46             the necessary array data (determined by the array pointers and
  47             enables) is also
  48             entered into the display list. Because the array pointers and
  49             enables are client-side state, their values affect display lists
  50             when the lists are created, not when the lists are executed.
  51         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  52             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>mode</code></em> is not an accepted value.
  53         </p><p>
  54             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>primcount</code></em> is negative.
  55         </p><p>
  56             <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to an
  57             enabled array or the element array and the buffer object's data store is currently mapped.
  58         </p><p>
  59             <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glMultiDrawElements</code> is executed between
  60             the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
  61         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  62             <a class="citerefentry" href="glArrayElement.xml"><span class="citerefentry"><span class="refentrytitle">glArrayElement</span></span></a>,
  63             <a class="citerefentry" href="glColorPointer.xml"><span class="citerefentry"><span class="refentrytitle">glColorPointer</span></span></a>,
  64             <a class="citerefentry" href="glDrawArrays.xml"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>,
  65             <a class="citerefentry" href="glDrawRangeElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>,
  66             <a class="citerefentry" href="glEdgeFlagPointer.xml"><span class="citerefentry"><span class="refentrytitle">glEdgeFlagPointer</span></span></a>,
  67             <a class="citerefentry" href="glFogCoordPointer.xml"><span class="citerefentry"><span class="refentrytitle">glFogCoordPointer</span></span></a>,
  68             <a class="citerefentry" href="glGetPointerv.xml"><span class="citerefentry"><span class="refentrytitle">glGetPointerv</span></span></a>,
  69             <a class="citerefentry" href="glIndexPointer.xml"><span class="citerefentry"><span class="refentrytitle">glIndexPointer</span></span></a>,
  70             <a class="citerefentry" href="glInterleavedArrays.xml"><span class="citerefentry"><span class="refentrytitle">glInterleavedArrays</span></span></a>,
  71             <a class="citerefentry" href="glNormalPointer.xml"><span class="citerefentry"><span class="refentrytitle">glNormalPointer</span></span></a>,
  72             <a class="citerefentry" href="glSecondaryColorPointer.xml"><span class="citerefentry"><span class="refentrytitle">glSecondaryColorPointer</span></span></a>,
  73             <a class="citerefentry" href="glTexCoordPointer.xml"><span class="citerefentry"><span class="refentrytitle">glTexCoordPointer</span></span></a>,
  74             <a class="citerefentry" href="glVertexPointer.xml"><span class="citerefentry"><span class="refentrytitle">glVertexPointer</span></span></a>
  75         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  76             Copyright <span class="trademark"></span>© 1991-2006
  77             Silicon Graphics, Inc. This document is licensed under the SGI
  78             Free Software B License. For details, see
  79             <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
  80         </p></div></div></body></html>