xenocara/doc/gl-docs/GL/gl/cleardepth.3gl
2006-11-29 17:00:35 +00:00

37 lines
973 B
Plaintext

'\" te
'\"! tbl|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 cleardept
.ds Xs 62352 3 cleardepth.gl
.TH GLCLEARDEPTH 3G
.SH NAME
.B "glClearDepth
\- specify the clear value for the depth buffer
.SH C SPECIFICATION
void \f3glClearDepth\fP(
GLclampd \fIdepth\fP )
.nf
.fi
.SH PARAMETERS
.TP \w'\f2depth\fP\ \ 'u
\f2depth\fP
Specifies the depth value used when the depth buffer is cleared. The
initial value is 1.
.SH DESCRIPTION
\%\f3glClearDepth\fP specifies the depth value used by \%\f3glClear\fP to clear the depth buffer.
Values specified by \%\f3glClearDepth\fP are clamped to the range [0,\ 1].
.SH ERRORS
\%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glClearDepth\fP
is executed between the execution of \%\f3glBegin\fP
and the corresponding execution of \%\f3glEnd\fP.
.SH ASSOCIATED GETS
\%\f3glGet\fP with argument \%\f3GL_DEPTH_CLEAR_VALUE\fP
.SH SEE ALSO
\%\f3glClear(3G)\fP