upstream-man-pages/man3/glDrawRangeElementsBaseVertex.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glDrawRangeElementsBaseVertex">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glDrawRangeElementsBaseVertex</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glDrawRangeElementsBaseVertex</refname>
  17         <refpurpose>render primitives from array data with a per-element offset</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glDrawRangeElementsBaseVertex</function></funcdef>
  23                 <paramdef>GLenum <parameter>mode</parameter></paramdef>
  24                 <paramdef>GLuint <parameter>start</parameter></paramdef>
  25                 <paramdef>GLuint <parameter>end</parameter></paramdef>
  26                 <paramdef>GLsizei <parameter>count</parameter></paramdef>
  27                 <paramdef>GLenum <parameter>type</parameter></paramdef>
  28                 <paramdef>GLvoid *<parameter>indices</parameter></paramdef>
  29                 <paramdef>GLint <parameter>basevertex</parameter></paramdef>
  30             </funcprototype>
  31         </funcsynopsis>
  32     </refsynopsisdiv>
  33     <!-- eqn: ignoring delim $$ -->
  34     <refsect1 id="parameters"><title>Parameters</title>
  35         <variablelist>
  36         <varlistentry>
  37             <term><parameter>mode</parameter></term>
  38             <listitem>
  39                 <para>
  40                     Specifies what kind of primitives to render.
  41                     Symbolic constants
  42                     <constant>GL_POINTS</constant>, <constant>GL_LINE_STRIP</constant>, <constant>GL_LINE_LOOP</constant>,
  43                     <constant>GL_LINES</constant>, <constant>GL_TRIANGLE_STRIP</constant>, <constant>GL_TRIANGLE_FAN</constant>,
  44                     and <constant>GL_TRIANGLES</constant> are accepted.
  45                 </para>
  46             </listitem>
  47         </varlistentry>
  48         <varlistentry>
  49             <term><parameter>start</parameter></term>
  50             <listitem>
  51                 <para>
  52                     Specifies the minimum array index contained in <parameter>indices</parameter>.
  53                 </para>
  54             </listitem>
  55         </varlistentry>
  56         <varlistentry>
  57             <term><parameter>end</parameter></term>
  58             <listitem>
  59                 <para>
  60                     Specifies the maximum array index contained in <parameter>indices</parameter>.
  61                 </para>
  62             </listitem>
  63         </varlistentry>
  64         <varlistentry>
  65             <term><parameter>count</parameter></term>
  66             <listitem>
  67                 <para>
  68                     Specifies the number of elements to be rendered.
  69                 </para>
  70             </listitem>
  71         </varlistentry>
  72         <varlistentry>
  73             <term><parameter>type</parameter></term>
  74             <listitem>
  75                 <para>
  76                     Specifies the type of the values in indices. Must be one of <constant>GL_UNSIGNED_BYTE</constant>,
  77                     <constant>GL_UNSIGNED_SHORT</constant>, or <constant>GL_UNSIGNED_INT</constant>.
  78                 </para>
  79             </listitem>
  80         </varlistentry>
  81         <varlistentry>
  82             <term><parameter>indices</parameter></term>
  83             <listitem>
  84                 <para>
  85                     Specifies a pointer to the location where the indices are stored.
  86                 </para>
  87             </listitem>
  88         </varlistentry>
  89         <varlistentry>
  90             <term><parameter>basevertex</parameter></term>
  91             <listitem>
  92                 <para>
  93                     Specifies a constant that should be added to each element of <parameter>indices</parameter>
  94                     when chosing elements from the enabled vertex arrays.
  95                 </para>
  96             </listitem>
  97         </varlistentry>
  98         </variablelist>
  99     </refsect1>
 100     <refsect1 id="description"><title>Description</title>
 101         <para>
 102             <function>glDrawRangeElementsBaseVertex</function> is a restricted form of
 103             <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>. <parameter>mode</parameter>,
 104             <parameter>start</parameter>, <parameter>end</parameter>, <parameter>count</parameter> and <parameter>basevertex</parameter> match
 105             the corresponding arguments to <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>, with the additional
 106             constraint that all values in the array <parameter>indices</parameter> must lie between <parameter>start</parameter> and <parameter>end</parameter>,
 107             inclusive, prior to adding <parameter>basevertex</parameter>. Index values lying outside the range [<parameter>start</parameter>, <parameter>end</parameter>]
 108             are treated in the same way as <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>. The <emphasis>i</emphasis>th element
 109             transferred by the corresponding draw call will be taken from element <parameter>indices</parameter>[i] + <parameter>basevertex</parameter> of each enabled
 110             array. If the resulting value is larger than the maximum value representable by <parameter>type</parameter>, it is as if the calculation were upconverted to
 111             32-bit unsigned integers (with wrapping on overflow conditions). The operation is undefined if the sum would be negative.
 112         </para>
 113     </refsect1>
 114     <refsect1 id="notes"><title>Notes</title>
 115         <function>glDrawRangeElementsBaseVertex</function> is only supported if the GL version is 3.2 or greater, or if
 116             the <code>ARB_draw_elements_base_vertex</code> extension is supported.
 117     </refsect1>
 118     <refsect1 id="errors"><title>Errors</title>
 119         <para>
 120             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>mode</parameter> is not an accepted value.
 121         </para>
 122         <para>
 123             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>count</parameter> is negative.
 124         </para>
 125         <para>
 126             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>end</parameter> &lt; <parameter>start</parameter>.
 127         </para>
 128         <para>
 129             <constant>GL_INVALID_OPERATION</constant> is generated if a geometry shader is active and <parameter>mode</parameter>
 130             is incompatible with the input primitive type of the geometry shader in the currently installed program object.
 131         </para>
 132         <para>
 133             <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to an
 134             enabled array or the element array and the buffer object's data store is currently mapped.
 135         </para>
 136     </refsect1>
 137     <refsect1 id="seealso"><title>See Also</title>
 138         <para>
 139             <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
 140             <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>,
 141             <citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry>,
 142             <citerefentry><refentrytitle>glDrawElementsInstanced</refentrytitle></citerefentry>,
 143             <citerefentry><refentrytitle>glDrawElementsInstancedBaseVertex</refentrytitle></citerefentry>
 144         </para>
 145     </refsect1>
 146     <refsect1 id="Copyright"><title>Copyright</title>
 147         <para>
 148             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
 149             This material may be distributed subject to the terms and conditions set forth in
 150             the Open Publication License, v 1.0, 8 June 1999.
 151             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 152         </para>
 153     </refsect1>
 154 </refentry>