glClearIndex(3) Mac OS X Manual Page

Mac Dev Center Mac OS X Reference Library General Mac OS X Man Pages

This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

For more information about the manual page format, see the manual page for manpages(5).
For more information about this technology, look for other documentation in the Apple Reference Library.
For general information about writing shell scripts, read Shell Scripting Primer.


GLCLEARINDEX(3G)                                                                            GLCLEARINDEX(3G)



NAME
       glClearIndex - specify the clear value for the color index buffers


C SPECIFICATION
       void glClearIndex( GLfloat c )


PARAMETERS
       c  Specifies the index used when the color index buffers are cleared.  The initial value is 0.

DESCRIPTION
       glClearIndex specifies the index used by glClear to clear the color index buffers.  c is not clamped.
       Rather, c is converted to a fixed-point value with unspecified precision to the right of  the  binary
       point.   The  integer  part of this value is then masked with 2^m, where m is the number of bits in a
       color index stored in the frame buffer.

ERRORS
       GL_INVALID_OPERATION is generated if glClearIndex is executed between the execution  of  glBegin  and
       the corresponding execution of glEnd.

ASSOCIATED GETS
       glGet with argument GL_INDEX_CLEAR_VALUE
       glGet with argument GL_INDEX_BITS

SEE ALSO
       glClear(3G)




                                                                                            GLCLEARINDEX(3G)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors: Report errors in the content of this documentation to the OpenGL project.
Bug reports: Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems: Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you?