upstream-doc/man3/glFinish.xml

   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="glFinish">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glFinish</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glFinish</refname>
  17         <refpurpose>block until all GL execution is complete</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glFinish</function></funcdef>
  23                 <paramdef> <parameter>void</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="description"><title>Description</title>
  28         <para>
  29             <function>glFinish</function> does not return until the effects of all previously
  30             called GL commands are complete.
  31             Such effects include all changes to GL state,
  32             all changes to connection state,
  33             and all changes to the frame buffer contents.
  34         </para>
  35     </refsect1>
  36     <refsect1 id="notes"><title>Notes</title>
  37         <para>
  38             <function>glFinish</function> requires a round trip to the server.
  39         </para>
  40     </refsect1>
  41     <refsect1 id="seealso"><title>See Also</title>
  42         <para>
  43             <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>
  44         </para>
  45     </refsect1>
  46     <refsect1 id="Copyright"><title>Copyright</title>
  47         <para>
  48             Copyright <trademark class="copyright"></trademark> 1991-2006
  49             Silicon Graphics, Inc. This document is licensed under the SGI
  50             Free Software B License. For details, see
  51             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  52         </para>
  53     </refsect1>
  54 </refentry>