upstream-man-pages/man3/xhtml/glMultiDrawArrays.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>glMultiDrawArrays</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glMultiDrawArrays"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glMultiDrawArrays — render multiple sets of primitives from array data</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">glMultiDrawArrays</b>(</code></td><td>GLenum  </td><td><var class="pdparam">mode</var>, </td></tr><tr><td> </td><td>const GLint *  </td><td><var class="pdparam">first</var>, </td></tr><tr><td> </td><td>const GLsizei *  </td><td><var class="pdparam">count</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>
   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>first</code></em></span></dt><dd><p>
  20                     Points to an array of starting indices in the enabled arrays.
  21                 </p></dd><dt><span class="term"><em class="parameter"><code>count</code></em></span></dt><dd><p>
  22                     Points to an array of the number of indices to be rendered.
  23                 </p></dd><dt><span class="term"><em class="parameter"><code>primcount</code></em></span></dt><dd><p>
  24                     Specifies the size of the first and count
  25                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  26             <code class="function">glMultiDrawArrays</code> specifies multiple sets of geometric primitives
  27             with very few subroutine calls. Instead of calling a GL procedure
  28             to pass each individual vertex, normal, texture coordinate, edge
  29             flag, or color, you can prespecify
  30             separate arrays of vertices, normals, and colors and use them to
  31             construct a sequence of primitives with a single
  32             call to <code class="function">glMultiDrawArrays</code>.
  33         </p><p>
  34             <code class="function">glMultiDrawArrays</code> behaves identically to <a href="glDrawArrays.xml"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a> except that <em class="parameter"><code>primcount</code></em>
  35             separate ranges of elements are specified instead.
  36         </p><p>
  37             When <code class="function">glMultiDrawArrays</code> is called, it uses <em class="parameter"><code>count</code></em> sequential elements from each
  38             enabled array to construct a sequence of geometric primitives,
  39             beginning with element <em class="parameter"><code>first</code></em>. <em class="parameter"><code>mode</code></em> specifies what kind of
  40             primitives are constructed, and how the array elements
  41             construct those primitives.
  42         </p><p>
  43             Vertex attributes that are modified by <code class="function">glMultiDrawArrays</code> have an
  44             unspecified value after <code class="function">glMultiDrawArrays</code> returns. Attributes that aren't
  45             modified remain well defined.
  46         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  47             <code class="constant">GL_LINE_STRIP_ADJACENCY</code>,
  48             <code class="constant">GL_LINES_ADJACENCY</code>,
  49             <code class="constant">GL_TRIANGLE_STRIP_ADJACENCY</code> and
  50             <code class="constant">GL_TRIANGLES_ADJACENCY</code>
  51             are available only if the GL version is 3.2 or greater.
  52         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  53             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>mode</code></em> is not an accepted value.
  54         </p><p>
  55             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>primcount</code></em> is negative.
  56         </p><p>
  57             <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to an
  58             enabled array and the buffer object's data store is currently mapped.
  59         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  60             <a href="glDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>,
  61             <a href="glDrawRangeElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>
  62         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  63             Copyright <span class="trademark"></span>© 1991-2006
  64             Silicon Graphics, Inc. This document is licensed under the SGI
  65             Free Software B License. For details, see
  66             <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
  67         </p></div></div></body></html>