upstream-man-pages/man3/xhtml/glMultiDrawElementsBaseVertex.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   3 <!-- saved from url=(0013)about:internet -->
   4 <?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" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glMultiDrawElementsBaseVertex</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="refentry" title="glMultiDrawElementsBaseVertex"><a id="glMultiDrawElementsBaseVertex"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glMultiDrawElementsBaseVertex — render multiple sets of primitives by specifying indices of array data elements and an index to apply to each index</p></div><div class="refsynopsisdiv" title="C Specification"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glMultiDrawElementsBaseVertex</b>(</code></td><td>GLenum <var class="pdparam">mode</var>, </td></tr><tr><td> </td><td>const GLsizei *<var class="pdparam">count</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">type</var>, </td></tr><tr><td> </td><td>const GLvoid **<var class="pdparam">indices</var>, </td></tr><tr><td> </td><td>GLsizei <var class="pdparam">primcount</var>, </td></tr><tr><td> </td><td>GLint *<var class="pdparam">basevertex</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Parameters"><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>
   5                     Specifies what kind of primitives to render.
   6                     Symbolic constants
   7                     <code class="constant">GL_POINTS</code>,
   8                     <code class="constant">GL_LINE_STRIP</code>,
   9                     <code class="constant">GL_LINE_LOOP</code>,
  10                     <code class="constant">GL_LINES</code>,
  11                     <code class="constant">GL_LINE_STRIP_ADJACENCY</code>,
  12                     <code class="constant">GL_LINES_ADJACENCY</code>,
  13                     <code class="constant">GL_TRIANGLE_STRIP</code>,
  14                     <code class="constant">GL_TRIANGLE_FAN</code>,
  15                     <code class="constant">GL_TRIANGLES</code>,
  16                     <code class="constant">GL_TRIANGLE_STRIP_ADJACENCY</code> and
  17                     <code class="constant">GL_TRIANGLES_ADJACENCY</code>
  18                     are accepted.
  19                 </p></dd><dt><span class="term"><em class="parameter"><code>count</code></em></span></dt><dd><p>
  20                     Points to an array of the elements counts.
  21                 </p></dd><dt><span class="term"><em class="parameter"><code>type</code></em></span></dt><dd><p>
  22                     Specifies the type of the values in <em class="parameter"><code>indices</code></em>. Must be one of
  23                     <code class="constant">GL_UNSIGNED_BYTE</code>, <code class="constant">GL_UNSIGNED_SHORT</code>, or
  24                     <code class="constant">GL_UNSIGNED_INT</code>.
  25                 </p></dd><dt><span class="term"><em class="parameter"><code>indices</code></em></span></dt><dd><p>
  26                     Specifies a pointer to the location where the indices are stored.
  27                 </p></dd><dt><span class="term"><em class="parameter"><code>primcount</code></em></span></dt><dd><p>
  28                     Specifies the size of the <em class="parameter"><code>count</code></em> array.
  29                 </p></dd><dt><span class="term"><em class="parameter"><code>basevertex</code></em></span></dt><dd><p>
  30                     Specifies a pointer to the location where the base vertices are stored.
  31                 </p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p>
  32             <code class="function">glMultiDrawElementsBaseVertex</code> behaves identically to <a class="citerefentry" href="glDrawElementsBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsBaseVertex</span></span></a>,
  33             except that <em class="parameter"><code>primcount</code></em> separate lists of elements are specifried instead.
  34         </p><p>
  35         It has the same effect as:
  36         </p><pre class="programlisting">    for (int i = 0; i &lt; <em class="parameter"><code>primcount</code></em>; i++)
  37         if (<em class="parameter"><code>count</code></em>[i] &gt; 0)
  38             glDrawElementsBaseVertex(<em class="parameter"><code>mode</code></em>,
  39                                      <em class="parameter"><code>count</code></em>[i],
  40                                      <em class="parameter"><code>type</code></em>,
  41                                      <em class="parameter"><code>indices[i]</code></em>,
  42                                      <em class="parameter"><code>basevertex[i]</code></em>);</pre><p>
  43         </p></div><div class="refsect1" title="Notes"><a id="notes"></a><h2>Notes</h2><p>
  44             <code class="function">glMultiDrawElementsBaseVertex</code> is available only if the GL version is 3.1 or greater.
  45         </p><p>
  46             <code class="constant">GL_LINE_STRIP_ADJACENCY</code>,
  47             <code class="constant">GL_LINES_ADJACENCY</code>,
  48             <code class="constant">GL_TRIANGLE_STRIP_ADJACENCY</code> and
  49             <code class="constant">GL_TRIANGLES_ADJACENCY</code>
  50             are available only if the GL version is 3.2 or greater.
  51         </p></div><div class="refsect1" title="Errors"><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></div><div class="refsect1" title="See Also"><a id="seealso"></a><h2>See Also</h2><p>
  59             <a class="citerefentry" href="glMultiDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElements</span></span></a>,
  60             <a class="citerefentry" href="glDrawElementsBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsBaseVertex</span></span></a>,
  61             <a class="citerefentry" href="glDrawArrays.xml"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>,
  62             <a class="citerefentry" href="glVertexAttribPointer.xml"><span class="citerefentry"><span class="refentrytitle">glVertexAttribPointer</span></span></a>
  63         </p></div><div class="refsect1" title="Copyright"><a id="Copyright"></a><h2>Copyright</h2><p>
  64             Copyright <span class="trademark"></span>© 2010 Khronos Group.
  65             This material may be distributed subject to the terms and conditions set forth in
  66             the Open Publication License, v 1.0, 8 June 1999.
  67             <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  68         </p></div></div></body></html>