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