Opentk/Source/Bind/Specifications/Docs/glClientWaitSync.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="glClientWaitSync">
    <refmeta>
        <refmetainfo>
            <copyright>
                <year>2010</year>
                <holder>Khronos Group</holder>
            </copyright>
        </refmetainfo>
        <refentrytitle>glClientWaitSync</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glClientWaitSync</refname>
        <refpurpose>block and wait for a sync object to become signaled</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>GLenum <function>glClientWaitSync</function></funcdef>
                <paramdef>GLsync <parameter>sync</parameter></paramdef>
                <paramdef>GLbitfield <parameter>flags</parameter></paramdef>
                <paramdef>GLuint64 <parameter>timeout</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>sync</parameter></term>
            <listitem>
                <para>
                    The sync object whose status to wait on.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>flags</parameter></term>
            <listitem>
                <para>
                    A bitfield controlling the command flushing behavior. <parameter>flags</parameter> may be <constant>GL_SYNC_FLUSH_COMMANDS_BIT</constant>.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
        <varlistentry>
            <term><parameter>timeout</parameter></term>
            <listitem>
                <para>
                    The timeout, specified in nanoseconds, for which the implementation should wait for <parameter>sync</parameter> to become signaled.
                </para>
            </listitem>
        </varlistentry>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>glClientWaitSync</function> causes the client to block and wait for the sync object specified by <parameter>sync</parameter> to become signaled. If
            <parameter>sync</parameter> is signaled when <function>glClientWaitSync</function> is called, <function>glClientWaitSync</function> returns immediately, otherwise
            it will block and wait for up to <parameter>timeout</parameter> nanoseconds for <parameter>sync</parameter> to become signaled.
        </para>
        <para>
            The return value is one of four status values:
            <itemizedlist>
                <listitem>
                    <para>
                        <constant>GL_ALREADY_SIGNALED</constant> indicates that <parameter>sync</parameter> was signaled at the time that <function>glClientWaitSync</function>
                        was called.
                    </para>
                </listitem>
                <listitem>
                    <para>
                        <constant>GL_TIMEOUT_EXPIRED</constant> indicates that at least <parameter>timeout</parameter> nanoseconds passed and <parameter>sync</parameter> did not
                        become signaled.
                    </para>
                </listitem>
                <listitem>
                    <para>
                        <constant>GL_CONDITION_SATISFIED</constant> indicates that <parameter>sync</parameter> was signaled before the timeout expired.
                    </para>
                </listitem>
                <listitem>
                    <para>
                        <constant>GL_WAIT_FAILED</constant> indicates that an error occurred. Additionally, an OpenGL error will be generated.
                    </para>
                </listitem>
            </itemizedlist>
        </para>
    </refsect1>
    <refsect1 id="notes"><title>Notes</title>
        <para>
            <function>glClientWaitSync</function> is available only if the GL version is 3.2 or greater.
        </para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>sync</parameter> is not the name of an existing sync object.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>flags</parameter> contains any unsupported flag.
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glFenceSync</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glIsSync</refentrytitle></citerefentry>
            <citerefentry><refentrytitle>glWaitSync</refentrytitle></citerefentry>
            </para>
    </refsect1>
    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
        </para>
    </refsect1>
</refentry>