upstream-man-pages/man4/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                     <constant>GL_TRIANGLES</constant>, <constant>GL_LINES_ADJACENCY</constant>, <constant>GL_LINE_STRIP_ADJACENCY</constant>,
  45                     <constant>GL_TRIANGLES_ADJACENCY</constant>, <constant>GL_TRIANGLE_STRIP_ADJACENCY</constant> and <constant>GL_PATCHES</constant> are accepted.
  46                 </para>
  47             </listitem>
  48         </varlistentry>
  49         <varlistentry>
  50             <term><parameter>start</parameter></term>
  51             <listitem>
  52                 <para>
  53                     Specifies the minimum array index contained in <parameter>indices</parameter>.
  54                 </para>
  55             </listitem>
  56         </varlistentry>
  57         <varlistentry>
  58             <term><parameter>end</parameter></term>
  59             <listitem>
  60                 <para>
  61                     Specifies the maximum array index contained in <parameter>indices</parameter>.
  62                 </para>
  63             </listitem>
  64         </varlistentry>
  65         <varlistentry>
  66             <term><parameter>count</parameter></term>
  67             <listitem>
  68                 <para>
  69                     Specifies the number of elements to be rendered.
  70                 </para>
  71             </listitem>
  72         </varlistentry>
  73         <varlistentry>
  74             <term><parameter>type</parameter></term>
  75             <listitem>
  76                 <para>
  77                     Specifies the type of the values in indices. Must be one of <constant>GL_UNSIGNED_BYTE</constant>,
  78                     <constant>GL_UNSIGNED_SHORT</constant>, or <constant>GL_UNSIGNED_INT</constant>.
  79                 </para>
  80             </listitem>
  81         </varlistentry>
  82         <varlistentry>
  83             <term><parameter>indices</parameter></term>
  84             <listitem>
  85                 <para>
  86                     Specifies a pointer to the location where the indices are stored.
  87                 </para>
  88             </listitem>
  89         </varlistentry>
  90         <varlistentry>
  91             <term><parameter>basevertex</parameter></term>
  92             <listitem>
  93                 <para>
  94                     Specifies a constant that should be added to each element of <parameter>indices</parameter>
  95                     when chosing elements from the enabled vertex arrays.
  96                 </para>
  97             </listitem>
  98         </varlistentry>
  99         </variablelist>
 100     </refsect1>
 101     <refsect1 id="description"><title>Description</title>
 102         <para>
 103             <function>glDrawRangeElementsBaseVertex</function> is a restricted form of
 104             <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>. <parameter>mode</parameter>,
 105             <parameter>start</parameter>, <parameter>end</parameter>, <parameter>count</parameter> and <parameter>basevertex</parameter> match
 106             the corresponding arguments to <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>, with the additional
 107             constraint that all values in the array <parameter>indices</parameter> must lie between <parameter>start</parameter> and <parameter>end</parameter>,
 108             inclusive, prior to adding <parameter>basevertex</parameter>. Index values lying outside the range [<parameter>start</parameter>, <parameter>end</parameter>]
 109             are treated in the same way as <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>. The <emphasis>i</emphasis>th element
 110             transferred by the corresponding draw call will be taken from element <parameter>indices</parameter>[i] + <parameter>basevertex</parameter> of each enabled
 111             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
 112             32-bit unsigned integers (with wrapping on overflow conditions). The operation is undefined if the sum would be negative.
 113         </para>
 114     </refsect1>
 115     <refsect1 id="errors"><title>Errors</title>
 116         <para>
 117             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>mode</parameter> is not an accepted value.
 118         </para>
 119         <para>
 120             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>count</parameter> is negative.
 121         </para>
 122         <para>
 123             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>end</parameter> &lt; <parameter>start</parameter>.
 124         </para>
 125         <para>
 126             <constant>GL_INVALID_OPERATION</constant> is generated if a geometry shader is active and <parameter>mode</parameter>
 127             is incompatible with the input primitive type of the geometry shader in the currently installed program object.
 128         </para>
 129         <para>
 130             <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to an
 131             enabled array or the element array and the buffer object's data store is currently mapped.
 132         </para>
 133     </refsect1>
 134     <refsect1 id="seealso"><title>See Also</title>
 135         <para>
 136             <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
 137             <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>,
 138             <citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry>,
 139             <citerefentry><refentrytitle>glDrawElementsInstanced</refentrytitle></citerefentry>,
 140             <citerefentry><refentrytitle>glDrawElementsInstancedBaseVertex</refentrytitle></citerefentry>
 141         </para>
 142     </refsect1>
 143     <refsect1 id="Copyright"><title>Copyright</title>
 144         <para>
 145             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
 146             This material may be distributed subject to the terms and conditions set forth in
 147             the Open Publication License, v 1.0, 8 June 1999.
 148             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 149         </para>
 150     </refsect1>
 151 </refentry>