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