[clinton/guile-figl.git] / upstream-doc / manglsl / texelFetchOffset.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="texelFetchOffsetOffset">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2011</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>texelFetchOffset</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>texelFetchOffset</refname>\r
        <refpurpose>perform a lookup of a single texel within a texture with an offset</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>Declaration</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>gvec4 <function>texelFetchOffset</function></funcdef>\r
                <paramdef>gsampler1D <parameter>sampler</parameter></paramdef>\r
                <paramdef>int <parameter>P</parameter></paramdef>\r
                <paramdef>int <parameter>lod</parameter></paramdef>\r
                <paramdef>int <parameter>offset</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>gvec4 <function>texelFetchOffset</function></funcdef>\r
                <paramdef>gsampler2D <parameter>sampler</parameter></paramdef>\r
                <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
                <paramdef>int <parameter>lod</parameter></paramdef>\r
                <paramdef>int <parameter>offset</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>gvec4 <function>texelFetchOffset</function></funcdef>\r
                <paramdef>gsampler3D <parameter>sampler</parameter></paramdef>\r
                <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
                <paramdef>int <parameter>lod</parameter></paramdef>\r
                <paramdef>int <parameter>offset</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>gvec4 <function>texelFetchOffset</function></funcdef>\r
                <paramdef>gsampler2DRect <parameter>sampler</parameter></paramdef>\r
                <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
                <paramdef>int <parameter>offset</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>gvec4 <function>texelFetchOffset</function></funcdef>\r
                <paramdef>gsampler1DArray <parameter>sampler</parameter></paramdef>\r
                <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
                <paramdef>int <parameter>lod</parameter></paramdef>\r
                <paramdef>int <parameter>offset</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>gvec4 <function>texelFetchOffset</function></funcdef>\r
                <paramdef>gsampler2DArray <parameter>sampler</parameter></paramdef>\r
                <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
                <paramdef>int <parameter>lod</parameter></paramdef>\r
                <paramdef>int <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
                    If present, specifies the level-of-detail within the texture from which the texel will be fetched.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>offset</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies offset, in texels that will be applied to <parameter>P</parameter> before looking up the texel.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>texelFetchOffset</function> performs a lookup of a single texel from texture coordinate <parameter>P</parameter>\r
            in the texture bound to <parameter>sampler</parameter>. Before fetching the texel, the offset specified in <parameter>offset</parameter>\r
            is added to <parameter>P</parameter>. <parameter>offset</parameter> must be a constant expression. The array layer is specified in the last component of\r
            <parameter>P</parameter> for array forms. The <parameter>lod</parameter> parameter (if present) specifies the level-of-detail\r
            from which the texel will be fetched. The <parameter>sample</parameter> parameter specifies which sample within the texel will be\r
            returned when reading from a multi-sample texure.\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>texelFetchOffset</entry>#newin13#\r
                    </row>\r
                    <row>\r
                        <entry>texelFetchOffset (gsampler2DRect)</entry>#newin14#\r
                    </row>\r
                    <row>\r
                        <entry>texelFetchOffset (gsampler2DMS, gsampler2DMSArray)</entry>#newin15#\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>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>textureProjLodOffset</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="texelFetchOffsetOffset">\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>texelFetchOffset</refentrytitle>\r
	13	<manvolnum>3G</manvolnum>\r
	14	</refmeta>\r
	15	<refnamediv>\r
	16	<refname>texelFetchOffset</refname>\r
	17	<refpurpose>perform a lookup of a single texel within a texture with an offset</refpurpose>\r
	18	</refnamediv>\r
	19	<refsynopsisdiv><title>Declaration</title>\r
	20	<funcsynopsis>\r
	21	<funcprototype>\r
	22	<funcdef>gvec4 <function>texelFetchOffset</function></funcdef>\r
	23	<paramdef>gsampler1D <parameter>sampler</parameter></paramdef>\r
	24	<paramdef>int <parameter>P</parameter></paramdef>\r
	25	<paramdef>int <parameter>lod</parameter></paramdef>\r
	26	<paramdef>int <parameter>offset</parameter></paramdef>\r
	27	</funcprototype>\r
	28	<funcprototype>\r
	29	<funcdef>gvec4 <function>texelFetchOffset</function></funcdef>\r
	30	<paramdef>gsampler2D <parameter>sampler</parameter></paramdef>\r
	31	<paramdef>ivec2 <parameter>P</parameter></paramdef>\r
	32	<paramdef>int <parameter>lod</parameter></paramdef>\r
	33	<paramdef>int <parameter>offset</parameter></paramdef>\r
	34	</funcprototype>\r
	35	<funcprototype>\r
	36	<funcdef>gvec4 <function>texelFetchOffset</function></funcdef>\r
	37	<paramdef>gsampler3D <parameter>sampler</parameter></paramdef>\r
	38	<paramdef>ivec3 <parameter>P</parameter></paramdef>\r
	39	<paramdef>int <parameter>lod</parameter></paramdef>\r
	40	<paramdef>int <parameter>offset</parameter></paramdef>\r
	41	</funcprototype>\r
	42	<funcprototype>\r
	43	<funcdef>gvec4 <function>texelFetchOffset</function></funcdef>\r
	44	<paramdef>gsampler2DRect <parameter>sampler</parameter></paramdef>\r
	45	<paramdef>ivec2 <parameter>P</parameter></paramdef>\r
	46	<paramdef>int <parameter>offset</parameter></paramdef>\r
	47	</funcprototype>\r
	48	<funcprototype>\r
	49	<funcdef>gvec4 <function>texelFetchOffset</function></funcdef>\r
	50	<paramdef>gsampler1DArray <parameter>sampler</parameter></paramdef>\r
	51	<paramdef>ivec2 <parameter>P</parameter></paramdef>\r
	52	<paramdef>int <parameter>lod</parameter></paramdef>\r
	53	<paramdef>int <parameter>offset</parameter></paramdef>\r
	54	</funcprototype>\r
	55	<funcprototype>\r
	56	<funcdef>gvec4 <function>texelFetchOffset</function></funcdef>\r
	57	<paramdef>gsampler2DArray <parameter>sampler</parameter></paramdef>\r
	58	<paramdef>ivec3 <parameter>P</parameter></paramdef>\r
	59	<paramdef>int <parameter>lod</parameter></paramdef>\r
	60	<paramdef>int <parameter>offset</parameter></paramdef>\r
	61	</funcprototype>\r
	62	</funcsynopsis>\r
	63	</refsynopsisdiv>\r
	64	<refsect1 id="parameters"><title>Parameters</title>\r
65	<variablelist>\r
66	<varlistentry>\r
67	<term><parameter>sampler</parameter></term>\r
68	<listitem>\r
69	<para>\r
70	Specifies the sampler to which the texture from which texels will be retrieved is bound.\r
71	</para>\r
72	</listitem>\r
73	</varlistentry>\r
74	<varlistentry>\r
75	<term><parameter>P</parameter></term>\r
76	<listitem>\r
77	<para>\r
78	Specifies the texture coordinates at which texture will be sampled.\r
79	</para>\r
80	</listitem>\r
81	</varlistentry>\r
82	<varlistentry>\r
83	<term><parameter>lod</parameter></term>\r
84	<listitem>\r
85	<para>\r
86	If present, specifies the level-of-detail within the texture from which the texel will be fetched.\r
87	</para>\r
88	</listitem>\r
89	</varlistentry>\r
90	<varlistentry>\r
91	<term><parameter>offset</parameter></term>\r
92	<listitem>\r
93	<para>\r
94	Specifies offset, in texels that will be applied to <parameter>P</parameter> before looking up the texel.\r
95	</para>\r
96	</listitem>\r
97	</varlistentry>\r
98	</variablelist>\r
99	</refsect1>\r
100	<refsect1 id="description"><title>Description</title>\r
101	<para>\r
102	<function>texelFetchOffset</function> performs a lookup of a single texel from texture coordinate <parameter>P</parameter>\r
103	in the texture bound to <parameter>sampler</parameter>. Before fetching the texel, the offset specified in <parameter>offset</parameter>\r
104	is added to <parameter>P</parameter>. <parameter>offset</parameter> must be a constant expression. The array layer is specified in the last component of\r
105	<parameter>P</parameter> for array forms. The <parameter>lod</parameter> parameter (if present) specifies the level-of-detail\r
106	from which the texel will be fetched. The <parameter>sample</parameter> parameter specifies which sample within the texel will be\r
107	returned when reading from a multi-sample texure.\r
108	</para>\r
109	</refsect1>\r
110	<refsect1 id="versions"><title>Version Support</title>\r
111	<informaltable frame="topbot">\r
112	#VARTABLECOLS#\r
113	<thead>\r
114	#FUNCTABLEHEADER#\r
115	<row>\r
116	<entry>texelFetchOffset</entry>#newin13#\r
117	</row>\r
118	<row>\r
119	<entry>texelFetchOffset (gsampler2DRect)</entry>#newin14#\r
120	</row>\r
121	<row>\r
122	<entry>texelFetchOffset (gsampler2DMS, gsampler2DMSArray)</entry>#newin15#\r
123	</row>\r
124	</thead>\r
125	</tgroup>\r
126	</informaltable>\r
127	</refsect1>\r
128	<refsect1 id="seealso"><title>See Also</title>\r
129	<para>\r
130	<citerefentry><refentrytitle>texelFetch</refentrytitle></citerefentry>,\r
131	<citerefentry><refentrytitle>texture</refentrytitle></citerefentry>,\r
132	<citerefentry><refentrytitle>textureGather</refentrytitle></citerefentry>,\r
133	<citerefentry><refentrytitle>textureGatherOffset</refentrytitle></citerefentry>,\r
134	<citerefentry><refentrytitle>textureGatherOffsets</refentrytitle></citerefentry>,\r
135	<citerefentry><refentrytitle>textureGrad</refentrytitle></citerefentry>,\r
136	<citerefentry><refentrytitle>textureGradOffset</refentrytitle></citerefentry>,\r
137	<citerefentry><refentrytitle>textureLod</refentrytitle></citerefentry>,\r
138	<citerefentry><refentrytitle>textureLodOffset</refentrytitle></citerefentry>,\r
139	<citerefentry><refentrytitle>textureOffset</refentrytitle></citerefentry>,\r
140	<citerefentry><refentrytitle>textureProj</refentrytitle></citerefentry>,\r
141	<citerefentry><refentrytitle>textureProjGrad</refentrytitle></citerefentry>,\r
142	<citerefentry><refentrytitle>textureProjGradOffset</refentrytitle></citerefentry>,\r
143	<citerefentry><refentrytitle>textureProjLod</refentrytitle></citerefentry>,\r
144	<citerefentry><refentrytitle>textureProjLodOffset</refentrytitle></citerefentry>,\r
145	<citerefentry><refentrytitle>textureProjOffset</refentrytitle></citerefentry>,\r
146	<citerefentry><refentrytitle>textureQueryLod</refentrytitle></citerefentry>,\r
147	<citerefentry><refentrytitle>textureSize</refentrytitle></citerefentry>\r
148	</para>\r
149	</refsect1>\r
150	<refsect1 id="Copyright"><title>Copyright</title>\r
151	<para>\r
152	Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
153	This material may be distributed subject to the terms and conditions set forth in \r
154	the Open Publication License, v 1.0, 8 June 1999.\r
155	<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
156	</para>\r
157	</refsect1>\r
158	</refentry>\r