1991-2006
Silicon Graphics, Inc.
glIndexPointer
3G

# glIndexPointer

define an array of color indexes

## C Specification

                    void glIndexPointer
                    GLenum type
                    GLsizei stride
                    const GLvoid * pointer

## Parameters

`type`

  Specifies the data type of each color index in the array. Symbolic constants `GL_UNSIGNED_BYTE`, `GL_SHORT`, `GL_INT`, `GL_FLOAT`, and `GL_DOUBLE` are accepted. The initial value is `GL_FLOAT`.

`stride`

  Specifies the byte offset between consecutive color indexes. If `stride` is 0, the color indexes are understood to be tightly packed in the array. The initial value is 0.

`pointer`

  Specifies a pointer to the first index in the array. The initial value is 0.

## Description

`glIndexPointer` specifies the location and data format of an array of color indexes to use when rendering. `type` specifies the data type of each color index and `stride` specifies the byte stride from one color index to the next, allowing vertices and attributes to be packed into a single array or stored in separate arrays.

If a non-zero named buffer object is bound to the `GL_ARRAY_BUFFER` target (see glBindBuffer) while a color index array is specified, `pointer` is treated as a byte offset into the buffer object's data store. Also, the buffer object binding (`GL_ARRAY_BUFFER_BINDING`) is saved as color index vertex array client-side state (`GL_INDEX_ARRAY_BUFFER_BINDING`).

When a color index array is specified, `type`, `stride`, and `pointer` are saved as client-side state, in addition to the current vertex array buffer object binding.

To enable and disable the color index array, call glEnableClientState and glDisableClientState with the argument `GL_INDEX_ARRAY`. If enabled, the color index array is used when glDrawArrays, glMultiDrawArrays, glDrawElements, glMultiDrawElements, glDrawRangeElements, or glArrayElement is called.

## Notes

`glIndexPointer` is available only if the GL version is 1.1 or greater.

Color indexes are not supported for interleaved vertex array formats (see glInterleavedArrays).

The color index array is initially disabled and isn't accessed when glArrayElement, glDrawElements, glDrawRangeElements, glDrawArrays, glMultiDrawArrays, or glMultiDrawElements is called.

Execution of `glIndexPointer` is not allowed between glBegin and the corresponding glEnd, but an error may or may not be generated. If an error is not generated, the operation is undefined.

`glIndexPointer` is typically implemented on the client side.

Color index array parameters are client-side state and are therefore not saved or restored by glPushAttrib and glPopAttrib. Use glPushClientAttrib and glPopClientAttrib instead.

## Errors

`GL_INVALID_ENUM` is generated if `type` is not an accepted value.

`GL_INVALID_VALUE` is generated if `stride` is negative.

## Associated Gets

glIsEnabled with argument `GL_INDEX_ARRAY`

glGet with argument `GL_INDEX_ARRAY_TYPE`

glGet with argument `GL_INDEX_ARRAY_STRIDE`

glGet with argument `GL_INDEX_ARRAY_BUFFER_BINDING`

glGet with argument `GL_ARRAY_BUFFER_BINDING`

glGetPointerv with argument `GL_INDEX_ARRAY_POINTER`

## See Also

glArrayElement, glBindBuffer, glColorPointer, glDisableClientState, glDrawArrays, glDrawElements, glDrawRangeElements, glEdgeFlagPointer, glEnableClientState, glFogCoordPointer, glIndex, glInterleavedArrays, glMultiDrawArrays, glMultiDrawElements, glNormalPointer, glPopClientAttrib, glPushClientAttrib, glSecondaryColorPointer, glTexCoordPointer, glVertexAttribPointer, glVertexPointer

## Copyright

Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.