HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
| 2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r | |
| 3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r | |
| 4 | <refentry id="imageLoad">\r | |
| 5 | <refmeta>\r | |
| 6 | <refmetainfo>\r | |
| 7 | <copyright>\r | |
| 8 | <year>2011</year>\r | |
| 9 | <holder>Khronos Group</holder>\r | |
| 10 | </copyright>\r | |
| 11 | </refmetainfo>\r | |
| 12 | <refentrytitle>imageLoad</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>imageLoad</refname>\r | |
| 17 | <refpurpose>load a single texel from an image</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>Declaration</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>gvec4 <function>imageLoad</function></funcdef>\r | |
| 23 | <paramdef>gimage1D <parameter>image</parameter></paramdef>\r | |
| 24 | <paramdef>int <parameter>P</parameter></paramdef>\r | |
| 25 | </funcprototype>\r | |
| 26 | <funcprototype>\r | |
| 27 | <funcdef>gvec4 <function>imageLoad</function></funcdef>\r | |
| 28 | <paramdef>gimage2D <parameter>image</parameter></paramdef>\r | |
| 29 | <paramdef>ivec2 <parameter>P</parameter></paramdef>\r | |
| 30 | </funcprototype>\r | |
| 31 | <funcprototype>\r | |
| 32 | <funcdef>gvec4 <function>imageLoad</function></funcdef>\r | |
| 33 | <paramdef>gimage3D <parameter>image</parameter></paramdef>\r | |
| 34 | <paramdef>ivec3 <parameter>P</parameter></paramdef>\r | |
| 35 | </funcprototype>\r | |
| 36 | <funcprototype>\r | |
| 37 | <funcdef>gvec4 <function>imageLoad</function></funcdef>\r | |
| 38 | <paramdef>gimage2DRect <parameter>image</parameter></paramdef>\r | |
| 39 | <paramdef>ivec2 <parameter>P</parameter></paramdef>\r | |
| 40 | </funcprototype>\r | |
| 41 | <funcprototype>\r | |
| 42 | <funcdef>gvec4 <function>imageLoad</function></funcdef>\r | |
| 43 | <paramdef>gimageCube <parameter>image</parameter></paramdef>\r | |
| 44 | <paramdef>ivec3 <parameter>P</parameter></paramdef>\r | |
| 45 | </funcprototype>\r | |
| 46 | <funcprototype>\r | |
| 47 | <funcdef>gvec4 <function>imageLoad</function></funcdef>\r | |
| 48 | <paramdef>gbufferImage <parameter>image</parameter></paramdef>\r | |
| 49 | <paramdef>int <parameter>P</parameter></paramdef>\r | |
| 50 | </funcprototype>\r | |
| 51 | <funcprototype>\r | |
| 52 | <funcdef>gvec4 <function>imageLoad</function></funcdef>\r | |
| 53 | <paramdef>gimage1DArray <parameter>image</parameter></paramdef>\r | |
| 54 | <paramdef>ivec2 <parameter>P</parameter></paramdef>\r | |
| 55 | </funcprototype>\r | |
| 56 | <funcprototype>\r | |
| 57 | <funcdef>gvec4 <function>imageLoad</function></funcdef>\r | |
| 58 | <paramdef>gimage2DArray <parameter>image</parameter></paramdef>\r | |
| 59 | <paramdef>ivec3 <parameter>P</parameter></paramdef>\r | |
| 60 | </funcprototype>\r | |
| 61 | <funcprototype>\r | |
| 62 | <funcdef>gvec4 <function>imageLoad</function></funcdef>\r | |
| 63 | <paramdef>gimageCubeArray <parameter>image</parameter></paramdef>\r | |
| 64 | <paramdef>ivec3 <parameter>P</parameter></paramdef>\r | |
| 65 | </funcprototype>\r | |
| 66 | <funcprototype>\r | |
| 67 | <funcdef>gvec4 <function>imageLoad</function></funcdef>\r | |
| 68 | <paramdef>gimage2DMS <parameter>image</parameter></paramdef>\r | |
| 69 | <paramdef>ivec2 <parameter>P</parameter></paramdef>\r | |
| 70 | <paramdef>int <parameter>sample</parameter></paramdef>\r | |
| 71 | </funcprototype>\r | |
| 72 | <funcprototype>\r | |
| 73 | <funcdef>gvec4 <function>imageLoad</function></funcdef>\r | |
| 74 | <paramdef>gimage2DMSArray <parameter>image</parameter></paramdef>\r | |
| 75 | <paramdef>ivec3 <parameter>P</parameter></paramdef>\r | |
| 76 | <paramdef>int <parameter>sample</parameter></paramdef>\r | |
| 77 | </funcprototype>\r | |
| 78 | </funcsynopsis>\r | |
| 79 | </refsynopsisdiv>\r | |
| 80 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 81 | <variablelist>\r | |
| 82 | <varlistentry>\r | |
| 83 | <term><parameter>image</parameter></term>\r | |
| 84 | <listitem>\r | |
| 85 | <para>\r | |
| 86 | Specify the image unit from which to load a texel.\r | |
| 87 | </para>\r | |
| 88 | </listitem>\r | |
| 89 | </varlistentry>\r | |
| 90 | <varlistentry>\r | |
| 91 | <term><parameter>P</parameter></term>\r | |
| 92 | <listitem>\r | |
| 93 | <para>\r | |
| 94 | Specify the coordinate from which to load the texel.\r | |
| 95 | </para>\r | |
| 96 | </listitem>\r | |
| 97 | </varlistentry>\r | |
| 98 | <varlistentry>\r | |
| 99 | <term><parameter>sample</parameter></term>\r | |
| 100 | <listitem>\r | |
| 101 | <para>\r | |
| 102 | When present, specifies the sample within the image to load\r | |
| 103 | </para>\r | |
| 104 | </listitem>\r | |
| 105 | </varlistentry>\r | |
| 106 | </variablelist>\r | |
| 107 | </refsect1>\r | |
| 108 | <refsect1 id="description"><title>Description</title>\r | |
| 109 | <para>\r | |
| 110 | <function>imageLoad</function> loads the texel at the coordinate <parameter>P</parameter> from the image \r | |
| 111 | unit <parameter>image</parameter>. For multi-sample loads, the sample number is given by <parameter>sample</parameter>. When \r | |
| 112 | <parameter>image</parameter>, <parameter>P</parameter>, <parameter>sample</parameter> identify a valid texel, the bits used \r | |
| 113 | to represent the selected texel in memory are converted to a vec4, ivec4, or uvec4 in the manner described in the OpenGL \r | |
| 114 | Specification and returned.\r | |
| 115 | </para>\r | |
| 116 | </refsect1>\r | |
| 117 | <refsect1 id="versions"><title>Version Support</title>\r | |
| 118 | <informaltable frame="topbot">\r | |
| 119 | #VARTABLECOLS#\r | |
| 120 | <thead>\r | |
| 121 | #FUNCTABLEHEADER#\r | |
| 122 | <row>\r | |
| 123 | <entry>imageLoad</entry>#newin42#\r | |
| 124 | </row>\r | |
| 125 | </thead>\r | |
| 126 | </tgroup>\r | |
| 127 | </informaltable>\r | |
| 128 | </refsect1>\r | |
| 129 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 130 | <para>\r | |
| 131 | <citerefentry><refentrytitle>imageStore</refentrytitle></citerefentry>,\r | |
| 132 | <citerefentry><refentrytitle>imageAtomicAdd</refentrytitle></citerefentry>,\r | |
| 133 | <citerefentry><refentrytitle>imageAtomicMin</refentrytitle></citerefentry>,\r | |
| 134 | <citerefentry><refentrytitle>imageAtomicMax</refentrytitle></citerefentry>,\r | |
| 135 | <citerefentry><refentrytitle>imageAtomicAnd</refentrytitle></citerefentry>,\r | |
| 136 | <citerefentry><refentrytitle>imageAtomicOr</refentrytitle></citerefentry>,\r | |
| 137 | <citerefentry><refentrytitle>imageAtomicXor</refentrytitle></citerefentry>,\r | |
| 138 | <citerefentry><refentrytitle>imageAtomicExchange</refentrytitle></citerefentry>,\r | |
| 139 | <citerefentry><refentrytitle>imageAtomicCompSwap</refentrytitle></citerefentry>\r | |
| 140 | </para>\r | |
| 141 | </refsect1>\r | |
| 142 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 143 | <para>\r | |
| 144 | Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r | |
| 145 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 146 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 147 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 148 | </para>\r | |
| 149 | </refsect1>\r | |
| 150 | </refentry>\r |