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