MyWebUniversity.com Home Page
 



Darwin Mac OS X man pages main menu
GLCOLORPOINTER(3G)                                          GLCOLORPOINTER(3G)



NAME
       glColorPointer - define an array of colors


C SPECIFICATION
       void glColorPointer( GLint size,
                            GLenum type,
                            GLsizei stride,
                            const GLvoid *pointer )


PARAMETERS
       size     Specifies  the number of components per color. Must be 3 or 4.
                The initial value is 4.

       type     Specifies the data type of each color component in the  array.
                Symbolic   constants   GLBYTE,   GLUNSIGNEDBYTE,  GLSHORT,
                GLUNSIGNEDSHORT,  GLINT,  GLUNSIGNEDINT,  GLFLOAT,   and
                GLDOUBLE are accepted.  The initial value is GLFLOAT.

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

       pointer  Specifies  a pointer to the first component of the first color
                element in the array.

DESCRIPTION
       glColorPointer specifies the location and data  of an  array  of  color
       components  to use when rendering.  size specifies the number of compo-
       nents per color, and must be 3 or 4.  type specifies the data  type  of
       each  color  component,  and  stride specifies the byte stride from one
       color to the next allowing vertices 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.)

       When a color array is specified, size, type, stride,  and  pointer  are
       saved as client-side state.

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

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

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

       Execution  of  glColorPointer  is  not allowed between the execution of
       glBegin and the corresponding execution of glEnd, but an error  may  or
       may  not be generated. If no error is generated, the operation is unde-
       fined.

       glColorPointer is typically implemented on the client side.

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

ERORS
       GLINVALIDVALUE is generated if size is not 3 or 4.

       GLINVALIDENUM is generated if type is not an accepted value.

       GLINVALIDVALUE is generated if stride is negative.

ASOCIATED GETS
       glIsEnabled with argument GLCOLORARAY
       glGet with argument GLCOLORARAYSIZE
       glGet with argument GLCOLORARAYTYPE
       glGet with argument GLCOLORARAYSTRIDE
       glGetPointerv with argument GLCOLORARAYPOINTER

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



                                                            GLCOLORPOINTER(3G)
Darwin Mac OS X man pages main menu

Contact us      |       About us      |       Term of use      |       Copyright © 2000-2010 MyWebUniversity.com ™