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

47 lines
1.4 KiB
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 flush.gl
.ds Xs 64601 4 flush.gl
.TH GLFLUSH 3G
.SH NAME
.B "glFlush
\- force execution of GL commands in finite time
.SH C SPECIFICATION
void \f3glFlush\fP( void )
.nf
.fi
.SH DESCRIPTION
Different GL implementations buffer commands in several different locations,
including network buffers and the graphics accelerator itself.
\%\f3glFlush\fP empties all of these buffers,
causing all issued commands to be executed as quickly as
they are accepted by the actual rendering engine.
Though this execution may not be completed in any particular
time period,
it does complete in finite time.
.P
Because any GL program might be executed over a network,
or on an accelerator that buffers commands,
all programs should call \%\f3glFlush\fP whenever they count on having
all of their previously issued commands completed.
For example,
call \%\f3glFlush\fP before waiting for user input that depends on
the generated image.
.SH NOTES
\%\f3glFlush\fP can return at any time.
It does not wait until the execution of all previously
issued GL commands is complete.
.SH ERRORS
\%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glFlush\fP
is executed between the execution of \%\f3glBegin\fP
and the corresponding execution of \%\f3glEnd\fP.
.SH SEE ALSO
\%\f3glFinish(3G)\fP