rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / xhtml / texelFetchOffset.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>texelFetchOffset - 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="texelFetchOffsetOffset"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>texelFetchOffset — perform a lookup of a single texel within a texture with an offset</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">gvec4 <b class="fsfunc">texelFetchOffset</b>(</code></td><td>gsampler1D  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</var>, </td></tr><tr><td> </td><td>int  </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">gvec4 <b class="fsfunc">texelFetchOffset</b>(</code></td><td>gsampler2D  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>ivec2  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</var>, </td></tr><tr><td> </td><td>int  </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">gvec4 <b class="fsfunc">texelFetchOffset</b>(</code></td><td>gsampler3D  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>ivec3  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</var>, </td></tr><tr><td> </td><td>int  </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">gvec4 <b class="fsfunc">texelFetchOffset</b>(</code></td><td>gsampler2DRect  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>ivec2  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>int  </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">gvec4 <b class="fsfunc">texelFetchOffset</b>(</code></td><td>gsampler1DArray  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>ivec2  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</var>, </td></tr><tr><td> </td><td>int  </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">gvec4 <b class="fsfunc">texelFetchOffset</b>(</code></td><td>gsampler2DArray  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>ivec3  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</var>, </td></tr><tr><td> </td><td>int  </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>sampler</code></em></span></dt><dd><p>
5 Specifies the sampler to which the texture from which texels will be retrieved is bound.
6 </p></dd><dt><span class="term"><em class="parameter"><code>P</code></em></span></dt><dd><p>
7 Specifies the texture coordinates at which texture will be sampled.
8 </p></dd><dt><span class="term"><em class="parameter"><code>lod</code></em></span></dt><dd><p>
9 If present, specifies the level-of-detail within the texture from which the texel will be fetched.
10 </p></dd><dt><span class="term"><em class="parameter"><code>offset</code></em></span></dt><dd><p>
11 Specifies offset, in texels that will be applied to <em class="parameter"><code>P</code></em> before looking up the texel.
12 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
13 <code class="function">texelFetchOffset</code> performs a lookup of a single texel from texture coordinate <em class="parameter"><code>P</code></em>
14 in the texture bound to <em class="parameter"><code>sampler</code></em>. Before fetching the texel, the offset specified in <em class="parameter"><code>offset</code></em>
15 is added to <em class="parameter"><code>P</code></em>. <em class="parameter"><code>offset</code></em> must be a constant expression. The array layer is specified in the last component of
16 <em class="parameter"><code>P</code></em> for array forms. The <em class="parameter"><code>lod</code></em> parameter (if present) specifies the level-of-detail
17 from which the texel will be fetched. The <em class="parameter"><code>sample</code></em> parameter specifies which sample within the texel will be
18 returned when reading from a multi-sample texure.
19 </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">texelFetchOffset</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><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><tr><th align="left">texelFetchOffset (gsampler2DRect)</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><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><tr><th align="left">texelFetchOffset (gsampler2DMS, gsampler2DMSArray)</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><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>
20 <a href="texelFetch.xml"><span class="citerefentry"><span class="refentrytitle">texelFetch</span></span></a>,
21 <a href="texture.xml"><span class="citerefentry"><span class="refentrytitle">texture</span></span></a>,
22 <a href="textureGather.xml"><span class="citerefentry"><span class="refentrytitle">textureGather</span></span></a>,
23 <a href="textureGatherOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureGatherOffset</span></span></a>,
24 <a href="textureGatherOffsets.xml"><span class="citerefentry"><span class="refentrytitle">textureGatherOffsets</span></span></a>,
25 <a href="textureGrad.xml"><span class="citerefentry"><span class="refentrytitle">textureGrad</span></span></a>,
26 <a href="textureGradOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureGradOffset</span></span></a>,
27 <a href="textureLod.xml"><span class="citerefentry"><span class="refentrytitle">textureLod</span></span></a>,
28 <a href="textureLodOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureLodOffset</span></span></a>,
29 <a href="textureOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureOffset</span></span></a>,
30 <a href="textureProj.xml"><span class="citerefentry"><span class="refentrytitle">textureProj</span></span></a>,
31 <a href="textureProjGrad.xml"><span class="citerefentry"><span class="refentrytitle">textureProjGrad</span></span></a>,
32 <a href="textureProjGradOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureProjGradOffset</span></span></a>,
33 <a href="textureProjLod.xml"><span class="citerefentry"><span class="refentrytitle">textureProjLod</span></span></a>,
34 <a href="textureProjLodOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureProjLodOffset</span></span></a>,
35 <a href="textureProjOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureProjOffset</span></span></a>,
36 <a href="textureQueryLod.xml"><span class="citerefentry"><span class="refentrytitle">textureQueryLod</span></span></a>,
37 <a href="textureSize.xml"><span class="citerefentry"><span class="refentrytitle">textureSize</span></span></a>
38 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
39 Copyright <span class="trademark"></span>© 2011 Khronos Group.
40 This material may be distributed subject to the terms and conditions set forth in
41 the Open Publication License, v 1.0, 8 June 1999.
42 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
43 </p></div></div></body></html>