895de7239eed89078ee8af68b58f7d2253ae22b3
[clinton/guile-figl.git] / upstream-man-pages / man3 / xhtml / glDrawRangeElementsBaseVertex.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3 <!-- saved from url=(0013)about:internet -->
4 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glDrawRangeElementsBaseVertex</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glDrawRangeElementsBaseVertex"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glDrawRangeElementsBaseVertex — render primitives from array data with a per-element offset</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glDrawRangeElementsBaseVertex</b>(</code></td><td>GLenum  </td><td><var class="pdparam">mode</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">start</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">end</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">count</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">type</var>, </td></tr><tr><td> </td><td>GLvoid * </td><td><var class="pdparam">indices</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">basevertex</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>mode</code></em></span></dt><dd><p>
5 Specifies what kind of primitives to render.
6 Symbolic constants
7 <code class="constant">GL_POINTS</code>, <code class="constant">GL_LINE_STRIP</code>, <code class="constant">GL_LINE_LOOP</code>,
8 <code class="constant">GL_LINES</code>, <code class="constant">GL_TRIANGLE_STRIP</code>, <code class="constant">GL_TRIANGLE_FAN</code>,
9 and <code class="constant">GL_TRIANGLES</code> are accepted.
10 </p></dd><dt><span class="term"><em class="parameter"><code>start</code></em></span></dt><dd><p>
11 Specifies the minimum array index contained in <em class="parameter"><code>indices</code></em>.
12 </p></dd><dt><span class="term"><em class="parameter"><code>end</code></em></span></dt><dd><p>
13 Specifies the maximum array index contained in <em class="parameter"><code>indices</code></em>.
14 </p></dd><dt><span class="term"><em class="parameter"><code>count</code></em></span></dt><dd><p>
15 Specifies the number of elements to be rendered.
16 </p></dd><dt><span class="term"><em class="parameter"><code>type</code></em></span></dt><dd><p>
17 Specifies the type of the values in indices. Must be one of <code class="constant">GL_UNSIGNED_BYTE</code>,
18 <code class="constant">GL_UNSIGNED_SHORT</code>, or <code class="constant">GL_UNSIGNED_INT</code>.
19 </p></dd><dt><span class="term"><em class="parameter"><code>indices</code></em></span></dt><dd><p>
20 Specifies a pointer to the location where the indices are stored.
21 </p></dd><dt><span class="term"><em class="parameter"><code>basevertex</code></em></span></dt><dd><p>
22 Specifies a constant that should be added to each element of <em class="parameter"><code>indices</code></em>
23 when chosing elements from the enabled vertex arrays.
24 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
25 <code class="function">glDrawRangeElementsBaseVertex</code> is a restricted form of
26 <a href="glDrawElementsBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsBaseVertex</span></span></a>. <em class="parameter"><code>mode</code></em>,
27 <em class="parameter"><code>start</code></em>, <em class="parameter"><code>end</code></em>, <em class="parameter"><code>count</code></em> and <em class="parameter"><code>basevertex</code></em> match
28 the corresponding arguments to <a href="glDrawElementsBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsBaseVertex</span></span></a>, with the additional
29 constraint that all values in the array <em class="parameter"><code>indices</code></em> must lie between <em class="parameter"><code>start</code></em> and <em class="parameter"><code>end</code></em>,
30 inclusive, prior to adding <em class="parameter"><code>basevertex</code></em>. Index values lying outside the range [<em class="parameter"><code>start</code></em>, <em class="parameter"><code>end</code></em>]
31 are treated in the same way as <a href="glDrawElementsBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsBaseVertex</span></span></a>. The <span class="emphasis"><em>i</em></span>th element
32 transferred by the corresponding draw call will be taken from element <em class="parameter"><code>indices</code></em>[i] + <em class="parameter"><code>basevertex</code></em> of each enabled
33 array. If the resulting value is larger than the maximum value representable by <em class="parameter"><code>type</code></em>, it is as if the calculation were upconverted to
34 32-bit unsigned integers (with wrapping on overflow conditions). The operation is undefined if the sum would be negative.
35 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><code class="function">glDrawRangeElementsBaseVertex</code> is only supported if the GL version is 3.2 or greater, or if
36 the <code class="code">ARB_draw_elements_base_vertex</code> extension is supported.
37 </div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
38 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>mode</code></em> is not an accepted value.
39 </p><p>
40 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>count</code></em> is negative.
41 </p><p>
42 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>end</code></em> &lt; <em class="parameter"><code>start</code></em>.
43 </p><p>
44 <code class="constant">GL_INVALID_OPERATION</code> is generated if a geometry shader is active and <em class="parameter"><code>mode</code></em>
45 is incompatible with the input primitive type of the geometry shader in the currently installed program object.
46 </p><p>
47 <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to an
48 enabled array or the element array and the buffer object's data store is currently mapped.
49 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
50 <a href="glDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>,
51 <a href="glDrawElementsBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsBaseVertex</span></span></a>,
52 <a href="glDrawRangeElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>,
53 <a href="glDrawElementsInstanced.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsInstanced</span></span></a>,
54 <a href="glDrawElementsInstancedBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsInstancedBaseVertex</span></span></a>
55 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
56 Copyright <span class="trademark"></span>© 2010 Khronos Group.
57 This material may be distributed subject to the terms and conditions set forth in
58 the Open Publication License, v 1.0, 8 June 1999.
59 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
60 </p></div></div></body></html>