GLTEXCOORDPOINTER(3G)

NAME
glTexCoordPointer - define an array of texture coordinates

C SPECIFICATION

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

PARAMETERS

size
    Specifies the number of coordinates per array element. Must be 1, 2, 3, or 4. The initial value is 4.

type
    Specifies the data type of each texture coordinate. Symbolic constants GL_SHORT, GL_INT, GL_FLOAT, or GL_DOUBLE are accepted. The initial value is GL_FLOAT.

stride
    Specifies the byte offset between consecutive texture coordinate sets. If stride is 0, the array elements are understood to be tightly packed. The initial value is 0.

pointer
    Specifies a pointer to the first coordinate of the first texture coordinate set in the array. The initial value is 0.

DESCRIPTION

glTexCoordPointer specifies the location and data format of an array of texture coordinates to use when rendering. size specifies the number of coordinates per texture coordinate set, and must be 1, 2, 3, or 4. type specifies the data type of each texture coordinate, and stride specifies the byte stride from one texture coordinate set 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().)

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

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

NOTES

glTexCoordPointer is available only if the GL version is 1.1 or greater.

For OpenGL versions 1.3 and greater, or when the ARB_multitexture extension is supported, glTexCoordPointer updates the texture coordinate array state of the active client texture unit, specified with glClientActiveTexture().

Each texture coordinate array is initially disabled and isn't accessed when glArrayElement(), glDrawElements(), glDrawRangeElements(), glDrawArrays(), glMultiDrawArrays(), or glMultiDrawElements() is called.

Execution of glTexCoordPointer 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.

glTexCoordPointer is typically implemented on the client side.

Texture coordinate 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 1, 2, 3, or 4.

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_TEXTURE_COORD_ARRAY

glGet() with argument GL_TEXTURE_COORD_ARRAY_SIZE

glGet() with argument GL_TEXTURE_COORD_ARRAY_TYPE

glGet() with argument GL_TEXTURE_COORD_ARRAY_STRIDE

glGet() with argument GL_TEXTURE_COORD_ARRAY_BUFFER_BINDING

glGet() with argument GL_ARRAY_BUFFER_BINDING

glGetPointerv() with argument GL_TEXTURE_COORD_ARRAY_POINTER

SEE ALSO

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