summaryrefslogtreecommitdiff
path: root/opcodes/fluidSetInterpMethod.xml
blob: cbc2cef1b78926aa1cfd94ab683f377fb79f1c65 (plain)
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
<refentry id="fluidSetInterpMethod">
<indexterm id="IndexFluidSetInterpMethod"><primary>fluidSetInterpMethod</primary></indexterm>
  <refentryinfo><title>Signal Generators:Sample Playback</title></refentryinfo>
  <refmeta>
    <refentrytitle>fluidSetInterpMethod</refentrytitle>
  </refmeta>
  <refnamediv>
    <refname>fluidSetInterpMethod</refname>
    <refpurpose>
      Set interpolation method for channel in Fluid Engine
           </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>fluidSetInterpMethod</command> ienginenum, ichannelnum, iInterpMethod</synopsis>
  </refsect1>

  <refsect1>
    <title>Description</title> 
    <para>Set interpolation method for channel in Fluid Engine.  Lower 
    order interpolation methods will render faster at lower fidelity while 
    higher order interpolation methods will render slower at higher fidelity.
    Default interpolation for a channel is 4th order interpolation. 
    </para>  
    </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para><emphasis>ienginenum</emphasis> -- engine number assigned from fluidEngine</para>
    <para><emphasis>ichannelnum</emphasis> -- which channel number to use for the preset in the given fluidEngine</para>
    <para><emphasis>iInterpMethod</emphasis>
    	-- interpolation method, can be any of the following

    	<itemizedlist>
    		<listitem>
    			<para>
    				<emphasis>0</emphasis>
    				-- No Interpolation
    			</para>
    		</listitem>
    		<listitem>
    			<para>
    				<emphasis>1</emphasis>
    				-- Linear Interpolation
    			</para>
    		</listitem>
    		<listitem>
    			<para>
    				<emphasis>4</emphasis>
    				-- 4th Order Interpolation (Default)
    			</para>
    		</listitem>
    		<listitem>
                <para>
                    <emphasis>7</emphasis>
                    -- 7th Order Interpolation (Highest)
                </para>
            </listitem>
    	</itemizedlist>

    </para>

  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para><link linkend="fluidEngine"><citetitle>fluidEngine</citetitle></link></para>
  </refsect1>
  <refsect1>
    <title>Credits</title>
    <para>Author: &namesteven;</para>
    <para>New in version 5.07</para>
  </refsect1>
</refentry>