rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / memoryBarrierImage.xml
diff --git a/upstream-doc/manglsl/memoryBarrierImage.xml b/upstream-doc/manglsl/memoryBarrierImage.xml
new file mode 100644 (file)
index 0000000..f119368
--- /dev/null
@@ -0,0 +1,67 @@
+<?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="memoryBarrierImage">\r
+    <refmeta>\r
+        <refmetainfo>\r
+            <copyright>\r
+                <year>2012</year>\r
+                <holder>Khronos Group</holder>\r
+            </copyright>\r
+        </refmetainfo>\r
+            <refentrytitle>memoryBarrierImage</refentrytitle>\r
+        <manvolnum>3G</manvolnum>\r
+    </refmeta>\r
+    <refnamediv>\r
+        <refname>memoryBarrierImage</refname>\r
+        <refpurpose>controls the ordering of operations on image variables issued by a single shader invocation</refpurpose>\r
+    </refnamediv>\r
+    <refsynopsisdiv><title>Declaration</title>\r
+        <funcsynopsis>\r
+            <funcprototype>\r
+                <funcdef>void <function>memoryBarrierImage</function></funcdef>\r
+                <paramdef>void</paramdef>\r
+            </funcprototype>\r
+        </funcsynopsis>\r
+    </refsynopsisdiv>\r
+    <refsect1 id="description"><title>Description</title>\r
+        <para>\r
+            <function>memoryBarrierImage</function> waits on the completion of all memory accesses resulting\r
+            from the use of image variables and then returns with no other effect.  When this function returns, the\r
+            results of any modifications to the content of image variables will be visible\r
+            to any access to the same buffer from other shader invocations.  In particular,\r
+            any modifications made in one shader stage are guaranteed to be visible to 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>memoryBarrierImage</entry>#newin43#\r
+                    </row>\r
+                </thead>\r
+            </tgroup>\r
+        </informaltable>\r
+    </refsect1>\r
+    <refsect1 id="seealso"><title>See Also</title>\r
+        <para>\r
+            <citerefentry><refentrytitle>memoryBarrier</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>memoryBarrierShared</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>memoryBarrierBuffer</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>groupMemoryBarrier</refentrytitle></citerefentry>\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="Copyright"><title>Copyright</title>\r
+        <para>\r
+            Copyright <trademark class="copyright"></trademark> 2011-2012 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