[clinton/guile-figl.git] / upstream-doc / man3 / glDrawRangeElementsBaseVertex.xml

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