rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / textureLodOffset.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="textureLodOffsetOffset">\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>textureLodOffset</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>textureLodOffset</refname>\r
17 <refpurpose>perform a texture lookup with explicit level-of-detail and offset</refpurpose>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>Declaration</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>gvec4 <function>textureLodOffset</function></funcdef>\r
23 <paramdef>gsampler1D <parameter>sampler</parameter></paramdef>\r
24 <paramdef>float <parameter>P</parameter></paramdef>\r
25 <paramdef>float <parameter>lod</parameter></paramdef>\r
26 <paramdef>int <parameter>offset</parameter></paramdef>\r
27 </funcprototype>\r
28 <funcprototype>\r
29 <funcdef>gvec4 <function>textureLodOffset</function></funcdef>\r
30 <paramdef>gsampler2D <parameter>sampler</parameter></paramdef>\r
31 <paramdef>vec2 <parameter>P</parameter></paramdef>\r
32 <paramdef>float <parameter>lod</parameter></paramdef>\r
33 <paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
34 </funcprototype>\r
35 <funcprototype>\r
36 <funcdef>gvec4 <function>textureLodOffset</function></funcdef>\r
37 <paramdef>gsampler3D <parameter>sampler</parameter></paramdef>\r
38 <paramdef>vec3 <parameter>P</parameter></paramdef>\r
39 <paramdef>float <parameter>lod</parameter></paramdef>\r
40 <paramdef>ivec3 <parameter>offset</parameter></paramdef>\r
41 </funcprototype>\r
42 <funcprototype>\r
43 <funcdef>float <function>textureLodOffset</function></funcdef>\r
44 <paramdef>sampler1DShadow <parameter>sampler</parameter></paramdef>\r
45 <paramdef>vec3 <parameter>P</parameter></paramdef>\r
46 <paramdef>float <parameter>lod</parameter></paramdef>\r
47 <paramdef>int <parameter>offset</parameter></paramdef>\r
48 </funcprototype>\r
49 <funcprototype>\r
50 <funcdef>float <function>textureLodOffset</function></funcdef>\r
51 <paramdef>sampler2DShadow <parameter>sampler</parameter></paramdef>\r
52 <paramdef>vec4 <parameter>P</parameter></paramdef>\r
53 <paramdef>float <parameter>lod</parameter></paramdef>\r
54 <paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
55 </funcprototype>\r
56 <funcprototype>\r
57 <funcdef>gvec4 <function>textureLodOffset</function></funcdef>\r
58 <paramdef>gsampler1DArray <parameter>sampler</parameter></paramdef>\r
59 <paramdef>vec2 <parameter>P</parameter></paramdef>\r
60 <paramdef>float <parameter>lod</parameter></paramdef>\r
61 <paramdef>int <parameter>offset</parameter></paramdef>\r
62 </funcprototype>\r
63 <funcprototype>\r
64 <funcdef>gvec4 <function>textureLodOffset</function></funcdef>\r
65 <paramdef>gsampler2DArray <parameter>sampler</parameter></paramdef>\r
66 <paramdef>vec3 <parameter>P</parameter></paramdef>\r
67 <paramdef>float <parameter>lod</parameter></paramdef>\r
68 <paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
69 </funcprototype>\r
70 <funcprototype>\r
71 <funcdef>float <function>textureLodOffset</function></funcdef>\r
72 <paramdef>sampler1DArrayShadow <parameter>sampler</parameter></paramdef>\r
73 <paramdef>vec3 <parameter>P</parameter></paramdef>\r
74 <paramdef>float <parameter>lod</parameter></paramdef>\r
75 <paramdef>int <parameter>offset</parameter></paramdef>\r
76 </funcprototype>\r
77 </funcsynopsis>\r
78 </refsynopsisdiv>\r
79 <refsect1 id="parameters"><title>Parameters</title>\r
80 <variablelist>\r
81 <varlistentry>\r
82 <term><parameter>sampler</parameter></term>\r
83 <listitem>\r
84 <para>\r
85 Specifies the sampler to which the texture from which texels will be retrieved is bound.\r
86 </para>\r
87 </listitem>\r
88 </varlistentry>\r
89 <varlistentry>\r
90 <term><parameter>P</parameter></term>\r
91 <listitem>\r
92 <para>\r
93 Specifies the texture coordinates at which the texture will be sampled.\r
94 </para>\r
95 </listitem>\r
96 </varlistentry>\r
97 <varlistentry>\r
98 <term><parameter>lod</parameter></term>\r
99 <listitem>\r
100 <para>\r
101 Specifies the explicit level-of-detail from which texels will be fetched.\r
102 </para>\r
103 </listitem>\r
104 </varlistentry>\r
105 <varlistentry>\r
106 <term><parameter>offset</parameter></term>\r
107 <listitem>\r
108 <para>\r
109 Specifies the offset that will be applied to <parameter>P</parameter> before texels are fetched.\r
110 </para>\r
111 </listitem>\r
112 </varlistentry>\r
113 </variablelist>\r
114 </refsect1>\r
115 <refsect1 id="description"><title>Description</title>\r
116 <para>\r
117 <function>textureLodOffset</function> performs a texture lookup at coordinate <parameter>P</parameter> from the\r
118 texture bound to <parameter>sampler</parameter> with an explicit level-of-detail as specified in <parameter>lod</parameter>.\r
119 Behavior is the same as in <citerefentry><refentrytitle>textureLod</refentrytitle></citerefentry> except that before\r
120 sampling, <parameter>offset</parameter> is added to <parameter>P</parameter>.\r
121 </para>\r
122 </refsect1>\r
123 <refsect1 id="versions"><title>Version Support</title>\r
124 <informaltable frame="topbot">\r
125 #VARTABLECOLS#\r
126 <thead>\r
127 #FUNCTABLEHEADER#\r
128 <row>\r
129 <entry>textureLodOffset</entry>#newin13#\r
130 </row>\r
131 <row>\r
132 <entry>textureLodOffset (gsampler2DRect{Shadow})</entry>#newin14#\r
133 </row>\r
134 <row>\r
135 <entry>textureLodOffset (gsamplerCubeArray)</entry>#newin40#\r
136 </row>\r
137 </thead>\r
138 </tgroup>\r
139 </informaltable>\r
140 </refsect1>\r
141 <refsect1 id="seealso"><title>See Also</title>\r
142 <para>\r
143 <citerefentry><refentrytitle>texelFetch</refentrytitle></citerefentry>,\r
144 <citerefentry><refentrytitle>texelFetchOffset</refentrytitle></citerefentry>,\r
145 <citerefentry><refentrytitle>texture</refentrytitle></citerefentry>,\r
146 <citerefentry><refentrytitle>textureGather</refentrytitle></citerefentry>,\r
147 <citerefentry><refentrytitle>textureGatherOffset</refentrytitle></citerefentry>,\r
148 <citerefentry><refentrytitle>textureGatherOffsets</refentrytitle></citerefentry>,\r
149 <citerefentry><refentrytitle>textureGrad</refentrytitle></citerefentry>,\r
150 <citerefentry><refentrytitle>textureGradOffset</refentrytitle></citerefentry>,\r
151 <citerefentry><refentrytitle>textureLod</refentrytitle></citerefentry>,\r
152 <citerefentry><refentrytitle>textureOffset</refentrytitle></citerefentry>,\r
153 <citerefentry><refentrytitle>textureProj</refentrytitle></citerefentry>,\r
154 <citerefentry><refentrytitle>textureProjGrad</refentrytitle></citerefentry>,\r
155 <citerefentry><refentrytitle>textureProjGradOffset</refentrytitle></citerefentry>,\r
156 <citerefentry><refentrytitle>textureProjLod</refentrytitle></citerefentry>,\r
157 <citerefentry><refentrytitle>textureProjLodOffset</refentrytitle></citerefentry>,\r
158 <citerefentry><refentrytitle>textureProjOffset</refentrytitle></citerefentry>,\r
159 <citerefentry><refentrytitle>textureQueryLod</refentrytitle></citerefentry>,\r
160 <citerefentry><refentrytitle>textureSize</refentrytitle></citerefentry>\r
161 </para>\r
162 </refsect1>\r
163 <refsect1 id="Copyright"><title>Copyright</title>\r
164 <para>\r
165 Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
166 This material may be distributed subject to the terms and conditions set forth in \r
167 the Open Publication License, v 1.0, 8 June 1999.\r
168 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
169 </para>\r
170 </refsect1>\r
171</refentry>\r