rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / textureProjGradOffset.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="textureProjGradOffsetGrad">\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>textureProjGradOffset</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>textureProjGradOffset</refname>\r
17 <refpurpose>perform a texture lookup with projection, explicit gradients and offset</refpurpose>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>Declaration</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>gvec4 <function>textureProjGradOffset</function></funcdef>\r
23 <paramdef>gsampler1D <parameter>sampler</parameter></paramdef>\r
24 <paramdef>vec2 <parameter>P</parameter></paramdef>\r
25 <paramdef>float <parameter>dPdx</parameter></paramdef>\r
26 <paramdef>float <parameter>dPdy</parameter></paramdef>\r
27 <paramdef>int <parameter>offset</parameter></paramdef>\r
28 </funcprototype>\r
29 <funcprototype>\r
30 <funcdef>gvec4 <function>textureProjGradOffset</function></funcdef>\r
31 <paramdef>gsampler1D <parameter>sampler</parameter></paramdef>\r
32 <paramdef>vec4 <parameter>P</parameter></paramdef>\r
33 <paramdef>float <parameter>dPdx</parameter></paramdef>\r
34 <paramdef>float <parameter>dPdy</parameter></paramdef>\r
35 <paramdef>int <parameter>offset</parameter></paramdef>\r
36 </funcprototype>\r
37 <funcprototype>\r
38 <funcdef>gvec4 <function>textureProjGradOffset</function></funcdef>\r
39 <paramdef>gsampler2D <parameter>sampler</parameter></paramdef>\r
40 <paramdef>vec3 <parameter>P</parameter></paramdef>\r
41 <paramdef>vec2 <parameter>dPdx</parameter></paramdef>\r
42 <paramdef>vec2 <parameter>dPdy</parameter></paramdef>\r
43 <paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
44 </funcprototype>\r
45 <funcprototype>\r
46 <funcdef>gvec4 <function>textureProjGradOffset</function></funcdef>\r
47 <paramdef>gsampler2D <parameter>sampler</parameter></paramdef>\r
48 <paramdef>vec4 <parameter>P</parameter></paramdef>\r
49 <paramdef>vec2 <parameter>dPdx</parameter></paramdef>\r
50 <paramdef>vec2 <parameter>dPdy</parameter></paramdef>\r
51 <paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
52 </funcprototype>\r
53 <funcprototype>\r
54 <funcdef>gvec4 <function>textureProjGradOffset</function></funcdef>\r
55 <paramdef>gsampler3D <parameter>sampler</parameter></paramdef>\r
56 <paramdef>vec4 <parameter>P</parameter></paramdef>\r
57 <paramdef>vec3 <parameter>dPdx</parameter></paramdef>\r
58 <paramdef>vec3 <parameter>dPdy</parameter></paramdef>\r
59 <paramdef>ivec3 <parameter>offset</parameter></paramdef>\r
60 </funcprototype>\r
61 <funcprototype>\r
62 <funcdef>float <function>textureProjGradOffset</function></funcdef>\r
63 <paramdef>sampler1DShadow <parameter>sampler</parameter></paramdef>\r
64 <paramdef>vec4 <parameter>P</parameter></paramdef>\r
65 <paramdef>float <parameter>dPdx</parameter></paramdef>\r
66 <paramdef>float <parameter>dPdy</parameter></paramdef>\r
67 <paramdef>int <parameter>offset</parameter></paramdef>\r
68 </funcprototype>\r
69 <funcprototype>\r
70 <funcdef>float <function>textureProjGradOffset</function></funcdef>\r
71 <paramdef>sampler2DShadow <parameter>sampler</parameter></paramdef>\r
72 <paramdef>vec4 <parameter>P</parameter></paramdef>\r
73 <paramdef>vec2 <parameter>dPdx</parameter></paramdef>\r
74 <paramdef>vec2 <parameter>dPdy</parameter></paramdef>\r
75 <paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
76 </funcprototype>\r
77 <funcprototype>\r
78 <funcdef>gvec4 <function>textureProjGradOffset</function></funcdef>\r
79 <paramdef>gsampler2DRect <parameter>sampler</parameter></paramdef>\r
80 <paramdef>vec3 <parameter>P</parameter></paramdef>\r
81 <paramdef>vec2 <parameter>dPdx</parameter></paramdef>\r
82 <paramdef>vec2 <parameter>dPdy</parameter></paramdef>\r
83 <paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
84 </funcprototype>\r
85 <funcprototype>\r
86 <funcdef>gvec4 <function>textureProjGradOffset</function></funcdef>\r
87 <paramdef>gsampler2DRect <parameter>sampler</parameter></paramdef>\r
88 <paramdef>vec4 <parameter>P</parameter></paramdef>\r
89 <paramdef>vec2 <parameter>dPdx</parameter></paramdef>\r
90 <paramdef>vec2 <parameter>dPdy</parameter></paramdef>\r
91 <paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
92 </funcprototype>\r
93 <funcprototype>\r
94 <funcdef>float <function>textureProjGradOffset</function></funcdef>\r
95 <paramdef>gsampler2DRectShadow <parameter>sampler</parameter></paramdef>\r
96 <paramdef>vec4 <parameter>P</parameter></paramdef>\r
97 <paramdef>vec2 <parameter>dPdx</parameter></paramdef>\r
98 <paramdef>vec2 <parameter>dPdy</parameter></paramdef>\r
99 <paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
100 </funcprototype>\r
101 </funcsynopsis>\r
102 </refsynopsisdiv>\r
103 <refsect1 id="parameters"><title>Parameters</title>\r
104 <variablelist>\r
105 <varlistentry>\r
106 <term><parameter>sampler</parameter></term>\r
107 <listitem>\r
108 <para>\r
109 Specifies the sampler to which the texture from which texels will be retrieved is bound.\r
110 </para>\r
111 </listitem>\r
112 </varlistentry>\r
113 <varlistentry>\r
114 <term><parameter>P</parameter></term>\r
115 <listitem>\r
116 <para>\r
117 Specifies the texture coordinates at which texture will be sampled.\r
118 </para>\r
119 </listitem>\r
120 </varlistentry>\r
121 <varlistentry>\r
122 <term><parameter>dPdx</parameter></term>\r
123 <listitem>\r
124 <para>\r
125 Specifies the partial derivative of <parameter>P</parameter> with respect to window x.\r
126 </para>\r
127 </listitem>\r
128 </varlistentry>\r
129 <varlistentry>\r
130 <term><parameter>dPdy</parameter></term>\r
131 <listitem>\r
132 <para>\r
133 Specifies the partial derivative of <parameter>P</parameter> with respect to window y.\r
134 </para>\r
135 </listitem>\r
136 </varlistentry>\r
137 <varlistentry>\r
138 <term><parameter>offset</parameter></term>\r
139 <listitem>\r
140 <para>\r
141 Specifies the offsets, in texels at which the texture will be sampled relative to the projection of <parameter>P</parameter>.\r
142 </para>\r
143 </listitem>\r
144 </varlistentry>\r
145 </variablelist>\r
146 </refsect1>\r
147 <refsect1 id="description"><title>Description</title>\r
148 <para>\r
149 <function>textureProjGradOffset</function> performs a texture lookup with projection and explicit gradients and offsets. The texture coordinates\r
150 consumed from <parameter>P</parameter>, not including the last component of <parameter>P</parameter>,\r
151 are divided by the last component of <parameter>P</parameter>. The resulting <inlineequation><mml:math><mml:msup><mml:mn>3</mml:mn><mml:mi>rd</mml:mi></mml:msup></mml:math></inlineequation>\r
152 component of <parameter>P</parameter> in the shadow forms is used as\r
153 <inlineequation><mml:math><mml:msub><mml:mi>D</mml:mi><mml:mi>ref</mml:mi></mml:msub></mml:math></inlineequation>.\r
154 After these values are computed, the texture lookup proceeds as in <citerefentry><refentrytitle>textureGradOffset</refentrytitle></citerefentry>,\r
155 passing <parameter>dPdx</parameter> and <parameter>dPdy</parameter> as gradients, and <parameter>offset</parameter> as the offset.\r
156 </para>\r
157 </refsect1>\r
158 <refsect1 id="versions"><title>Version Support</title>\r
159 <informaltable frame="topbot">\r
160 #VARTABLECOLS#\r
161 <thead>\r
162 #FUNCTABLEHEADER#\r
163 <row>\r
164 <entry>textureProjGradOffset</entry>#newin13#\r
165 </row>\r
166 <row>\r
167 <entry>textureProjGradOffset (gsampler2DRect{Shadow})</entry>#newin14#\r
168 </row>\r
169 </thead>\r
170 </tgroup>\r
171 </informaltable>\r
172 </refsect1>\r
173 <refsect1 id="seealso"><title>See Also</title>\r
174 <para>\r
175 <citerefentry><refentrytitle>texelFetch</refentrytitle></citerefentry>,\r
176 <citerefentry><refentrytitle>texelFetchOffset</refentrytitle></citerefentry>,\r
177 <citerefentry><refentrytitle>texture</refentrytitle></citerefentry>,\r
178 <citerefentry><refentrytitle>textureGather</refentrytitle></citerefentry>,\r
179 <citerefentry><refentrytitle>textureGatherOffset</refentrytitle></citerefentry>,\r
180 <citerefentry><refentrytitle>textureGatherOffsets</refentrytitle></citerefentry>,\r
181 <citerefentry><refentrytitle>textureGrad</refentrytitle></citerefentry>,\r
182 <citerefentry><refentrytitle>textureGradOffset</refentrytitle></citerefentry>,\r
183 <citerefentry><refentrytitle>textureLod</refentrytitle></citerefentry>,\r
184 <citerefentry><refentrytitle>textureLodOffset</refentrytitle></citerefentry>,\r
185 <citerefentry><refentrytitle>textureOffset</refentrytitle></citerefentry>,\r
186 <citerefentry><refentrytitle>textureProj</refentrytitle></citerefentry>,\r
187 <citerefentry><refentrytitle>textureProjGrad</refentrytitle></citerefentry>,\r
188 <citerefentry><refentrytitle>textureProjLod</refentrytitle></citerefentry>,\r
189 <citerefentry><refentrytitle>textureProjLodOffset</refentrytitle></citerefentry>,\r
190 <citerefentry><refentrytitle>textureProjOffset</refentrytitle></citerefentry>,\r
191 <citerefentry><refentrytitle>textureQueryLod</refentrytitle></citerefentry>,\r
192 <citerefentry><refentrytitle>textureSize</refentrytitle></citerefentry>\r
193 </para>\r
194 </refsect1>\r
195 <refsect1 id="Copyright"><title>Copyright</title>\r
196 <para>\r
197 Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
198 This material may be distributed subject to the terms and conditions set forth in \r
199 the Open Publication License, v 1.0, 8 June 1999.\r
200 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
201 </para>\r
202 </refsect1>\r
203</refentry>\r