upstream-man-pages/man2/glXWaitX.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="glXWaitX">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glXWaitX</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glXWaitX</refname>
  17         <refpurpose>complete X execution prior to subsequent GL calls</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glXWaitX</function></funcdef>
  23                 <paramdef><parameter>void</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <!-- eqn: ignoring delim $$ -->
  28     <refsect1 id="description"><title>Description</title>
  29         <para>
  30             X rendering calls made prior to <function>glXWaitX</function> are guaranteed to be
  31             executed before GL rendering calls made after <function>glXWaitX</function>.
  32             Although the same result can be achieved using <function>XSync</function>,
  33             <function>glXWaitX</function> does not require a round trip to the server,
  34             and it is therefore more efficient in cases where client and server
  35             are on separate machines.
  36         </para>
  37         <para>
  38             <function>glXWaitX</function> is ignored if there is no current GLX context.
  39         </para>
  40     </refsect1>
  41     <refsect1 id="notes"><title>Notes</title>
  42         <para>
  43             <function>glXWaitX</function> may or may not flush the GL stream.
  44         </para>
  45     </refsect1>
  46     <refsect1 id="errors"><title>Errors</title>
  47         <para>
  48             <constant>GLXBadCurrentWindow</constant> is generated if the drawable associated
  49             with the current context of the calling thread is a window, and that
  50             window is no longer valid.
  51         </para>
  52     </refsect1>
  53     <refsect1 id="seealso"><title>See Also</title>
  54         <para>
  55             <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>,
  56             <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>,
  57             <citerefentry><refentrytitle>glXWaitGL</refentrytitle></citerefentry>,
  58             <function>XSync</function>
  59         </para>
  60     </refsect1>
  61     <refsect1 id="Copyright"><title>Copyright</title>
  62         <para>
  63             Copyright <trademark class="copyright"></trademark> 1991-2006
  64             Silicon Graphics, Inc. This document is licensed under the SGI
  65             Free Software B License. For details, see
  66             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  67         </para>
  68     </refsect1>
  69 </refentry>