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