| 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" |
| 3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> |
| 4 | <refentry id="glFlush"> |
| 5 | <refmeta> |
| 6 | <refmetainfo> |
| 7 | <copyright> |
| 8 | <year>1991-2006</year> |
| 9 | <holder>Silicon Graphics, Inc.</holder> |
| 10 | </copyright> |
| 11 | </refmetainfo> |
| 12 | <refentrytitle>glFlush</refentrytitle> |
| 13 | <manvolnum>3G</manvolnum> |
| 14 | </refmeta> |
| 15 | <refnamediv> |
| 16 | <refname>glFlush</refname> |
| 17 | <refpurpose>force execution of GL commands in finite time</refpurpose> |
| 18 | </refnamediv> |
| 19 | <refsynopsisdiv><title>C Specification</title> |
| 20 | <funcsynopsis> |
| 21 | <funcprototype> |
| 22 | <funcdef>void <function>glFlush</function></funcdef> |
| 23 | <paramdef> <parameter>void</parameter></paramdef> |
| 24 | </funcprototype> |
| 25 | </funcsynopsis> |
| 26 | </refsynopsisdiv> |
| 27 | <refsect1 id="description"><title>Description</title> |
| 28 | <para> |
| 29 | Different GL implementations buffer commands in several different locations, |
| 30 | including network buffers and the graphics accelerator itself. |
| 31 | <function>glFlush</function> empties all of these buffers, |
| 32 | causing all issued commands to be executed as quickly as |
| 33 | they are accepted by the actual rendering engine. |
| 34 | Though this execution may not be completed in any particular |
| 35 | time period, |
| 36 | it does complete in finite time. |
| 37 | </para> |
| 38 | <para> |
| 39 | Because any GL program might be executed over a network, |
| 40 | or on an accelerator that buffers commands, |
| 41 | all programs should call <function>glFlush</function> whenever they count on having |
| 42 | all of their previously issued commands completed. |
| 43 | For example, |
| 44 | call <function>glFlush</function> before waiting for user input that depends on |
| 45 | the generated image. |
| 46 | </para> |
| 47 | </refsect1> |
| 48 | <refsect1 id="notes"><title>Notes</title> |
| 49 | <para> |
| 50 | <function>glFlush</function> can return at any time. |
| 51 | It does not wait until the execution of all previously |
| 52 | issued GL commands is complete. |
| 53 | </para> |
| 54 | </refsect1> |
| 55 | <refsect1 id="seealso"><title>See Also</title> |
| 56 | <para> |
| 57 | <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry> |
| 58 | </para> |
| 59 | </refsect1> |
| 60 | <refsect1 id="Copyright"><title>Copyright</title> |
| 61 | <para> |
| 62 | Copyright <trademark class="copyright"></trademark> 1991-2006 |
| 63 | Silicon Graphics, Inc. This document is licensed under the SGI |
| 64 | Free Software B License. For details, see |
| 65 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. |
| 66 | </para> |
| 67 | </refsect1> |
| 68 | </refentry> |