GLSECONDARYCOLORPOIN(3G)

NAME
glSecondaryColorPointer - define an array of secondary colors

C SPECIFICATION

void glSecondaryColorPointer(GLint size, GLenum type, GLsizei stride, const GLvoid * pointer);

PARAMETERS

size
    Specifies the number of components per color. Must be 3.

type
    Specifies the data type of each color component in the array. Symbolic constants GL_BYTE, GL_UNSIGNED_BYTE, GL_SHORT, GL_UNSIGNED_SHORT, GL_INT, GL_UNSIGNED_INT, GL_FLOAT, or GL_DOUBLE are accepted. The initial value is GL_FLOAT.

stride
    Specifies the byte offset between consecutive colors. If stride is 0, 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. The initial value is 0.

DESCRIPTION

glSecondaryColorPointer specifies the location and data format of an array of color components to use when rendering. size specifies the number of components per color, and must be 3. 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.

If a non-zero named buffer object is bound to the GL_ARRAY_BUFFER target (see glBindBuffer()) while a secondary color 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 secondary color vertex array client-side state (GL_SECONDARY_COLOR_ARRAY_BUFFER_BINDING).

When a secondary color array is specified, size, 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 secondary color array, call glEnableClientState() and glDisableClientState() with the argument GL_SECONDARY_COLOR_ARRAY. If enabled, the secondary color array is used when glArrayElement(), glDrawArrays(), glMultiDrawArrays(), glDrawElements(), glMultiDrawElements(), or glDrawRangeElements() is called.

NOTES

glSecondaryColorPointer is available only if the GL version is 1.4 or greater.

Secondary colors are not supported for interleaved vertex array formats (see glInterleavedArrays()).

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

Execution of glSecondaryColorPointer 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 undefined.

glSecondaryColorPointer is typically implemented on the client side.

Secondary color 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_VALUE is generated if size is not 3.

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_SECONDARY_COLOR_ARRAY

glGet() with argument GL_SECONDARY_COLOR_ARRAY_SIZE

glGet() with argument GL_SECONDARY_COLOR_ARRAY_TYPE

glGet() with argument GL_SECONDARY_COLOR_ARRAY_STRIDE

glGet() with argument GL_SECONDARY_COLOR_ARRAY_BUFFER_BINDING

glGet() with argument GL_ARRAY_BUFFER_BINDING

glGetPointerv() with argument GL_SECONDARY_COLOR_ARRAY_POINTER

SEE ALSO

glArrayElement(), glBindBuffer(), glColorPointer(), glDisableClientState(), glDrawArrays(), glDrawElements(), glDrawRangeElements(), glEdgeFlagPointer(), glEnableClientState(), glFogCoordPointer(), glIndexPointer(), glInterleavedArrays(), glMultiDrawArrays(), glMultiDrawElements(), glNormalPointer(), glPopClientAttrib(), glPushClientAttrib(), glSecondaryColor(), 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/.