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