rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / manglsl / memoryBarrier.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="memoryBarrier">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2011</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
            <refentrytitle>memoryBarrier</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>memoryBarrier</refname>\r
        <refpurpose>controls the ordering of memory transactions issued by a single shader invocation</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>Declaration</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>uint <function>memoryBarrier</function></funcdef>\r
                <paramdef>void</paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>memoryBarrier</function> waits on the completion of all memory accesses resulting from the use of\r
            image variables or atomic counters and then returns with no other effect.  When this function returns, the\r
            results of any memory stores performed using coherent variables performed prior to the call will be visible\r
            to any future coherent memory access to the same addresses from other shader invocations.  In particular,\r
            the values written this way in one shader stage are guaranteed to be visible to coherent memory accesses\r
            performed by shader invocations in subsequent stages when those invocations were triggered by the\r
            execution of the original shader invocation (e.g., fragment shader invocations for a primitive resulting\r
            from a particular geometry shader invocation).\r
        </para>\r
    </refsect1>\r
    <refsect1 id="versions"><title>Version Support</title>\r
        <informaltable frame="topbot">\r
            #VARTABLECOLS#\r
                <thead>\r
                    #FUNCTABLEHEADER#\r
                    <row>\r
                        <entry>memoryBarrier</entry>#newin40#\r
                    </row>\r
                </thead>\r
            </tgroup>\r
        </informaltable>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>imageLoad</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>imageStore</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>imageAtomicAdd</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>imageAtomicMin</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>imageAtomicMax</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>imageAtomicXor</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>imageAtomicOr</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>imageAtomicAnd</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>imageAtomicExchange</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>imageAtomicCompSwap</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>memoryBarrier</refentrytitle></citerefentry>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2011 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