1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
2 <!-- saved from url=(0013)about:internet -->
3 <?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" /><title>glIndexPointer
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.73.2" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"glIndexPointer"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glIndexPointer — define an array of color indexes
</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">glIndexPointer
</b>(
</code></td><td>GLenum
</td><td><var class=
"pdparam">type
</var>,
</td></tr><tr><td> </td><td>GLsizei
</td><td><var class=
"pdparam">stride
</var>,
</td></tr><tr><td> </td><td>const GLvoid *
</td><td><var class=
"pdparam">pointer
</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>type
</code></em></span></dt><dd><p>
4 Specifies the data type of each color index in the array.
6 <code class=
"constant">GL_UNSIGNED_BYTE
</code>,
7 <code class=
"constant">GL_SHORT
</code>,
8 <code class=
"constant">GL_INT
</code>,
9 <code class=
"constant">GL_FLOAT
</code>,
10 and
<code class=
"constant">GL_DOUBLE
</code>
11 are accepted. The initial value is
<code class=
"constant">GL_FLOAT
</code>.
12 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>stride
</code></em></span></dt><dd><p>
13 Specifies the byte offset between consecutive color indexes.
14 If
<em class=
"parameter"><code>stride
</code></em> is
0, the color indexes are understood to
15 be tightly packed in the array. The initial value is
0.
16 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>pointer
</code></em></span></dt><dd><p>
17 Specifies a pointer to the first index in the array.
18 The initial value is
0.
19 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
20 <code class=
"function">glIndexPointer
</code> specifies the location and data format of an array of color indexes
21 to use when rendering.
22 <em class=
"parameter"><code>type
</code></em> specifies the data type of
23 each color index and
<em class=
"parameter"><code>stride
</code></em> specifies the byte stride from one
24 color index to the next, allowing vertices and attributes
25 to be packed into a single array or stored in separate arrays.
27 If a non-zero named buffer object is bound to the
<code class=
"constant">GL_ARRAY_BUFFER
</code> target
28 (see
<a class=
"citerefentry" href=
"glBindBuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBindBuffer
</span></span></a>) while a color index array is
29 specified,
<em class=
"parameter"><code>pointer
</code></em> is treated as a byte offset into the buffer object's data store.
30 Also, the buffer object binding (
<code class=
"constant">GL_ARRAY_BUFFER_BINDING
</code>) is saved as color index vertex array
31 client-side state (
<code class=
"constant">GL_INDEX_ARRAY_BUFFER_BINDING
</code>).
33 When a color index array is specified,
34 <em class=
"parameter"><code>type
</code></em>,
<em class=
"parameter"><code>stride
</code></em>, and
<em class=
"parameter"><code>pointer
</code></em> are saved as client-side
35 state, in addition to the current vertex array buffer object binding.
37 To enable and disable the color index array, call
38 <a class=
"citerefentry" href=
"glEnableClientState.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glEnableClientState
</span></span></a> and
<a class=
"citerefentry" href=
"glDisableClientState.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDisableClientState
</span></span></a> with the argument
39 <code class=
"constant">GL_INDEX_ARRAY
</code>. If
40 enabled, the color index array is used
41 when
<a class=
"citerefentry" href=
"glDrawArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawArrays
</span></span></a>,
<a class=
"citerefentry" href=
"glMultiDrawArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glMultiDrawArrays
</span></span></a>,
<a class=
"citerefentry" href=
"glDrawElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawElements
</span></span></a>,
42 <a class=
"citerefentry" href=
"glMultiDrawElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glMultiDrawElements
</span></span></a>,
<a class=
"citerefentry" href=
"glDrawRangeElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawRangeElements
</span></span></a>, or
43 <a class=
"citerefentry" href=
"glArrayElement.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glArrayElement
</span></span></a> is called.
44 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"notes"></a><h2>Notes
</h2><p>
45 <code class=
"function">glIndexPointer
</code> is available only if the GL version is
1.1 or greater.
47 Color indexes are not supported for interleaved vertex array formats
48 (see
<a class=
"citerefentry" href=
"glInterleavedArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glInterleavedArrays
</span></span></a>).
50 The color index array is initially disabled and isn't accessed when
51 <a class=
"citerefentry" href=
"glArrayElement.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glArrayElement
</span></span></a>,
<a class=
"citerefentry" href=
"glDrawElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawElements
</span></span></a>,
<a class=
"citerefentry" href=
"glDrawRangeElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawRangeElements
</span></span></a>,
52 <a class=
"citerefentry" href=
"glDrawArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawArrays
</span></span></a>,
<a class=
"citerefentry" href=
"glMultiDrawArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glMultiDrawArrays
</span></span></a>, or
<a class=
"citerefentry" href=
"glMultiDrawElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glMultiDrawElements
</span></span></a>
55 Execution of
<code class=
"function">glIndexPointer
</code> is not allowed between
56 <a class=
"citerefentry" href=
"glBegin.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBegin
</span></span></a> and the corresponding
<a class=
"citerefentry" href=
"glEnd.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glEnd
</span></span></a>,
57 but an error may or may not be generated. If an error is not generated,
58 the operation is undefined.
60 <code class=
"function">glIndexPointer
</code> is typically implemented on the client side.
62 Color index array parameters are client-side state and are
63 therefore not saved or restored by
<a class=
"citerefentry" href=
"glPushAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPushAttrib
</span></span></a> and
<a class=
"citerefentry" href=
"glPopAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPopAttrib
</span></span></a>.
64 Use
<a class=
"citerefentry" href=
"glPushClientAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPushClientAttrib
</span></span></a> and
65 <a class=
"citerefentry" href=
"glPopClientAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPopClientAttrib
</span></span></a> instead.
66 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
67 <code class=
"constant">GL_INVALID_ENUM
</code> is generated if
<em class=
"parameter"><code>type
</code></em> is not an accepted value.
69 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>stride
</code></em> is negative.
70 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"associatedgets"></a><h2>Associated Gets
</h2><p>
71 <a class=
"citerefentry" href=
"glIsEnabled.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glIsEnabled
</span></span></a> with argument
<code class=
"constant">GL_INDEX_ARRAY
</code>
73 <a class=
"citerefentry" href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_INDEX_ARRAY_TYPE
</code>
75 <a class=
"citerefentry" href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_INDEX_ARRAY_STRIDE
</code>
77 <a class=
"citerefentry" href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_INDEX_ARRAY_BUFFER_BINDING
</code>
79 <a class=
"citerefentry" href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_ARRAY_BUFFER_BINDING
</code>
81 <a class=
"citerefentry" href=
"glGetPointerv.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetPointerv
</span></span></a> with argument
<code class=
"constant">GL_INDEX_ARRAY_POINTER
</code>
82 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
83 <a class=
"citerefentry" href=
"glArrayElement.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glArrayElement
</span></span></a>,
84 <a class=
"citerefentry" href=
"glBindBuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBindBuffer
</span></span></a>,
85 <a class=
"citerefentry" href=
"glColorPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glColorPointer
</span></span></a>,
86 <a class=
"citerefentry" href=
"glDisableClientState.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDisableClientState
</span></span></a>,
87 <a class=
"citerefentry" href=
"glDrawArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawArrays
</span></span></a>,
88 <a class=
"citerefentry" href=
"glDrawElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawElements
</span></span></a>,
89 <a class=
"citerefentry" href=
"glDrawRangeElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawRangeElements
</span></span></a>,
90 <a class=
"citerefentry" href=
"glEdgeFlagPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glEdgeFlagPointer
</span></span></a>,
91 <a class=
"citerefentry" href=
"glEnableClientState.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glEnableClientState
</span></span></a>,
92 <a class=
"citerefentry" href=
"glFogCoordPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glFogCoordPointer
</span></span></a>,
93 <a class=
"citerefentry" href=
"glIndex.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glIndex
</span></span></a>,
94 <a class=
"citerefentry" href=
"glInterleavedArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glInterleavedArrays
</span></span></a>,
95 <a class=
"citerefentry" href=
"glMultiDrawArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glMultiDrawArrays
</span></span></a>,
96 <a class=
"citerefentry" href=
"glMultiDrawElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glMultiDrawElements
</span></span></a>,
97 <a class=
"citerefentry" href=
"glNormalPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glNormalPointer
</span></span></a>,
98 <a class=
"citerefentry" href=
"glPopClientAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPopClientAttrib
</span></span></a>,
99 <a class=
"citerefentry" href=
"glPushClientAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPushClientAttrib
</span></span></a>,
100 <a class=
"citerefentry" href=
"glSecondaryColorPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glSecondaryColorPointer
</span></span></a>,
101 <a class=
"citerefentry" href=
"glTexCoordPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexCoordPointer
</span></span></a>,
102 <a class=
"citerefentry" href=
"glVertexAttribPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glVertexAttribPointer
</span></span></a>,
103 <a class=
"citerefentry" href=
"glVertexPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glVertexPointer
</span></span></a>
104 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
105 Copyright
<span class=
"trademark"></span>©
1991-
2006
106 Silicon Graphics, Inc. This document is licensed under the SGI
107 Free Software B License. For details, see
108 <a class=
"ulink" href=
"http://oss.sgi.com/projects/FreeB/" target=
"_top">http://oss.sgi.com/projects/FreeB/
</a>.
109 </p></div></div></body></html>