Museum

glIndexPointer(3G)             OpenGL Reference             glIndexPointer(3G)



NAME
     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 GLUNSIGNEDBYTE, GLSHORT, GLINT, GLFLOAT,
              and GLDOUBLE are accepted.

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

     pointer  Specifies a pointer to the first index in the array.

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 gives the byte stride from one color index to
     the next allowing vertexes and attributes to be packed into a single
     array or stored in separate arrays.  (Single-array storage may be more
     efficient on some implementations; see glInterleavedArrays.)

     type, stride, and pointer are saved as client-side state.

     The color index array is initially disabled. To enable and disable the
     array, call glEnableClientState and glDisableClientState with the
     argument GLINDEXARRAY. If enabled, the color index array is used when
     glDrawArrays, glDrawElements or glArrayElement is called.

     Use glDrawArrays to construct a sequence of primitives (all of the same
     type) from prespecified vertex and vertex attribute arrays.  Use
     glArrayElement to specify primitives by indexing vertexes and vertex
     attributes and glDrawElements to construct a sequence of primitives by
     indexing vertexes and vertex attributes.

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

     The color index array is initially disabled, and it isn't accessed when
     glArrayElement, glDrawElements or glDrawArrays 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.




                                                                        Page 1

glIndexPointer(3G)             OpenGL Reference             glIndexPointer(3G)



     glIndexPointer is typically implemented on the client side.

     Since the color index array parameters are client-side state, they are
     not saved or restored by glPushAttrib and glPopAttrib.  Use
     glPushClientAttrib and
     glPopClientAttrib instead.

ERRORS
     GLINVALIDENUM is generated if type is not an accepted value.

     GLINVALIDVALUE is generated if stride is negative.

ASSOCIATED GETS
     glIsEnabled with argument GLINDEXARRAY
     glGet with argument GLINDEXARRAYTYPE
     glGet with argument GLINDEXARRAYSTRIDE
     glGetPointerv with argument GLINDEXARRAYPOINTER


MACHINE DEPENDENCIES
     On RealityEngine, RealityEngine2, and VTX systems, do not enable or
     disable GLVERTEXARRAY, GLVERTEXARRAYEXT, GLNORMALARRAY,
     GLNORMALARRAYEXT, GLCOLORARRAY, GLCOLORARRAYEXT,
     GLINDEXARRAY,GLINDEXARRAYEXT, GLTEXTURECOORDARRAY,
     GLTEXTURECOORDARRAYEXT, GLEDGEFLAGARRAY or GLEDGEFLAGARRAYEXT
     between a call to glNewList and the corresponding call to glEndList.
     Instead, enable or disable before the call to glNewList.


SEE ALSO
     glArrayElement, glColorPointer, glDrawArrays, glDrawElements,
     glEdgeFlagPointer, glEnable, glGetPointerv, glInterleavedArrays,
     glNormalPointer, glPopClientAttrib, glPushClientAttrib,
     glTexCoordPointer, glVertexPointer





















                                                                        Page 2