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