rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / xhtml / interpolateAtOffset.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3 <!-- saved from url=(0013)about:internet -->
4 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>interpolateAtOffset - OpenGL Shading Language (GLSL)</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="interpolateAtOffset"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>interpolateAtOffset — sample a varying at specified offset from the center of a pixel</p></div><div class="refsynopsisdiv"><h2>Declaration</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">float <b class="fsfunc">interpolateAtOffset</b>(</code></td><td>float  </td><td><var class="pdparam">interpolant</var>, </td></tr><tr><td> </td><td>vec2  </td><td><var class="pdparam">offset</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec2 <b class="fsfunc">interpolateAtOffset</b>(</code></td><td>vec2  </td><td><var class="pdparam">interpolant</var>, </td></tr><tr><td> </td><td>vec2  </td><td><var class="pdparam">offset</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec3 <b class="fsfunc">interpolateAtOffset</b>(</code></td><td>vec3  </td><td><var class="pdparam">interpolant</var>, </td></tr><tr><td> </td><td>vec2  </td><td><var class="pdparam">offset</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">vec4 <b class="fsfunc">interpolateAtOffset</b>(</code></td><td>vec4  </td><td><var class="pdparam">interpolant</var>, </td></tr><tr><td> </td><td>vec2  </td><td><var class="pdparam">offset</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>interpolant</code></em></span></dt><dd><p>
5 Specifies the interpolant to be sampled at the specified offset.
6 </p></dd><dt><span class="term"><em class="parameter"><code>offset</code></em></span></dt><dd><p>
7 Specifies the offset from the center of the pixel at which to sample <em class="parameter"><code>interpolant</code></em>.
8 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
9 <code class="function">interpolateAtOffset</code> returns the value of the input varying <em class="parameter"><code>interpolant</code></em>
10 sampled at an offset from the center of the pixel specified by <em class="parameter"><code>offset</code></em>. The two floating-point
11 components of <em class="parameter"><code>offset</code></em> give the offset in pixels in the <span class="emphasis"><em>x</em></span> and <span class="emphasis"><em>y</em></span>
12 directions from the center of the pixel, respectively. An offset of (0, 0) identifies the center of the pixel. The range and granularity of
13 offsets supported by this function is implementation-dependent.
14 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="versions"></a><h2>Version Support</h2><div class="informaltable"><table border="1"><colgroup><col align="left" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /></colgroup><thead><tr><th align="left"><span class="bold"><strong>Function</strong></span></th><th align="left"><span class="bold"><strong>Version 1.10</strong></span></th><th align="left"><span class="bold"><strong>Version 1.20</strong></span></th><th align="left"><span class="bold"><strong>Version 1.30</strong></span></th><th align="left"><span class="bold"><strong>Version 1.40</strong></span></th><th align="left"><span class="bold"><strong>Version 1.50</strong></span></th><th align="left"><span class="bold"><strong>Version 3.30</strong></span></th><th align="left"><span class="bold"><strong>Version 4.00</strong></span></th><th align="left"><span class="bold"><strong>Version 4.10</strong></span></th><th align="left"><span class="bold"><strong>Version 4.20</strong></span></th><th align="center"><span class="bold"><strong>Version 4.30</strong></span></th></tr><tr><th align="left">interpolateAtoOffset</th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr></thead></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
15 <a href="interpolateAtCentroid.xml"><span class="citerefentry"><span class="refentrytitle">interpolateAtCentroid</span></span></a>,
16 <a href="interpolateAtSample.xml"><span class="citerefentry"><span class="refentrytitle">interpolateAtSample</span></span></a>
17 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
18 Copyright <span class="trademark"></span>© 2011 Khronos Group.
19 This material may be distributed subject to the terms and conditions set forth in
20 the Open Publication License, v 1.0, 8 June 1999.
21 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
22 </p></div></div></body></html>