File: mix.xml

package info (click to toggle)
khronos-opengl-man4 1.0~svn33624-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,304 kB
  • sloc: xml: 93,066; makefile: 730; python: 627; javascript: 55; sh: 50; php: 4
file content (178 lines) | stat: -rw-r--r-- 8,114 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
<!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="mix">
    <info>
        <copyright>
            <year>2011-2014</year>
            <holder>Khronos Group</holder>
        </copyright>
    </info>
    <refmeta>
        <refentrytitle>mix</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>mix</refname>
        <refpurpose>linearly interpolate between two values</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>Declaration</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>genType <function>mix</function></funcdef>
                <paramdef>genType <parameter>x</parameter></paramdef>
                <paramdef>genType <parameter>y</parameter></paramdef>
                <paramdef>genType <parameter>a</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
        <funcsynopsis>
            <funcprototype>
                <funcdef>genType <function>mix</function></funcdef>
                <paramdef>genType <parameter>x</parameter></paramdef>
                <paramdef>genType <parameter>y</parameter></paramdef>
                <paramdef>float <parameter>a</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
        <funcsynopsis>
            <funcprototype>
                <funcdef>genDType <function>mix</function></funcdef>
                <paramdef>genDType <parameter>x</parameter></paramdef>
                <paramdef>genDType <parameter>y</parameter></paramdef>
                <paramdef>genDType <parameter>a</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
        <funcsynopsis>
            <funcprototype>
                <funcdef>genDType <function>mix</function></funcdef>
                <paramdef>genDType <parameter>x</parameter></paramdef>
                <paramdef>genDType <parameter>y</parameter></paramdef>
                <paramdef>double <parameter>a</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
        <funcsynopsis>
            <funcprototype>
                <funcdef>genType <function>mix</function></funcdef>
                <paramdef>genType <parameter>x</parameter></paramdef>
                <paramdef>genType <parameter>y</parameter></paramdef>
                <paramdef>genBType <parameter>a</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
        <funcsynopsis>
            <funcprototype>
                <funcdef>genDType <function>mix</function></funcdef>
                <paramdef>genDType <parameter>x</parameter></paramdef>
                <paramdef>genDType <parameter>y</parameter></paramdef>
                <paramdef>genBType <parameter>a</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
        <funcsynopsis>
            <funcprototype>
                <funcdef>genIType <function>mix</function></funcdef>
                <paramdef>genIType <parameter>x</parameter></paramdef>
                <paramdef>genIType <parameter>y</parameter></paramdef>
                <paramdef>genBType <parameter>a</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
        <funcsynopsis>
            <funcprototype>
                <funcdef>genUType <function>mix</function></funcdef>
                <paramdef>genUType <parameter>x</parameter></paramdef>
                <paramdef>genUType <parameter>y</parameter></paramdef>
                <paramdef>genBType <parameter>a</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
        <funcsynopsis>
            <funcprototype>
                <funcdef>genBType <function>mix</function></funcdef>
                <paramdef>genBType <parameter>x</parameter></paramdef>
                <paramdef>genBType <parameter>y</parameter></paramdef>
                <paramdef>genBType <parameter>a</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 xml:id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>x</parameter></term>
            <listitem>
                <para>
                    Specify the start of the range in which to interpolate.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>y</parameter></term>
            <listitem>
                <para>
                    Specify the end of the range in which to interpolate.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>a</parameter></term>
            <listitem>
                <para>
                    Specify the value to use to interpolate between <parameter>x</parameter> and <parameter>y</parameter>.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 xml:id="description"><title>Description</title>
        <para>
            <function>mix</function> performs a linear interpolation between
            <parameter>x</parameter> and <parameter>y</parameter> using
            <parameter>a</parameter> to weight between them. The return
            value is computed as $x \times (1 - a) + y \times a$.
        </para>
        <para>
            The variants of <function>mix</function> where
            <parameter>a</parameter> is <constant>genBType</constant> select
            which vector each returned component comes from. For a component
            of <parameter>a</parameter> that is false, the corresponding
            component of <parameter>x</parameter> is returned. For a
            component of <parameter>a</parameter> that is true, the
            corresponding component of <parameter>y</parameter> is returned.
            Components of <parameter>x</parameter> and
            <parameter>y</parameter> that are not selected are allowed to be
            invalid floating-point values and will have no effect on the
            results.
        </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>mix(genType)</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='11']/*)"/>
                    </row>
                    <row>
                        <entry>mix(genDType)</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='40']/*)"/>
                    </row>
                    <row>
                        <entry>mix(genIType), mix(genUType), mix(genBType)</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='45']/*)"/>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>
    <refsect1 xml:id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>min</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>max</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>