[clinton/guile-figl.git] / upstream-doc / manglsl / textureProjLodOffset.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
<refentry id="textureProjLodOffsetOffset">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2011</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>textureProjLodOffset</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>textureProjLodOffset</refname>\r
        <refpurpose>perform a texture lookup with projection and explicit level-of-detail and offset</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>Declaration</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>gvec4 <function>textureProjLodOffset</function></funcdef>\r
                <paramdef>gsampler1D <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec2 <parameter>P</parameter></paramdef>\r
                <paramdef>float <parameter>lod</parameter></paramdef>\r
                <paramdef>int <parameter>offset</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>gvec4 <function>textureProjLodOffset</function></funcdef>\r
                <paramdef>gsampler1D <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec4 <parameter>P</parameter></paramdef>\r
                <paramdef>float <parameter>lod</parameter></paramdef>\r
                <paramdef>int <parameter>offset</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>gvec4 <function>textureProjLodOffset</function></funcdef>\r
                <paramdef>gsampler2D <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec3 <parameter>P</parameter></paramdef>\r
                <paramdef>float <parameter>lod</parameter></paramdef>\r
                <paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>gvec4 <function>textureProjLodOffset</function></funcdef>\r
                <paramdef>gsampler2D <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec4 <parameter>P</parameter></paramdef>\r
                <paramdef>float <parameter>lod</parameter></paramdef>\r
                <paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>gvec4 <function>textureProjLodOffset</function></funcdef>\r
                <paramdef>gsampler3D <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec4 <parameter>P</parameter></paramdef>\r
                <paramdef>float <parameter>lod</parameter></paramdef>\r
                <paramdef>ivec3 <parameter>offset</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>float <function>textureProjLodOffset</function></funcdef>\r
                <paramdef>sampler1DShadow <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec4 <parameter>P</parameter></paramdef>\r
                <paramdef>float <parameter>lod</parameter></paramdef>\r
                <paramdef>int <parameter>offset</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>float <function>textureProjLodOffset</function></funcdef>\r
                <paramdef>sampler2DShadow <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec4 <parameter>P</parameter></paramdef>\r
                <paramdef>float <parameter>lod</parameter></paramdef>\r
                <paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>sampler</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the sampler to which the texture from which texels will be retrieved is bound.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>P</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the texture coordinates at which texture will be sampled.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>lod</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the explicit level-of-detail from which to fetch texels.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>offset</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the offset, in texels, to be applied to <parameter>P</parameter> before fetching texels.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>textureProjLodOffset</function> performs a texture lookup with projection from an explicitly specified level-of-detail with an offset applied\r
            to the texture coordinates before sampling. The texture coordinates\r
            consumed from <parameter>P</parameter>, not including the last component of <parameter>P</parameter>,\r
            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
            component of <parameter>P</parameter> in the shadow forms is used as\r
            <inlineequation><mml:math><mml:msub><mml:mi>D</mml:mi><mml:mi>ref</mml:mi></mml:msub></mml:math></inlineequation>.\r
            After these values are computed, the texture lookup proceeds as in <citerefentry><refentrytitle>textureLodOffset</refentrytitle></citerefentry>,\r
            with <parameter>lod</parameter> used to specify the level-of-detail from which the texture will be sampled and <parameter>offset</parameter>\r
            used to specifiy the offset, in texels, to be applied to the texture coordinates before sampling.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="versions"><title>Version Support</title>\r
        <informaltable frame="topbot">\r
            #VARTABLECOLS#\r
                <thead>\r
                    #FUNCTABLEHEADER#\r
                    <row>\r
                        <entry>textureProjLodOffset</entry>#newin13#\r
                    </row>\r
                </thead>\r
            </tgroup>\r
        </informaltable>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>texelFetch</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>texelFetchOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>texture</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureGather</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureGatherOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureGatherOffsets</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureGrad</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureGradOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureLod</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureLodOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureProj</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureProjGrad</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureProjGradOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureProjLod</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureProjOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureQueryLod</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureSize</refentrytitle></citerefentry>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
            This material may be distributed subject to the terms and conditions set forth in \r
            the Open Publication License, v 1.0, 8 June 1999.\r
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
        </para>\r
    </refsect1>\r
</refentry>\r
Commit	Line	Data
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="textureProjLodOffsetOffset">\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>textureProjLodOffset</refentrytitle>\r
	13	<manvolnum>3G</manvolnum>\r
	14	</refmeta>\r
	15	<refnamediv>\r
	16	<refname>textureProjLodOffset</refname>\r
	17	<refpurpose>perform a texture lookup with projection and 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>textureProjLodOffset</function></funcdef>\r
	23	<paramdef>gsampler1D <parameter>sampler</parameter></paramdef>\r
	24	<paramdef>vec2 <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>textureProjLodOffset</function></funcdef>\r
	30	<paramdef>gsampler1D <parameter>sampler</parameter></paramdef>\r
	31	<paramdef>vec4 <parameter>P</parameter></paramdef>\r
	32	<paramdef>float <parameter>lod</parameter></paramdef>\r
	33	<paramdef>int <parameter>offset</parameter></paramdef>\r
	34	</funcprototype>\r
	35	<funcprototype>\r
	36	<funcdef>gvec4 <function>textureProjLodOffset</function></funcdef>\r
	37	<paramdef>gsampler2D <parameter>sampler</parameter></paramdef>\r
	38	<paramdef>vec3 <parameter>P</parameter></paramdef>\r
	39	<paramdef>float <parameter>lod</parameter></paramdef>\r
	40	<paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
	41	</funcprototype>\r
	42	<funcprototype>\r
	43	<funcdef>gvec4 <function>textureProjLodOffset</function></funcdef>\r
	44	<paramdef>gsampler2D <parameter>sampler</parameter></paramdef>\r
	45	<paramdef>vec4 <parameter>P</parameter></paramdef>\r
	46	<paramdef>float <parameter>lod</parameter></paramdef>\r
	47	<paramdef>ivec2 <parameter>offset</parameter></paramdef>\r
	48	</funcprototype>\r
	49	<funcprototype>\r
	50	<funcdef>gvec4 <function>textureProjLodOffset</function></funcdef>\r
	51	<paramdef>gsampler3D <parameter>sampler</parameter></paramdef>\r
	52	<paramdef>vec4 <parameter>P</parameter></paramdef>\r
	53	<paramdef>float <parameter>lod</parameter></paramdef>\r
	54	<paramdef>ivec3 <parameter>offset</parameter></paramdef>\r
	55	</funcprototype>\r
	56	<funcprototype>\r
	57	<funcdef>float <function>textureProjLodOffset</function></funcdef>\r
	58	<paramdef>sampler1DShadow <parameter>sampler</parameter></paramdef>\r
	59	<paramdef>vec4 <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>float <function>textureProjLodOffset</function></funcdef>\r
65	<paramdef>sampler2DShadow <parameter>sampler</parameter></paramdef>\r
66	<paramdef>vec4 <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	</funcsynopsis>\r
71	</refsynopsisdiv>\r
72	<refsect1 id="parameters"><title>Parameters</title>\r
73	<variablelist>\r
74	<varlistentry>\r
75	<term><parameter>sampler</parameter></term>\r
76	<listitem>\r
77	<para>\r
78	Specifies the sampler to which the texture from which texels will be retrieved is bound.\r
79	</para>\r
80	</listitem>\r
81	</varlistentry>\r
82	<varlistentry>\r
83	<term><parameter>P</parameter></term>\r
84	<listitem>\r
85	<para>\r
86	Specifies the texture coordinates at which texture will be sampled.\r
87	</para>\r
88	</listitem>\r
89	</varlistentry>\r
90	<varlistentry>\r
91	<term><parameter>lod</parameter></term>\r
92	<listitem>\r
93	<para>\r
94	Specifies the explicit level-of-detail from which to fetch texels.\r
95	</para>\r
96	</listitem>\r
97	</varlistentry>\r
98	<varlistentry>\r
99	<term><parameter>offset</parameter></term>\r
100	<listitem>\r
101	<para>\r
102	Specifies the offset, in texels, to be applied to <parameter>P</parameter> before fetching texels.\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>textureProjLodOffset</function> performs a texture lookup with projection from an explicitly specified level-of-detail with an offset applied\r
111	to the texture coordinates before sampling. The texture coordinates\r
112	consumed from <parameter>P</parameter>, not including the last component of <parameter>P</parameter>,\r
113	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
114	component of <parameter>P</parameter> in the shadow forms is used as\r
115	<inlineequation><mml:math><mml:msub><mml:mi>D</mml:mi><mml:mi>ref</mml:mi></mml:msub></mml:math></inlineequation>.\r
116	After these values are computed, the texture lookup proceeds as in <citerefentry><refentrytitle>textureLodOffset</refentrytitle></citerefentry>,\r
117	with <parameter>lod</parameter> used to specify the level-of-detail from which the texture will be sampled and <parameter>offset</parameter>\r
118	used to specifiy the offset, in texels, to be applied to the texture coordinates before sampling.\r
119	</para>\r
120	</refsect1>\r
121	<refsect1 id="versions"><title>Version Support</title>\r
122	<informaltable frame="topbot">\r
123	#VARTABLECOLS#\r
124	<thead>\r
125	#FUNCTABLEHEADER#\r
126	<row>\r
127	<entry>textureProjLodOffset</entry>#newin13#\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>textureProj</refentrytitle></citerefentry>,\r
147	<citerefentry><refentrytitle>textureProjGrad</refentrytitle></citerefentry>,\r
148	<citerefentry><refentrytitle>textureProjGradOffset</refentrytitle></citerefentry>,\r
149	<citerefentry><refentrytitle>textureProjLod</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