File: interpolateAtOffset.xml

package info (click to toggle)
khronos-opengl-man4 1.0~svn33624-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 6,344 kB
  • sloc: xml: 93,066; makefile: 730; python: 627; sh: 50; php: 4
file content (100 lines) | stat: -rw-r--r-- 4,784 bytes parent folder | download | duplicates (3)
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
<!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="interpolateAtOffset">
    <info>
        <copyright>
            <year>2011-2014</year>
            <holder>Khronos Group</holder>
        </copyright>
    </info>
    <refmeta>
        <refentrytitle>interpolateAtOffset</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>interpolateAtOffset</refname>
        <refpurpose>sample a varying at specified offset from the center of a pixel</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>Declaration</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>float <function>interpolateAtOffset</function></funcdef>
                <paramdef>float <parameter>interpolant</parameter></paramdef>
                <paramdef>vec2 <parameter>offset</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>vec2 <function>interpolateAtOffset</function></funcdef>
                <paramdef>vec2 <parameter>interpolant</parameter></paramdef>
                <paramdef>vec2 <parameter>offset</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>vec3 <function>interpolateAtOffset</function></funcdef>
                <paramdef>vec3 <parameter>interpolant</parameter></paramdef>
                <paramdef>vec2 <parameter>offset</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>vec4 <function>interpolateAtOffset</function></funcdef>
                <paramdef>vec4 <parameter>interpolant</parameter></paramdef>
                <paramdef>vec2 <parameter>offset</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 xml:id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>interpolant</parameter></term>
            <listitem>
                <para>
                    Specifies the interpolant to be sampled at the specified offset.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>offset</parameter></term>
            <listitem>
                <para>
                    Specifies the offset from the center of the pixel at which to sample <parameter>interpolant</parameter>.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 xml:id="description"><title>Description</title>
        <para>
            <function>interpolateAtOffset</function> returns the value of the input varying <parameter>interpolant</parameter>
            sampled at an offset from the center of the pixel specified by <parameter>offset</parameter>. The two floating-point
            components of <parameter>offset</parameter> give the offset in pixels in the <emphasis>x</emphasis> and <emphasis>y</emphasis>
            directions from the center of the pixel, respectively. An offset of (0, 0) identifies the center of the pixel. The range and granularity of
            offsets supported by this function is implementation-dependent.
        </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>interpolateAtoOffset</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='40']/*)"/>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>
    <refsect1 xml:id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>interpolateAtCentroid</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>interpolateAtSample</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>