rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / xhtml / textureLod.xml
CommitLineData
7faf1d71
AW
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>textureLod - 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="textureLod"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>textureLod — perform a texture lookup with explicit level-of-detail</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">textureLod</b>(</code></td><td>gsampler1D  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>float  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>float  </td><td><var class="pdparam">lod</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">textureLod</b>(</code></td><td>gsampler2D  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>vec2  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>float  </td><td><var class="pdparam">lod</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">textureLod</b>(</code></td><td>gsampler3D  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>vec3  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>float  </td><td><var class="pdparam">lod</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">textureLod</b>(</code></td><td>gsamplerCube  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>vec3  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>float  </td><td><var class="pdparam">lod</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">float <b class="fsfunc">textureLod</b>(</code></td><td>sampler1DShadow  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>vec3  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>float  </td><td><var class="pdparam">lod</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">float <b class="fsfunc">textureLod</b>(</code></td><td>sampler2DShadow  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>vec4  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>float  </td><td><var class="pdparam">lod</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">textureLod</b>(</code></td><td>gsampler1DArray  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>vec2  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>float  </td><td><var class="pdparam">lod</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">textureLod</b>(</code></td><td>gsampler2DArray  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>vec3  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>float  </td><td><var class="pdparam">lod</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">float <b class="fsfunc">textureLod</b>(</code></td><td>sampler1DArrayShadow  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>vec3  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>float  </td><td><var class="pdparam">lod</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">textureLod</b>(</code></td><td>gsamplerCubeArray  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>vec4  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>float  </td><td><var class="pdparam">lod</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 Specifies the explicit level-of-detail
10 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
11 <code class="function">textureLod</code> performs a texture lookup at coordinate <em class="parameter"><code>P</code></em> from the
12 texture bound to <em class="parameter"><code>sampler</code></em> with an explicit level-of-detail as specified in <em class="parameter"><code>lod</code></em>.
13 <em class="parameter"><code>lod</code></em> specifies
14 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:msub><mml:mi>λ</mml:mi><mml:mi>base</mml:mi></mml:msub></mml:math>
15 and sets the partial derivatives as follows:
16 </p><p>
17 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
18 <mml:mtable rowalign="center">
19 <mml:mtr>
20 <mml:mtd>
21 <mml:mrow>
22 <mml:mfrac>
23 <mml:mrow>
24 <mml:mi>δ</mml:mi>
25 <mml:mi>u</mml:mi>
26 </mml:mrow>
27 <mml:mrow>
28 <mml:mi>δ</mml:mi>
29 <mml:mi>x</mml:mi>
30 </mml:mrow>
31 </mml:mfrac>
32 <mml:mo>=</mml:mo>
33 <mml:mn>0</mml:mn>
34 <mml:mo>,</mml:mo>
35 </mml:mrow>
36 </mml:mtd>
37 <mml:mtd>
38 <mml:mrow>
39 <mml:mfrac>
40 <mml:mrow>
41 <mml:mi>δ</mml:mi>
42 <mml:mi>v</mml:mi>
43 </mml:mrow>
44 <mml:mrow>
45 <mml:mi>δ</mml:mi>
46 <mml:mi>x</mml:mi>
47 </mml:mrow>
48 </mml:mfrac>
49 <mml:mo>=</mml:mo>
50 <mml:mn>0</mml:mn>
51 <mml:mo>,</mml:mo>
52 </mml:mrow>
53 </mml:mtd>
54 <mml:mtd>
55 <mml:mrow>
56 <mml:mfrac>
57 <mml:mrow>
58 <mml:mi>δ</mml:mi>
59 <mml:mi>w</mml:mi>
60 </mml:mrow>
61 <mml:mrow>
62 <mml:mi>δ</mml:mi>
63 <mml:mi>x</mml:mi>
64 </mml:mrow>
65 </mml:mfrac>
66 <mml:mo>=</mml:mo>
67 <mml:mn>0</mml:mn>
68 </mml:mrow>
69 </mml:mtd>
70 </mml:mtr>
71 <mml:mtr>
72 <mml:mtd>
73 <mml:mrow>
74 <mml:mfrac>
75 <mml:mrow>
76 <mml:mi>δ</mml:mi>
77 <mml:mi>u</mml:mi>
78 </mml:mrow>
79 <mml:mrow>
80 <mml:mi>δ</mml:mi>
81 <mml:mi>y</mml:mi>
82 </mml:mrow>
83 </mml:mfrac>
84 <mml:mo>=</mml:mo>
85 <mml:mn>0</mml:mn>
86 <mml:mo>,</mml:mo>
87 </mml:mrow>
88 </mml:mtd>
89 <mml:mtd>
90 <mml:mrow>
91 <mml:mfrac>
92 <mml:mrow>
93 <mml:mi>δ</mml:mi>
94 <mml:mi>v</mml:mi>
95 </mml:mrow>
96 <mml:mrow>
97 <mml:mi>δ</mml:mi>
98 <mml:mi>y</mml:mi>
99 </mml:mrow>
100 </mml:mfrac>
101 <mml:mo>=</mml:mo>
102 <mml:mn>0</mml:mn>
103 <mml:mo>,</mml:mo>
104 </mml:mrow>
105 </mml:mtd>
106 <mml:mtd>
107 <mml:mrow>
108 <mml:mfrac>
109 <mml:mrow>
110 <mml:mi>δ</mml:mi>
111 <mml:mi>w</mml:mi>
112 </mml:mrow>
113 <mml:mrow>
114 <mml:mi>δ</mml:mi>
115 <mml:mi>y</mml:mi>
116 </mml:mrow>
117 </mml:mfrac>
118 <mml:mo>=</mml:mo>
119 <mml:mn>0</mml:mn>
120 </mml:mrow>
121 </mml:mtd>
122 </mml:mtr>
123 </mml:mtable>
124 </mml:math>
125 </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">textureLod</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">textureLod (gsampler2DRect{Shadow})</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">textureLod (gsamplerCubeArray)</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>
126 <a href="texelFetch.xml"><span class="citerefentry"><span class="refentrytitle">texelFetch</span></span></a>,
127 <a href="texelFetchOffset.xml"><span class="citerefentry"><span class="refentrytitle">texelFetchOffset</span></span></a>,
128 <a href="texture.xml"><span class="citerefentry"><span class="refentrytitle">texture</span></span></a>,
129 <a href="textureGather.xml"><span class="citerefentry"><span class="refentrytitle">textureGather</span></span></a>,
130 <a href="textureGatherOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureGatherOffset</span></span></a>,
131 <a href="textureGatherOffsets.xml"><span class="citerefentry"><span class="refentrytitle">textureGatherOffsets</span></span></a>,
132 <a href="textureGrad.xml"><span class="citerefentry"><span class="refentrytitle">textureGrad</span></span></a>,
133 <a href="textureGradOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureGradOffset</span></span></a>,
134 <a href="textureLodOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureLodOffset</span></span></a>,
135 <a href="textureOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureOffset</span></span></a>,
136 <a href="textureProj.xml"><span class="citerefentry"><span class="refentrytitle">textureProj</span></span></a>,
137 <a href="textureProjGrad.xml"><span class="citerefentry"><span class="refentrytitle">textureProjGrad</span></span></a>,
138 <a href="textureProjGradOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureProjGradOffset</span></span></a>,
139 <a href="textureProjLod.xml"><span class="citerefentry"><span class="refentrytitle">textureProjLod</span></span></a>,
140 <a href="textureProjLodOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureProjLodOffset</span></span></a>,
141 <a href="textureProjOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureProjOffset</span></span></a>,
142 <a href="textureQueryLod.xml"><span class="citerefentry"><span class="refentrytitle">textureQueryLod</span></span></a>,
143 <a href="textureSize.xml"><span class="citerefentry"><span class="refentrytitle">textureSize</span></span></a>
144 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
145 Copyright <span class="trademark"></span>© 2011 Khronos Group.
146 This material may be distributed subject to the terms and conditions set forth in
147 the Open Publication License, v 1.0, 8 June 1999.
148 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
149 </p></div></div></body></html>