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="texelFetch">\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>texelFetch</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>texelFetch</refname>\r | |
| 17 | <refpurpose>perform a lookup of a single texel within a texture</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>Declaration</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>gvec4 <function>texelFetch</function></funcdef>\r | |
| 23 | <paramdef>gsampler1D <parameter>sampler</parameter></paramdef>\r | |
| 24 | <paramdef>int <parameter>P</parameter></paramdef>\r | |
| 25 | <paramdef>int <parameter>lod</parameter></paramdef>\r | |
| 26 | </funcprototype>\r | |
| 27 | <funcprototype>\r | |
| 28 | <funcdef>gvec4 <function>texelFetch</function></funcdef>\r | |
| 29 | <paramdef>gsampler2D <parameter>sampler</parameter></paramdef>\r | |
| 30 | <paramdef>ivec2 <parameter>P</parameter></paramdef>\r | |
| 31 | <paramdef>int <parameter>lod</parameter></paramdef>\r | |
| 32 | </funcprototype>\r | |
| 33 | <funcprototype>\r | |
| 34 | <funcdef>gvec4 <function>texelFetch</function></funcdef>\r | |
| 35 | <paramdef>gsampler3D <parameter>sampler</parameter></paramdef>\r | |
| 36 | <paramdef>ivec3 <parameter>P</parameter></paramdef>\r | |
| 37 | <paramdef>int <parameter>lod</parameter></paramdef>\r | |
| 38 | </funcprototype>\r | |
| 39 | <funcprototype>\r | |
| 40 | <funcdef>gvec4 <function>texelFetch</function></funcdef>\r | |
| 41 | <paramdef>gsampler2DRect <parameter>sampler</parameter></paramdef>\r | |
| 42 | <paramdef>ivec2 <parameter>P</parameter></paramdef>\r | |
| 43 | </funcprototype>\r | |
| 44 | <funcprototype>\r | |
| 45 | <funcdef>gvec4 <function>texelFetch</function></funcdef>\r | |
| 46 | <paramdef>gsampler1DArray <parameter>sampler</parameter></paramdef>\r | |
| 47 | <paramdef>ivec2 <parameter>P</parameter></paramdef>\r | |
| 48 | <paramdef>int <parameter>lod</parameter></paramdef>\r | |
| 49 | </funcprototype>\r | |
| 50 | <funcprototype>\r | |
| 51 | <funcdef>gvec4 <function>texelFetch</function></funcdef>\r | |
| 52 | <paramdef>gsampler2DArray <parameter>sampler</parameter></paramdef>\r | |
| 53 | <paramdef>ivec3 <parameter>P</parameter></paramdef>\r | |
| 54 | <paramdef>int <parameter>lod</parameter></paramdef>\r | |
| 55 | </funcprototype>\r | |
| 56 | <funcprototype>\r | |
| 57 | <funcdef>gvec4 <function>texelFetch</function></funcdef>\r | |
| 58 | <paramdef>gsamplerBuffer <parameter>sampler</parameter></paramdef>\r | |
| 59 | <paramdef>int <parameter>P</parameter></paramdef>\r | |
| 60 | </funcprototype>\r | |
| 61 | <funcprototype>\r | |
| 62 | <funcdef>gvec4 <function>texelFetch</function></funcdef>\r | |
| 63 | <paramdef>gsampler2DMS <parameter>sampler</parameter></paramdef>\r | |
| 64 | <paramdef>ivec2 <parameter>P</parameter></paramdef>\r | |
| 65 | <paramdef>sample <parameter>sample</parameter></paramdef>\r | |
| 66 | </funcprototype>\r | |
| 67 | <funcprototype>\r | |
| 68 | <funcdef>gvec4 <function>texelFetch</function></funcdef>\r | |
| 69 | <paramdef>gsampler2DMSArray <parameter>sampler</parameter></paramdef>\r | |
| 70 | <paramdef>ivec3 <parameter>P</parameter></paramdef>\r | |
| 71 | <paramdef>sample <parameter>sample</parameter></paramdef>\r | |
| 72 | </funcprototype>\r | |
| 73 | </funcsynopsis>\r | |
| 74 | </refsynopsisdiv>\r | |
| 75 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 76 | <variablelist>\r | |
| 77 | <varlistentry>\r | |
| 78 | <term><parameter>sampler</parameter></term>\r | |
| 79 | <listitem>\r | |
| 80 | <para>\r | |
| 81 | Specifies the sampler to which the texture from which texels will be retrieved is bound.\r | |
| 82 | </para>\r | |
| 83 | </listitem>\r | |
| 84 | </varlistentry>\r | |
| 85 | <varlistentry>\r | |
| 86 | <term><parameter>P</parameter></term>\r | |
| 87 | <listitem>\r | |
| 88 | <para>\r | |
| 89 | Specifies the texture coordinates at which texture will be sampled.\r | |
| 90 | </para>\r | |
| 91 | </listitem>\r | |
| 92 | </varlistentry>\r | |
| 93 | <varlistentry>\r | |
| 94 | <term><parameter>lod</parameter></term>\r | |
| 95 | <listitem>\r | |
| 96 | <para>\r | |
| 97 | If present, specifies the level-of-detail within the texture from which the texel will be fetched.\r | |
| 98 | </para>\r | |
| 99 | </listitem>\r | |
| 100 | </varlistentry>\r | |
| 101 | <varlistentry>\r | |
| 102 | <term><parameter>sample</parameter></term>\r | |
| 103 | <listitem>\r | |
| 104 | <para>\r | |
| 105 | For multisampled fetches, specifies which sample within the texel from which which will be returned.\r | |
| 106 | </para>\r | |
| 107 | </listitem>\r | |
| 108 | </varlistentry>\r | |
| 109 | </variablelist>\r | |
| 110 | </refsect1>\r | |
| 111 | <refsect1 id="description"><title>Description</title>\r | |
| 112 | <para>\r | |
| 113 | <function>texelFetch</function> performs a lookup of a single texel from texture coordinate <parameter>P</parameter>\r | |
| 114 | in the texture bound to <parameter>sampler</parameter>. The array layer is specified in the last component of\r | |
| 115 | <parameter>P</parameter> for array forms. The <parameter>lod</parameter> parameter (if present) specifies the level-of-detail\r | |
| 116 | from which the texel will be fetched. The <parameter>sample</parameter> specifies which sample within the texel will be\r | |
| 117 | returned when reading from a multi-sample texure.\r | |
| 118 | </para>\r | |
| 119 | </refsect1>\r | |
| 120 | <refsect1 id="versions"><title>Version Support</title>\r | |
| 121 | <informaltable frame="topbot">\r | |
| 122 | #VARTABLECOLS#\r | |
| 123 | <thead>\r | |
| 124 | #FUNCTABLEHEADER#\r | |
| 125 | <row>\r | |
| 126 | <entry>texelFetch</entry>#newin13#\r | |
| 127 | </row>\r | |
| 128 | <row>\r | |
| 129 | <entry>texelFetch (gsampler2DRect, gsamplerBuffer)</entry>#newin14#\r | |
| 130 | </row>\r | |
| 131 | <row>\r | |
| 132 | <entry>texelFetch (gsampler2DMS, gsampler2DMSArray)</entry>#newin15#\r | |
| 133 | </row>\r | |
| 134 | </thead>\r | |
| 135 | </tgroup>\r | |
| 136 | </informaltable>\r | |
| 137 | </refsect1>\r | |
| 138 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 139 | <para>\r | |
| 140 | <citerefentry><refentrytitle>texelFetch</refentrytitle></citerefentry>,\r | |
| 141 | <citerefentry><refentrytitle>texture</refentrytitle></citerefentry>,\r | |
| 142 | <citerefentry><refentrytitle>textureGather</refentrytitle></citerefentry>,\r | |
| 143 | <citerefentry><refentrytitle>textureGatherOffset</refentrytitle></citerefentry>,\r | |
| 144 | <citerefentry><refentrytitle>textureGatherOffsets</refentrytitle></citerefentry>,\r | |
| 145 | <citerefentry><refentrytitle>textureGrad</refentrytitle></citerefentry>,\r | |
| 146 | <citerefentry><refentrytitle>textureGradOffset</refentrytitle></citerefentry>,\r | |
| 147 | <citerefentry><refentrytitle>textureLod</refentrytitle></citerefentry>,\r | |
| 148 | <citerefentry><refentrytitle>textureLodOffset</refentrytitle></citerefentry>,\r | |
| 149 | <citerefentry><refentrytitle>textureOffset</refentrytitle></citerefentry>,\r | |
| 150 | <citerefentry><refentrytitle>textureProj</refentrytitle></citerefentry>,\r | |
| 151 | <citerefentry><refentrytitle>textureProjGrad</refentrytitle></citerefentry>,\r | |
| 152 | <citerefentry><refentrytitle>textureProjGradOffset</refentrytitle></citerefentry>,\r | |
| 153 | <citerefentry><refentrytitle>textureProjLod</refentrytitle></citerefentry>,\r | |
| 154 | <citerefentry><refentrytitle>textureProjLodOffset</refentrytitle></citerefentry>,\r | |
| 155 | <citerefentry><refentrytitle>textureProjOffset</refentrytitle></citerefentry>,\r | |
| 156 | <citerefentry><refentrytitle>textureQueryLod</refentrytitle></citerefentry>,\r | |
| 157 | <citerefentry><refentrytitle>textureSize</refentrytitle></citerefentry>\r | |
| 158 | </para>\r | |
| 159 | </refsect1>\r | |
| 160 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 161 | <para>\r | |
| 162 | Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r | |
| 163 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 164 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 165 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 166 | </para>\r | |
| 167 | </refsect1>\r | |
| 168 | </refentry>\r |