upstream-man-pages/manglsl/interpolateAtSample.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="interpolateAtSample">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>interpolateAtSample</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>interpolateAtSample</refname>
  17         <refpurpose>sample a varying at the location of a specified sample</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>float <function>interpolateAtSample</function></funcdef>
  23                 <paramdef>float <parameter>interpolant</parameter></paramdef>
  24                 <paramdef>int <parameter>sample</parameter></paramdef>
  25             </funcprototype>
  26             <funcprototype>
  27                 <funcdef>vec2 <function>interpolateAtSample</function></funcdef>
  28                 <paramdef>vec2 <parameter>interpolant</parameter></paramdef>
  29                 <paramdef>int <parameter>sample</parameter></paramdef>
  30             </funcprototype>
  31             <funcprototype>
  32                 <funcdef>vec3 <function>interpolateAtSample</function></funcdef>
  33                 <paramdef>vec3 <parameter>interpolant</parameter></paramdef>
  34                 <paramdef>int <parameter>sample</parameter></paramdef>
  35             </funcprototype>
  36             <funcprototype>
  37                 <funcdef>vec4 <function>interpolateAtSample</function></funcdef>
  38                 <paramdef>vec4 <parameter>interpolant</parameter></paramdef>
  39                 <paramdef>int <parameter>sample</parameter></paramdef>
  40             </funcprototype>
  41         </funcsynopsis>
  42     </refsynopsisdiv>
  43     <refsect1 id="parameters"><title>Parameters</title>
  44         <variablelist>
  45         <varlistentry>
  46             <term><parameter>interpolant</parameter></term>
  47             <listitem>
  48                 <para>
  49                     Specifies the interpolant to be sampled at the location of sample <parameter>sample</parameter>.
  50                 </para>
  51             </listitem>
  52         </varlistentry>
  53         <varlistentry>
  54             <term><parameter>sample</parameter></term>
  55             <listitem>
  56                 <para>
  57                     Specifies the index of the sample whose location will be used to sample <parameter>interpolant</parameter>.
  58                 </para>
  59             </listitem>
  60         </varlistentry>
  61         </variablelist>
  62     </refsect1>
  63     <refsect1 id="description"><title>Description</title>
  64         <para>
  65             <function>interpolateAtSample</function> returns the value of the input varying <parameter>interpolant</parameter>
  66             sampled at the location of sample number <parameter>sample</parameter>. If multisample buffers are not available,
  67             the input varying will be evaluated at the center of the pixel. If sample <parameter>sample</parameter> does not
  68             exist, the position used to interpolate the input varying is undefined.
  69         </para>
  70     </refsect1>
  71     <refsect1 id="versions"><title>Version Support</title>
  72         <informaltable frame="topbot">
  73             #VARTABLECOLS#
  74                 <thead>
  75                     #FUNCTABLEHEADER#
  76                     <row>
  77                         <entry>interpolateAtSample</entry>#newin40#
  78                     </row>
  79                 </thead>
  80             </tgroup>
  81         </informaltable>
  82     </refsect1>
  83     <refsect1 id="seealso"><title>See Also</title>
  84         <para>
  85             <citerefentry><refentrytitle>interpolateAtCentroid</refentrytitle></citerefentry>,
  86             <citerefentry><refentrytitle>interpolateAtOffset</refentrytitle></citerefentry>
  87         </para>
  88     </refsect1>
  89     <refsect1 id="Copyright"><title>Copyright</title>
  90         <para>
  91             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  92             This material may be distributed subject to the terms and conditions set forth in
  93             the Open Publication License, v 1.0, 8 June 1999.
  94             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  95         </para>
  96     </refsect1>
  97 </refentry>