2013-10-10 23:58:54 +00:00
<?xml version="1.0" encoding="UTF-8"?>
< !DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id= "glMultiDrawElementsBaseVertex" >
<refmeta >
<refmetainfo >
<copyright >
<year > 2010</year>
<holder > Khronos Group</holder>
</copyright>
</refmetainfo>
<refentrytitle > glMultiDrawElementsBaseVertex</refentrytitle>
<manvolnum > 3G</manvolnum>
</refmeta>
<refnamediv >
<refname > glMultiDrawElementsBaseVertex</refname>
<refpurpose > render multiple sets of primitives by specifying indices of array data elements and an index to apply to each index</refpurpose>
</refnamediv>
<refsynopsisdiv > <title > C Specification</title>
<funcsynopsis >
<funcprototype >
<funcdef > void <function > glMultiDrawElementsBaseVertex</function> </funcdef>
<paramdef > GLenum <parameter > mode</parameter> </paramdef>
<paramdef > const GLsizei *<parameter > count</parameter> </paramdef>
<paramdef > GLenum <parameter > type</parameter> </paramdef>
<paramdef > const GLvoid **<parameter > indices</parameter> </paramdef>
<paramdef > GLsizei <parameter > primcount</parameter> </paramdef>
<paramdef > GLint *<parameter > basevertex</parameter> </paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- eqn: ignoring delim $$ -->
<refsect1 id= "parameters" > <title > Parameters</title>
<variablelist >
<varlistentry >
<term > <parameter > mode</parameter> </term>
<listitem >
<para >
Specifies what kind of primitives to render.
Symbolic constants
<constant > GL_POINTS</constant> ,
<constant > GL_LINE_STRIP</constant> ,
<constant > GL_LINE_LOOP</constant> ,
<constant > GL_LINES</constant> ,
<constant > GL_LINE_STRIP_ADJACENCY</constant> ,
<constant > GL_LINES_ADJACENCY</constant> ,
<constant > GL_TRIANGLE_STRIP</constant> ,
<constant > GL_TRIANGLE_FAN</constant> ,
<constant > GL_TRIANGLES</constant> ,
<constant > GL_TRIANGLE_STRIP_ADJACENCY</constant> ,
<constant > GL_TRIANGLES_ADJACENCY</constant> and <constant > GL_PATCHES</constant>
are accepted.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > count</parameter> </term>
<listitem >
<para >
Points to an array of the elements counts.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > type</parameter> </term>
<listitem >
<para >
Specifies the type of the values in <parameter > indices</parameter> . Must be one of
<constant > GL_UNSIGNED_BYTE</constant> , <constant > GL_UNSIGNED_SHORT</constant> , or
<constant > GL_UNSIGNED_INT</constant> .
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > indices</parameter> </term>
<listitem >
<para >
Specifies a pointer to the location where the indices are stored.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > primcount</parameter> </term>
<listitem >
<para >
Specifies the size of the <parameter > count</parameter> array.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > basevertex</parameter> </term>
<listitem >
<para >
Specifies a pointer to the location where the base vertices are stored.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id= "description" > <title > Description</title>
<para >
<function > glMultiDrawElementsBaseVertex</function> behaves identically to <citerefentry > <refentrytitle > glDrawElementsBaseVertex</refentrytitle> </citerefentry> ,
except that <parameter > primcount</parameter> separate lists of elements are specifried instead.
</para>
<para >
It has the same effect as:
<programlisting > for (int i = 0; i < <parameter > primcount</parameter> ; i++)
if (<parameter > count</parameter> [i] > 0)
glDrawElementsBaseVertex(<parameter > mode</parameter> ,
<parameter > count</parameter> [i],
<parameter > type</parameter> ,
<parameter > indices[i]</parameter> ,
<parameter > basevertex[i]</parameter> );</programlisting>
</para>
</refsect1>
<refsect1 id= "notes" > <title > Notes</title>
<para >
<function > glMultiDrawElementsBaseVertex</function> is available only if the GL version is 3.1 or greater.
</para>
<para >
<constant > GL_LINE_STRIP_ADJACENCY</constant> ,
<constant > GL_LINES_ADJACENCY</constant> ,
<constant > GL_TRIANGLE_STRIP_ADJACENCY</constant> and
<constant > GL_TRIANGLES_ADJACENCY</constant>
are available only if the GL version is 3.2 or greater.
</para>
</refsect1>
<refsect1 id= "errors" > <title > Errors</title>
<para >
<constant > GL_INVALID_ENUM</constant> is generated if <parameter > mode</parameter> is not an accepted value.
</para>
<para >
<constant > GL_INVALID_VALUE</constant> is generated if <parameter > primcount</parameter> is negative.
</para>
<para >
<constant > GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to an
enabled array or the element array and the buffer object's data store is currently mapped.
</para>
</refsect1>
<refsect1 id= "seealso" > <title > See Also</title>
<para >
<citerefentry > <refentrytitle > glMultiDrawElements</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glDrawElementsBaseVertex</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glDrawArrays</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glVertexAttribPointer</refentrytitle> </citerefentry>
</para>
</refsect1>
<refsect1 id= "Copyright" > <title > Copyright</title>
<para >
Copyright <trademark class= "copyright" > </trademark> 2010 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<ulink url= "http://opencontent.org/openpub/" > http://opencontent.org/openpub/</ulink> .
</para>
</refsect1>
</refentry>
