File: textureOffset.xml

package info (click to toggle)
khronos-opengl-man4 1.0~svn33624-3
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 6,304 kB
  • sloc: xml: 93,066; makefile: 730; python: 627; javascript: 55; sh: 50; php: 4
file content (187 lines) | stat: -rw-r--r-- 10,301 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>

<!-- Converted by db4-upgrade version 1.1 -->

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="textureOffset">
    <info>
        <copyright>
            <year>2012-2014</year>
            <holder>Khronos Group</holder>
        </copyright>
    </info>
    <refmeta>
        <refentrytitle>textureOffset</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>textureOffset</refname>
        <refpurpose>perform a texture lookup with offset</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>Declaration</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>gvec4 <function>textureOffset</function></funcdef>
                <paramdef>gsampler1D <parameter>sampler</parameter></paramdef>
                <paramdef>float <parameter>P</parameter></paramdef>
                <paramdef>int <parameter>offset</parameter></paramdef>
                <paramdef>[float <parameter>bias</parameter>]</paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>gvec4 <function>textureOffset</function></funcdef>
                <paramdef>gsampler2D <parameter>sampler</parameter></paramdef>
                <paramdef>vec2 <parameter>P</parameter></paramdef>
                <paramdef>ivec2 <parameter>offset</parameter></paramdef>
                <paramdef>[float <parameter>bias</parameter>]</paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>gvec4 <function>textureOffset</function></funcdef>
                <paramdef>gsampler3D <parameter>sampler</parameter></paramdef>
                <paramdef>vec3 <parameter>P</parameter></paramdef>
                <paramdef>ivec3 <parameter>offset</parameter></paramdef>
                <paramdef>[float <parameter>bias</parameter>]</paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>gvec4 <function>textureOffset</function></funcdef>
                <paramdef>gsampler2DRect <parameter>sampler</parameter></paramdef>
                <paramdef>vec2 <parameter>P</parameter></paramdef>
                <paramdef>ivec2 <parameter>offset</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>float <function>textureOffset</function></funcdef>
                <paramdef>sampler2DRectShadow <parameter>sampler</parameter></paramdef>
                <paramdef>vec3 <parameter>P</parameter></paramdef>
                <paramdef>ivec2 <parameter>offset</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>float <function>textureOffset</function></funcdef>
                <paramdef>sampler1DShadow <parameter>sampler</parameter></paramdef>
                <paramdef>vec3 <parameter>P</parameter></paramdef>
                <paramdef>int <parameter>offset</parameter></paramdef>
                <paramdef>[float <parameter>bias</parameter>]</paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>float <function>textureOffset</function></funcdef>
                <paramdef>sampler2DShadow <parameter>sampler</parameter></paramdef>
                <paramdef>vec4 <parameter>P</parameter></paramdef>
                <paramdef>ivec2 <parameter>offset</parameter></paramdef>
                <paramdef>[float <parameter>bias</parameter>]</paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>gvec4 <function>textureOffset</function></funcdef>
                <paramdef>gsampler1DArray <parameter>sampler</parameter></paramdef>
                <paramdef>vec2 <parameter>P</parameter></paramdef>
                <paramdef>int <parameter>offset</parameter></paramdef>
                <paramdef>[float <parameter>bias</parameter>]</paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>gvec4 <function>textureOffset</function></funcdef>
                <paramdef>gsampler2DArray <parameter>sampler</parameter></paramdef>
                <paramdef>vec3 <parameter>P</parameter></paramdef>
                <paramdef>ivec2 <parameter>offset</parameter></paramdef>
                <paramdef>[float <parameter>bias</parameter>]</paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>float <function>textureOffset</function></funcdef>
                <paramdef>sampler1DArrayShadow <parameter>sampler</parameter></paramdef>
                <paramdef>vec3 <parameter>P</parameter></paramdef>
                <paramdef>int <parameter>offset</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>float <function>textureOffset</function></funcdef>
                <paramdef>sampler2DArrayShadow <parameter>sampler</parameter></paramdef>
                <paramdef>vec4 <parameter>P</parameter></paramdef>
                <paramdef>vec2 <parameter>offset</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 xml:id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>sampler</parameter></term>
            <listitem>
                <para>
                    Specifies the sampler to which the texture from which texels will be retrieved is bound.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>P</parameter></term>
            <listitem>
                <para>
                    Specifies the texture coordinates at which texture will be sampled.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>offset</parameter></term>
            <listitem>
                <para>
                    Specifies offset, in texels that will be applied to <parameter>P</parameter> before looking up the texel.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 xml:id="description"><title>Description</title>
        <para>
            <function>textureOffset</function> performs a texture lookup at coordinate <parameter>P</parameter> from the
            texture bound to <parameter>sampler</parameter> with an an additional offset, specified in texels in <parameter>offset</parameter>
            that will be applied to the (u, v, w) texture coordinates before looking up each texel.
            The offset value must be a constant expression. A limited range of offset values are supported;
            the minimum and maximum offset values are implementation-dependent and may be determined
            by querying <constant>GL_MIN_PROGRAM_TEXEL_OFFSET</constant> and <constant>GL_MAX_PROGRAM_TEXEL_OFFSET</constant>,
            respectively.
        </para>
        <para>
            Note that <parameter>offset</parameter> does not apply to the layer coordinate for texture arrays. Also note
            that offsets are not supported for cube maps.
        </para>
    </refsect1>
    <refsect1 xml:id="versions"><title>Version Support</title>
        <informaltable>
            <tgroup cols="13" align="left">
                <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="funchead.xml" xpointer="xpointer(/*/*)"/>
                <tbody>
                    <row>
                        <entry>textureOffset</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='13']/*)"/>
                    </row>
                    <row>
                        <entry>textureOffset (gsampler2DRect{Shadow})</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='14']/*)"/>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>
    <refsect1 xml:id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>texelFetch</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>texelFetchOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>texture</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureGather</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureGatherOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureGatherOffsets</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureGrad</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureGradOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureLod</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureLodOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureProj</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureProjGrad</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureProjGradOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureProjLod</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureProjLodOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureProjOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureQueryLod</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureSize</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 xml:id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"/> 2011-2014 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
        </para>
    </refsect1>
</refentry>