--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>\r
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
+ "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
+<refentry id="glDrawRangeElementsBaseVertex">\r
+ <refmeta>\r
+ <refmetainfo>\r
+ <copyright>\r
+ <year>2010</year>\r
+ <holder>Khronos Group</holder>\r
+ </copyright>\r
+ </refmetainfo>\r
+ <refentrytitle>glDrawRangeElementsBaseVertex</refentrytitle>\r
+ <manvolnum>3G</manvolnum>\r
+ </refmeta>\r
+ <refnamediv>\r
+ <refname>glDrawRangeElementsBaseVertex</refname>\r
+ <refpurpose>render primitives from array data with a per-element offset</refpurpose>\r
+ </refnamediv>\r
+ <refsynopsisdiv><title>C Specification</title>\r
+ <funcsynopsis>\r
+ <funcprototype>\r
+ <funcdef>void <function>glDrawRangeElementsBaseVertex</function></funcdef>\r
+ <paramdef>GLenum <parameter>mode</parameter></paramdef>\r
+ <paramdef>GLuint <parameter>start</parameter></paramdef>\r
+ <paramdef>GLuint <parameter>end</parameter></paramdef>\r
+ <paramdef>GLsizei <parameter>count</parameter></paramdef>\r
+ <paramdef>GLenum <parameter>type</parameter></paramdef>\r
+ <paramdef>GLvoid *<parameter>indices</parameter></paramdef>\r
+ <paramdef>GLint <parameter>basevertex</parameter></paramdef>\r
+ </funcprototype>\r
+ </funcsynopsis>\r
+ </refsynopsisdiv>\r
+ <!-- eqn: ignoring delim $$ -->\r
+ <refsect1 id="parameters"><title>Parameters</title>\r
+ <variablelist>\r
+ <varlistentry>\r
+ <term><parameter>mode</parameter></term>\r
+ <listitem>\r
+ <para>\r
+ Specifies what kind of primitives to render.\r
+ Symbolic constants\r
+ <constant>GL_POINTS</constant>, <constant>GL_LINE_STRIP</constant>, <constant>GL_LINE_LOOP</constant>,\r
+ <constant>GL_LINES</constant>, <constant>GL_TRIANGLE_STRIP</constant>, <constant>GL_TRIANGLE_FAN</constant>,\r
+ and <constant>GL_TRIANGLES</constant> are accepted.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+ <varlistentry>\r
+ <term><parameter>start</parameter></term>\r
+ <listitem>\r
+ <para>\r
+ Specifies the minimum array index contained in <parameter>indices</parameter>.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+ <varlistentry>\r
+ <term><parameter>end</parameter></term>\r
+ <listitem>\r
+ <para>\r
+ Specifies the maximum array index contained in <parameter>indices</parameter>.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+ <varlistentry>\r
+ <term><parameter>count</parameter></term>\r
+ <listitem>\r
+ <para>\r
+ Specifies the number of elements to be rendered.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+ <varlistentry>\r
+ <term><parameter>type</parameter></term>\r
+ <listitem>\r
+ <para>\r
+ Specifies the type of the values in indices. Must be one of <constant>GL_UNSIGNED_BYTE</constant>,\r
+ <constant>GL_UNSIGNED_SHORT</constant>, or <constant>GL_UNSIGNED_INT</constant>.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+ <varlistentry>\r
+ <term><parameter>indices</parameter></term>\r
+ <listitem>\r
+ <para>\r
+ Specifies a pointer to the location where the indices are stored.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+ <varlistentry>\r
+ <term><parameter>basevertex</parameter></term>\r
+ <listitem>\r
+ <para>\r
+ Specifies a constant that should be added to each element of <parameter>indices</parameter>\r
+ when chosing elements from the enabled vertex arrays.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+ </variablelist>\r
+ </refsect1>\r
+ <refsect1 id="description"><title>Description</title>\r
+ <para>\r
+ <function>glDrawRangeElementsBaseVertex</function> is a restricted form of\r
+ <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>. <parameter>mode</parameter>,\r
+ <parameter>start</parameter>, <parameter>end</parameter>, <parameter>count</parameter> and <parameter>basevertex</parameter> match\r
+ the corresponding arguments to <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>, with the additional\r
+ constraint that all values in the array <parameter>indices</parameter> must lie between <parameter>start</parameter> and <parameter>end</parameter>,\r
+ inclusive, prior to adding <parameter>basevertex</parameter>. Index values lying outside the range [<parameter>start</parameter>, <parameter>end</parameter>]\r
+ are treated in the same way as <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>. The <emphasis>i</emphasis>th element\r
+ transferred by the corresponding draw call will be taken from element <parameter>indices</parameter>[i] + <parameter>basevertex</parameter> of each enabled\r
+ 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\r
+ 32-bit unsigned integers (with wrapping on overflow conditions). The operation is undefined if the sum would be negative.\r
+ </para>\r
+ </refsect1>\r
+ <refsect1 id="notes"><title>Notes</title>\r
+ <function>glDrawRangeElementsBaseVertex</function> is only supported if the GL version is 3.2 or greater, or if\r
+ the <code>ARB_draw_elements_base_vertex</code> extension is supported.\r
+ </refsect1>\r
+ <refsect1 id="errors"><title>Errors</title>\r
+ <para>\r
+ <constant>GL_INVALID_ENUM</constant> is generated if <parameter>mode</parameter> is not an accepted value.\r
+ </para>\r
+ <para>\r
+ <constant>GL_INVALID_VALUE</constant> is generated if <parameter>count</parameter> is negative.\r
+ </para>\r
+ <para>\r
+ <constant>GL_INVALID_VALUE</constant> is generated if <parameter>end</parameter> < <parameter>start</parameter>.\r
+ </para>\r
+ <para>\r
+ <constant>GL_INVALID_OPERATION</constant> is generated if a geometry shader is active and <parameter>mode</parameter>\r
+ is incompatible with the input primitive type of the geometry shader in the currently installed program object.\r
+ </para>\r
+ <para>\r
+ <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to an\r
+ enabled array or the element array and the buffer object's data store is currently mapped.\r
+ </para>\r
+ </refsect1>\r
+ <refsect1 id="seealso"><title>See Also</title>\r
+ <para>\r
+ <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,\r
+ <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>,\r
+ <citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry>,\r
+ <citerefentry><refentrytitle>glDrawElementsInstanced</refentrytitle></citerefentry>,\r
+ <citerefentry><refentrytitle>glDrawElementsInstancedBaseVertex</refentrytitle></citerefentry>\r
+ </para>\r
+ </refsect1>\r
+ <refsect1 id="Copyright"><title>Copyright</title>\r
+ <para>\r
+ Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r
+ This material may be distributed subject to the terms and conditions set forth in \r
+ the Open Publication License, v 1.0, 8 June 1999.\r
+ <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
+ </para>\r
+ </refsect1>\r
+</refentry>\r
HCoop / clinton / guile-figl.git / blobdiff