rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man3 / glClientWaitSync.xml

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