rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / manglsl / imageLoad.xml

diff --git a/upstream-doc/manglsl/imageLoad.xml b/upstream-doc/manglsl/imageLoad.xml
new file mode 100644 (file)
index 0000000..54636cc
--- /dev/null
+++ b/upstream-doc/manglsl/imageLoad.xml
@@ -0,0 +1,150 @@
+<?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="imageLoad">\r
+    <refmeta>\r
+        <refmetainfo>\r
+            <copyright>\r
+                <year>2011</year>\r
+                <holder>Khronos Group</holder>\r
+            </copyright>\r
+        </refmetainfo>\r
+        <refentrytitle>imageLoad</refentrytitle>\r
+        <manvolnum>3G</manvolnum>\r
+    </refmeta>\r
+    <refnamediv>\r
+        <refname>imageLoad</refname>\r
+        <refpurpose>load a single texel from an image</refpurpose>\r
+    </refnamediv>\r
+    <refsynopsisdiv><title>Declaration</title>\r
+        <funcsynopsis>\r
+            <funcprototype>\r
+                <funcdef>gvec4 <function>imageLoad</function></funcdef>\r
+                <paramdef>gimage1D <parameter>image</parameter></paramdef>\r
+                <paramdef>int <parameter>P</parameter></paramdef>\r
+            </funcprototype>\r
+            <funcprototype>\r
+                <funcdef>gvec4 <function>imageLoad</function></funcdef>\r
+                <paramdef>gimage2D <parameter>image</parameter></paramdef>\r
+                <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
+            </funcprototype>\r
+            <funcprototype>\r
+                <funcdef>gvec4 <function>imageLoad</function></funcdef>\r
+                <paramdef>gimage3D <parameter>image</parameter></paramdef>\r
+                <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
+            </funcprototype>\r
+            <funcprototype>\r
+                <funcdef>gvec4 <function>imageLoad</function></funcdef>\r
+                <paramdef>gimage2DRect <parameter>image</parameter></paramdef>\r
+                <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
+            </funcprototype>\r
+            <funcprototype>\r
+                <funcdef>gvec4 <function>imageLoad</function></funcdef>\r
+                <paramdef>gimageCube <parameter>image</parameter></paramdef>\r
+                <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
+            </funcprototype>\r
+            <funcprototype>\r
+                <funcdef>gvec4 <function>imageLoad</function></funcdef>\r
+                <paramdef>gbufferImage <parameter>image</parameter></paramdef>\r
+                <paramdef>int <parameter>P</parameter></paramdef>\r
+            </funcprototype>\r
+            <funcprototype>\r
+                <funcdef>gvec4 <function>imageLoad</function></funcdef>\r
+                <paramdef>gimage1DArray <parameter>image</parameter></paramdef>\r
+                <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
+            </funcprototype>\r
+            <funcprototype>\r
+                <funcdef>gvec4 <function>imageLoad</function></funcdef>\r
+                <paramdef>gimage2DArray <parameter>image</parameter></paramdef>\r
+                <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
+            </funcprototype>\r
+            <funcprototype>\r
+                <funcdef>gvec4 <function>imageLoad</function></funcdef>\r
+                <paramdef>gimageCubeArray <parameter>image</parameter></paramdef>\r
+                <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
+            </funcprototype>\r
+            <funcprototype>\r
+                <funcdef>gvec4 <function>imageLoad</function></funcdef>\r
+                <paramdef>gimage2DMS <parameter>image</parameter></paramdef>\r
+                <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
+                <paramdef>int <parameter>sample</parameter></paramdef>\r
+            </funcprototype>\r
+            <funcprototype>\r
+                <funcdef>gvec4 <function>imageLoad</function></funcdef>\r
+                <paramdef>gimage2DMSArray <parameter>image</parameter></paramdef>\r
+                <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
+                <paramdef>int <parameter>sample</parameter></paramdef>\r
+            </funcprototype>\r
+        </funcsynopsis>\r
+    </refsynopsisdiv>\r
+    <refsect1 id="parameters"><title>Parameters</title>\r
+        <variablelist>\r
+        <varlistentry>\r
+            <term><parameter>image</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specify the image unit from which to load a texel.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>P</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specify the coordinate from which to load the texel.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>sample</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    When present, specifies the sample within the image to load\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        </variablelist>\r
+    </refsect1>\r
+    <refsect1 id="description"><title>Description</title>\r
+        <para>\r
+            <function>imageLoad</function> loads the texel at the coordinate <parameter>P</parameter> from the image \r
+            unit <parameter>image</parameter>.  For multi-sample loads, the sample number is given by <parameter>sample</parameter>.  When \r
+            <parameter>image</parameter>, <parameter>P</parameter>, <parameter>sample</parameter> identify a valid texel, the bits used \r
+            to represent the selected texel in memory are converted to a vec4, ivec4, or uvec4 in the manner described in the OpenGL \r
+            Specification and returned.\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>imageLoad</entry>#newin42#\r
+                    </row>\r
+                </thead>\r
+            </tgroup>\r
+        </informaltable>\r
+    </refsect1>\r
+    <refsect1 id="seealso"><title>See Also</title>\r
+        <para>\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>imageAtomicAnd</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>imageAtomicOr</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>imageAtomicXor</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>imageAtomicExchange</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>imageAtomicCompSwap</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