upstream-man-pages/man4/glDrawElementsInstancedBaseVertex.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="glDrawElementsInstancedBaseVertex">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glDrawElementsInstancedBaseVertex</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glDrawElementsInstancedBaseVertex</refname>
  17         <refpurpose>render multiple instances of a set of 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>glDrawElementsInstancedBaseVertex</function></funcdef>
  23                 <paramdef>GLenum <parameter>mode</parameter></paramdef>
  24                 <paramdef>GLsizei <parameter>count</parameter></paramdef>
  25                 <paramdef>GLenum <parameter>type</parameter></paramdef>
  26                 <paramdef>GLvoid *<parameter>indices</parameter></paramdef>
  27                 <paramdef>GLsizei <parameter>primcount</parameter></paramdef>
  28                 <paramdef>GLint <parameter>basevertex</parameter></paramdef>
  29             </funcprototype>
  30         </funcsynopsis>
  31     </refsynopsisdiv>
  32     <!-- eqn: ignoring delim $$ -->
  33     <refsect1 id="parameters"><title>Parameters</title>
  34         <variablelist>
  35         <varlistentry>
  36             <term><parameter>mode</parameter></term>
  37             <listitem>
  38                 <para>
  39                     Specifies what kind of primitives to render.
  40                     Symbolic constants
  41                     <constant>GL_POINTS</constant>, <constant>GL_LINE_STRIP</constant>, <constant>GL_LINE_LOOP</constant>,
  42                     <constant>GL_LINES</constant>, <constant>GL_TRIANGLE_STRIP</constant>, <constant>GL_TRIANGLE_FAN</constant>,
  43                     <constant>GL_TRIANGLES</constant>, <constant>GL_LINES_ADJACENCY</constant>, <constant>GL_LINE_STRIP_ADJACENCY</constant>,
  44                     <constant>GL_TRIANGLES_ADJACENCY</constant>, <constant>GL_TRIANGLE_STRIP_ADJACENCY</constant> and <constant>GL_PATCHES</constant> are accepted.
  45                 </para>
  46             </listitem>
  47         </varlistentry>
  48         <varlistentry>
  49             <term><parameter>count</parameter></term>
  50             <listitem>
  51                 <para>
  52                     Specifies the number of elements to be rendered.
  53                 </para>
  54             </listitem>
  55         </varlistentry>
  56         <varlistentry>
  57             <term><parameter>type</parameter></term>
  58             <listitem>
  59                 <para>
  60                     Specifies the type of the values in indices. Must be one of <constant>GL_UNSIGNED_BYTE</constant>,
  61                     <constant>GL_UNSIGNED_SHORT</constant>, or <constant>GL_UNSIGNED_INT</constant>.
  62                 </para>
  63             </listitem>
  64         </varlistentry>
  65         <varlistentry>
  66             <term><parameter>indices</parameter></term>
  67             <listitem>
  68                 <para>
  69                     Specifies a pointer to the location where the indices are stored.
  70                 </para>
  71             </listitem>
  72         </varlistentry>
  73         <varlistentry>
  74             <term><parameter>primcount</parameter></term>
  75             <listitem>
  76                 <para>
  77                     Specifies the number of instances of the indexed geometry that should be drawn.
  78                 </para>
  79             </listitem>
  80         </varlistentry>
  81         <varlistentry>
  82             <term><parameter>basevertex</parameter></term>
  83             <listitem>
  84                 <para>
  85                     Specifies a constant that should be added to each element of <parameter>indices</parameter>
  86                     when chosing elements from the enabled vertex arrays.
  87                 </para>
  88             </listitem>
  89         </varlistentry>
  90         </variablelist>
  91     </refsect1>
  92     <refsect1 id="description"><title>Description</title>
  93         <para>
  94             <function>glDrawElementsInstancedBaseVertex</function> behaves identically to
  95             <citerefentry><refentrytitle>glDrawElementsInstanced</refentrytitle></citerefentry> except that the <emphasis>i</emphasis>th element
  96             transferred by the corresponding draw call will be taken from element <parameter>indices</parameter>[i] + <parameter>basevertex</parameter>
  97             of each enabled array. If the resulting value is larger than the maximum value representable by <parameter>type</parameter>,
  98             it is as if the calculation were upconverted to 32-bit unsigned integers (with wrapping on overflow conditions).
  99             The operation is undefined if the sum would be negative.
 100         </para>
 101     </refsect1>
 102     <refsect1 id="notes"><title>Notes</title>
 103         <function>glDrawElementsInstancedBaseVertex</function> is only supported if the GL version is 3.2 or greater.
 104     </refsect1>
 105     <refsect1 id="errors"><title>Errors</title>
 106         <para>
 107             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>mode</parameter> is not an accepted value.
 108         </para>
 109         <para>
 110             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>count</parameter> or <parameter>primcount</parameter> is negative.
 111         </para>
 112         <para>
 113             <constant>GL_INVALID_OPERATION</constant> is generated if a geometry shader is active and <parameter>mode</parameter>
 114             is incompatible with the input primitive type of the geometry shader in the currently installed program object.
 115         </para>
 116         <para>
 117             <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to an
 118             enabled array or the element array and the buffer object's data store is currently mapped.
 119         </para>
 120     </refsect1>
 121     <refsect1 id="seealso"><title>See Also</title>
 122         <para>
 123             <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
 124             <citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry>,
 125             <citerefentry><refentrytitle>glDrawRangeElementsBaseVertex</refentrytitle></citerefentry>,
 126             <citerefentry><refentrytitle>glDrawElementsInstanced</refentrytitle></citerefentry>,
 127             <citerefentry><refentrytitle>glDrawElementsInstancedBaseVertex</refentrytitle></citerefentry>
 128         </para>
 129     </refsect1>
 130     <refsect1 id="Copyright"><title>Copyright</title>
 131         <para>
 132             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
 133             This material may be distributed subject to the terms and conditions set forth in
 134             the Open Publication License, v 1.0, 8 June 1999.
 135             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 136         </para>
 137     </refsect1>
 138 </refentry>