upstream-man-pages/manglsl/textureGradOffset.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="textureGradOffset">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>textureGradOffset</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>textureGradOffset</refname>
  17         <refpurpose>perform a texture lookup with explicit gradients and offset</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>gvec4 <function>textureGradOffset</function></funcdef>
  23                 <paramdef>gsampler1D <parameter>sampler</parameter></paramdef>
  24                 <paramdef>float <parameter>P</parameter></paramdef>
  25                 <paramdef>float <parameter>dPdx</parameter></paramdef>
  26                 <paramdef>float <parameter>dPdy</parameter></paramdef>
  27                 <paramdef>int <parameter>offset</parameter></paramdef>
  28             </funcprototype>
  29             <funcprototype>
  30                 <funcdef>gvec4 <function>textureGradOffset</function></funcdef>
  31                 <paramdef>gsampler2D <parameter>sampler</parameter></paramdef>
  32                 <paramdef>vec2 <parameter>P</parameter></paramdef>
  33                 <paramdef>vec2 <parameter>dPdx</parameter></paramdef>
  34                 <paramdef>vec2 <parameter>dPdy</parameter></paramdef>
  35                 <paramdef>ivec2 <parameter>offset</parameter></paramdef>
  36             </funcprototype>
  37             <funcprototype>
  38                 <funcdef>gvec4 <function>textureGradOffset</function></funcdef>
  39                 <paramdef>gsampler3D <parameter>sampler</parameter></paramdef>
  40                 <paramdef>vec3 <parameter>P</parameter></paramdef>
  41                 <paramdef>vec3 <parameter>dPdx</parameter></paramdef>
  42                 <paramdef>vec3 <parameter>dPdy</parameter></paramdef>
  43                 <paramdef>ivec3 <parameter>offset</parameter></paramdef>
  44             </funcprototype>
  45             <funcprototype>
  46                 <funcdef>gvec4 <function>textureGradOffset</function></funcdef>
  47                 <paramdef>gsampler2DRect <parameter>sampler</parameter></paramdef>
  48                 <paramdef>vec2 <parameter>P</parameter></paramdef>
  49                 <paramdef>vec2 <parameter>dPdx</parameter></paramdef>
  50                 <paramdef>vec2 <parameter>dPdy</parameter></paramdef>
  51                 <paramdef>ivec2 <parameter>offset</parameter></paramdef>
  52             </funcprototype>
  53             <funcprototype>
  54                 <funcdef>float <function>textureGradOffset</function></funcdef>
  55                 <paramdef>gsampler2DRectShadow <parameter>sampler</parameter></paramdef>
  56                 <paramdef>vec3 <parameter>P</parameter></paramdef>
  57                 <paramdef>vec2 <parameter>dPdx</parameter></paramdef>
  58                 <paramdef>vec2 <parameter>dPdy</parameter></paramdef>
  59                 <paramdef>ivec2 <parameter>offset</parameter></paramdef>
  60             </funcprototype>
  61             <funcprototype>
  62                 <funcdef>float <function>textureGradOffset</function></funcdef>
  63                 <paramdef>sampler1DShadow <parameter>sampler</parameter></paramdef>
  64                 <paramdef>vec3 <parameter>P</parameter></paramdef>
  65                 <paramdef>float <parameter>dPdx</parameter></paramdef>
  66                 <paramdef>float <parameter>dPdy</parameter></paramdef>
  67                 <paramdef>int <parameter>offset</parameter></paramdef>
  68             </funcprototype>
  69             <funcprototype>
  70                 <funcdef>float <function>textureGradOffset</function></funcdef>
  71                 <paramdef>sampler2DShadow <parameter>sampler</parameter></paramdef>
  72                 <paramdef>vec3 <parameter>P</parameter></paramdef>
  73                 <paramdef>vec2 <parameter>dPdx</parameter></paramdef>
  74                 <paramdef>vec2 <parameter>dPdy</parameter></paramdef>
  75                 <paramdef>ivec2 <parameter>offset</parameter></paramdef>
  76             </funcprototype>
  77             <funcprototype>
  78                 <funcdef>gvec4 <function>textureGradOffset</function></funcdef>
  79                 <paramdef>gsampler1DArray <parameter>sampler</parameter></paramdef>
  80                 <paramdef>vec2 <parameter>P</parameter></paramdef>
  81                 <paramdef>float <parameter>dPdx</parameter></paramdef>
  82                 <paramdef>float <parameter>dPdy</parameter></paramdef>
  83                 <paramdef>int <parameter>offset</parameter></paramdef>
  84             </funcprototype>
  85             <funcprototype>
  86                 <funcdef>gvec4 <function>textureGradOffset</function></funcdef>
  87                 <paramdef>gsampler2DArray <parameter>sampler</parameter></paramdef>
  88                 <paramdef>vec3 <parameter>P</parameter></paramdef>
  89                 <paramdef>vec2 <parameter>dPdx</parameter></paramdef>
  90                 <paramdef>vec2 <parameter>dPdy</parameter></paramdef>
  91                 <paramdef>ivec2 <parameter>offset</parameter></paramdef>
  92             </funcprototype>
  93             <funcprototype>
  94                 <funcdef>float <function>textureGradOffset</function></funcdef>
  95                 <paramdef>sampler1DArrayShadow <parameter>sampler</parameter></paramdef>
  96                 <paramdef>vec3 <parameter>P</parameter></paramdef>
  97                 <paramdef>float <parameter>dPdx</parameter></paramdef>
  98                 <paramdef>float <parameter>dPdy</parameter></paramdef>
  99                 <paramdef>int <parameter>offset</parameter></paramdef>
 100             </funcprototype>
 101             <funcprototype>
 102                 <funcdef>float <function>textureGradOffset</function></funcdef>
 103                 <paramdef>sampler2DArrayShadow <parameter>sampler</parameter></paramdef>
 104                 <paramdef>vec3 <parameter>P</parameter></paramdef>
 105                 <paramdef>vec2 <parameter>dPdx</parameter></paramdef>
 106                 <paramdef>vec2 <parameter>dPdy</parameter></paramdef>
 107                 <paramdef>ivec2 <parameter>offset</parameter></paramdef>
 108             </funcprototype>
 109         </funcsynopsis>
 110     </refsynopsisdiv>
 111     <refsect1 id="parameters"><title>Parameters</title>
 112         <variablelist>
 113         <varlistentry>
 114             <term><parameter>sampler</parameter></term>
 115             <listitem>
 116                 <para>
 117                     Specifies the sampler to which the texture from which texels will be retrieved is bound.
 118                 </para>
 119             </listitem>
 120         </varlistentry>
 121         <varlistentry>
 122             <term><parameter>P</parameter></term>
 123             <listitem>
 124                 <para>
 125                     Specifies the texture coordinates at which texture will be sampled.
 126                 </para>
 127             </listitem>
 128         </varlistentry>
 129         <varlistentry>
 130             <term><parameter>dPdx</parameter></term>
 131             <listitem>
 132                 <para>
 133                     Specifies the partial derivative of <parameter>P</parameter> with respect to window x.
 134                 </para>
 135             </listitem>
 136         </varlistentry>
 137         <varlistentry>
 138             <term><parameter>dPdy</parameter></term>
 139             <listitem>
 140                 <para>
 141                     Specifies the partial derivative of <parameter>P</parameter> with respect to window y.
 142                 </para>
 143             </listitem>
 144         </varlistentry>
 145         <varlistentry>
 146             <term><parameter>offset</parameter></term>
 147             <listitem>
 148                 <para>
 149                     Specifies the offset to be applied to the texture coordinates before sampling.
 150                 </para>
 151             </listitem>
 152         </varlistentry>
 153         </variablelist>
 154     </refsect1>
 155     <refsect1 id="description"><title>Description</title>
 156         <para>
 157             <function>textureGradOffset</function> performs a texture lookup at coordinate <parameter>P</parameter> from the
 158             texture bound to <parameter>sampler</parameter> with explicit texture coordinate gradiends as specified in
 159             <parameter>dPdx</parameter> and <parameter>dPdy</parameter>. An explicit offset is also supplied in <parameter>offset</parameter>.
 160             <function>textureGradOffset</function> consumes <parameter>dPdx</parameter> and <parameter>dPdy</parameter> as
 161             <citerefentry><refentrytitle>textureGrad</refentrytitle></citerefentry> and <parameter>offset</parameter> as
 162             <citerefentry><refentrytitle>textureOffset</refentrytitle></citerefentry>.
 163         </para>
 164     </refsect1>
 165     <refsect1 id="versions"><title>Version Support</title>
 166         <informaltable frame="topbot">
 167             #VARTABLECOLS#
 168                 <thead>
 169                     #FUNCTABLEHEADER#
 170                     <row>
 171                         <entry>textureGradOffset</entry>#newin13#
 172                     </row>
 173                     <row>
 174                         <entry>textureGradOffset (gsampler2DRect{Shadow})</entry>#newin14#
 175                     </row>
 176                 </thead>
 177             </tgroup>
 178         </informaltable>
 179     </refsect1>
 180     <refsect1 id="seealso"><title>See Also</title>
 181         <para>
 182             <citerefentry><refentrytitle>texelFetch</refentrytitle></citerefentry>,
 183             <citerefentry><refentrytitle>texelFetchOffset</refentrytitle></citerefentry>,
 184             <citerefentry><refentrytitle>texture</refentrytitle></citerefentry>,
 185             <citerefentry><refentrytitle>textureGather</refentrytitle></citerefentry>,
 186             <citerefentry><refentrytitle>textureGatherOffset</refentrytitle></citerefentry>,
 187             <citerefentry><refentrytitle>textureGatherOffsets</refentrytitle></citerefentry>,
 188             <citerefentry><refentrytitle>textureGrad</refentrytitle></citerefentry>,
 189             <citerefentry><refentrytitle>textureLod</refentrytitle></citerefentry>,
 190             <citerefentry><refentrytitle>textureLodOffset</refentrytitle></citerefentry>,
 191             <citerefentry><refentrytitle>textureOffset</refentrytitle></citerefentry>,
 192             <citerefentry><refentrytitle>textureProj</refentrytitle></citerefentry>,
 193             <citerefentry><refentrytitle>textureProjGrad</refentrytitle></citerefentry>,
 194             <citerefentry><refentrytitle>textureProjGradOffset</refentrytitle></citerefentry>,
 195             <citerefentry><refentrytitle>textureProjLod</refentrytitle></citerefentry>,
 196             <citerefentry><refentrytitle>textureProjLodOffset</refentrytitle></citerefentry>,
 197             <citerefentry><refentrytitle>textureProjOffset</refentrytitle></citerefentry>,
 198             <citerefentry><refentrytitle>textureQueryLod</refentrytitle></citerefentry>,
 199             <citerefentry><refentrytitle>textureSize</refentrytitle></citerefentry>
 200         </para>
 201     </refsect1>
 202     <refsect1 id="Copyright"><title>Copyright</title>
 203         <para>
 204             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
 205             This material may be distributed subject to the terms and conditions set forth in
 206             the Open Publication License, v 1.0, 8 June 1999.
 207             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 208         </para>
 209     </refsect1>
 210 </refentry>