clearindex.3gl   [plain text]


'\" e
'\"! eqn | mmdoc
'\"macro stdmacro
.ds Vn Version 1.2
.ds Dt 24 September 1999
.ds Re Release 1.2.1
.ds Dp Jan 14 18:30
.ds Dm 01 clearinde
.ds Xs 34830 3 clearindex.gl
.TH GLCLEARINDEX 3G
.SH NAME
.B "glClearIndex
\- specify the clear value for the color index buffers

.SH C SPECIFICATION
void \f3glClearIndex\fP(
GLfloat \fIc\fP )
.nf
.fi

.EQ
delim $$
.EN
.SH PARAMETERS
.TP \w'\f2c\fP\ \ 'u 
\f2c\fP
Specifies the index used when the color index buffers are cleared.
The initial value is 0.
.SH DESCRIPTION
\%\f3glClearIndex\fP specifies the index used by \%\f3glClear\fP
to clear the color index buffers.
\f2c\fP is not clamped.
Rather,
\f2c\fP 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 sup m^-^1$,
where $m$ is the number of bits in a color index stored in the frame buffer.
.SH ERRORS
\%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glClearIndex\fP
is executed between the execution of \%\f3glBegin\fP
and the corresponding execution of \%\f3glEnd\fP.
.SH ASSOCIATED GETS
\%\f3glGet\fP with argument \%\f3GL_INDEX_CLEAR_VALUE\fP
.br
\%\f3glGet\fP with argument \%\f3GL_INDEX_BITS\fP
.SH SEE ALSO
\%\f3glClear(3G)\fP