Opentk/Source/Bind/Specifications/Docs/GL/glXWaitX.xml

70 lines
2.9 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glXWaitX">
<refmeta>
<refmetainfo>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
</refmetainfo>
<refentrytitle>glXWaitX</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glXWaitX</refname>
<refpurpose>complete X execution prior to subsequent GL calls</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glXWaitX</function></funcdef>
<paramdef><parameter>void</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- eqn: ignoring delim $$ -->
<refsect1 id="description"><title>Description</title>
<para>
X rendering calls made prior to <function>glXWaitX</function> are guaranteed to be
executed before GL rendering calls made after <function>glXWaitX</function>.
Although the same result can be achieved using <function>XSync</function>,
<function>glXWaitX</function> does not require a round trip to the server,
and it is therefore more efficient in cases where client and server
are on separate machines.
</para>
<para>
<function>glXWaitX</function> is ignored if there is no current GLX context.
</para>
</refsect1>
<refsect1 id="notes"><title>Notes</title>
<para>
<function>glXWaitX</function> may or may not flush the GL stream.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GLXBadCurrentWindow</constant> is generated if the drawable associated
with the current context of the calling thread is a window, and that
window is no longer valid.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXWaitGL</refentrytitle></citerefentry>,
<function>XSync</function>
</para>
</refsect1>
<refsect1 id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 1991-2006
Silicon Graphics, Inc. This document is licensed under the SGI
Free Software B License. For details, see
<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
</para>
</refsect1>
</refentry>