rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man3 / glWaitSync.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="glWaitSync">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2010</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glWaitSync</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glWaitSync</refname>\r
        <refpurpose>instruct the GL server to block until the specified sync object becomes signaled</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glWaitSync</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
                    Specifies 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 zero.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>timeout</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the timeout that the server should wait before continuing. <parameter>timeout</parameter> must be <constant>GL_TIMEOUT_IGNORED</constant>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glWaitSync</function> causes the GL server to block and wait until <parameter>sync</parameter> becomes signaled. <parameter>sync</parameter>\r
            is the name of an existing sync object upon which to wait. <parameter>flags</parameter> and <parameter>timeout</parameter> are currently not used and\r
            must be set to zero and the special value <constant>GL_TIMEOUT_IGNORED</constant>, respectively<footnote><para><parameter>flags</parameter> and\r
            <parameter>timeout</parameter> are placeholders for anticipated future extensions of sync object capabilities. They must have these reserved values in\r
            order that existing code calling <function>glWaitSync</function> operate properly in the presence of such extensions.</para></footnote>. <function>glWaitSync</function> will always wait no longer than an implementation-dependent timeout. The\r
            duration of this timeout in nanoseconds may be queried by calling <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with the\r
            parameter <constant>GL_MAX_SERVER_WAIT_TIMEOUT</constant>. There is currently no way to determine whether <function>glWaitSync</function> unblocked\r
            because the timeout expired or because the sync object being waited on was signaled.\r
        </para>\r
        <para>\r
            If an error occurs, <function>glWaitSync</function> does not cause the GL server to block.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="notes"><title>Notes</title>\r
        <para>\r
            <function>glWaitSync</function> is available only if the GL version is 3.2 or higher.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>sync</parameter> is not the name of a sync object.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>flags</parameter> is not zero.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>timeout</parameter> is not <constant>GL_TIMEOUT_IGNORED</constant>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glFenceSync</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glClientWaitSync</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