summaryrefslogtreecommitdiff
path: root/opcodes/flslidbnk2set.xml
blob: e6a95d658e43802f0881e40e21821808b4060eaa (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<refentry id="FLslidBnk2Set">
<indexterm id="IndexFLslidBnk2Set"><primary>FLslidBnk2Set</primary></indexterm>
  <refentryinfo><title>FLTK:Other</title></refentryinfo>
  <refmeta>
    <refentrytitle>FLslidBnk2Set</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>FLslidBnk2Set</refname>
    <refpurpose>
      modify the values of a slider bank.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      <emphasis>FLslidBnk2Set</emphasis> modifies the values of a slider bank according to an array of values stored in a table.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>FLslidBnk2Set</command> ihandle, ifn [, istartIndex, istartSlid, inumSlid]</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ihandle</emphasis> - handle of the sliderBnk (to be used to set its values).
    </para>
    <para>
      <emphasis>ifn</emphasis> - number of a table containing an array of values to set each slider to.
    </para>
    <para>
      <emphasis>istartIndex</emphasis> - (optional) starting index of the table element of to be evaluated firstly. Default value is zero
    </para>
    <para>
      <emphasis>istartSlid</emphasis> - (optional) starting slider to be evaluated. Default 0, denoting the first slider.
    </para>
    <para>
      <emphasis>inumSlid</emphasis> - (optional) number of sliders to be updated. Default 0, denoting all sliders.
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
     <emphasis>FLslidBnk2Set</emphasis> modifies the values of a slider bank (created with <link linkend="FLslidBnk2"><citetitle>FLslidBnk2</citetitle></link> or with <link linkend="FLvslidBnk2"><citetitle>FLvslidBnk2</citetitle></link>) according to an array of values stored into table <emphasis>ifn</emphasis>. It actually allows to update an <link linkend="FLslidBnk2"><citetitle>FLslidBnk2</citetitle></link> (or  <link linkend="FLvslidBnk2"><citetitle>FLvslidBnk2</citetitle></link>) bank of sliders (for instance, using the <link linkend="slider8table"><citetitle>slider8table</citetitle></link> opcode) to a set of values located in a table. User has to set <emphasis>ihandle</emphasis> argument to the handle got from <link linkend="FLslidBnkGetHandle"><citetitle>FLslidBnkGetHandle</citetitle></link> opcode. It works at init-rate only. It is possible to reset only a range of sliders, by using the optional arguments <emphasis>istartIndex</emphasis>, <emphasis>istartSlid</emphasis>, <emphasis>inumSlid</emphasis>
    </para>
    <para>
      <emphasis>FLslidBnk2Set</emphasis> is identical to <link linkend="FLslidBnkSet"><citetitle>FLslidBnkSet</citetitle></link>, but works on <link linkend="FLslidBnk2"><citetitle>FLslidBnk2</citetitle></link> and <link linkend="FLvslidBnk2"><citetitle>FLvslidBnk2</citetitle></link> instead of <link linkend="FLslidBnk"><citetitle>FLslidBnk</citetitle></link> and <link linkend="FLvslidBnk"><citetitle>FLvslidBnk</citetitle></link>.
    </para>
    <para>
      There is a k-rate version of this opcode called <link linkend="FLslidBnk2Setk"><citetitle>FLslidBnk2Setk</citetitle></link>.
    </para>

  </refsect1>
<!--  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the FLslidBnk2Set opcode. It uses the file <ulink url="examples/FLslidBnk2Set.csd"><citetitle>FLslidBnk2Set.csd</citetitle></ulink>.

      <example>
        <title>Example of the FLslidBnk2Set opcode.</title>

        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
          <xi:include href="examples-xml/FLslidBnk2Set.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>-->
  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="FLslider"><citetitle>FLslider</citetitle></link>,
      <link linkend="FLslidBnkGetHandle"><citetitle>FLslidBnkGetHandle</citetitle></link>,
      <link linkend="FLslidBnk"><citetitle>FLslidBnk</citetitle></link>,
      <link linkend="FLslidBnk2"><citetitle>FLslidBnk2</citetitle></link>,
      <link linkend="FLvslidBnk"><citetitle>FLvslidBnk</citetitle></link>,
      <link linkend="FLvslidBnk2"><citetitle>FLvslidBnk2</citetitle></link>
      <link linkend="FLslidBnkSet"><citetitle>FLslidBnkSet</citetitle></link>,
      <link linkend="FLslidBnk2Setk"><citetitle>FLslidBnk2Setk</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Author: &namegabriel;</para>
    <para>New in version 5.06</para>
  </refsect1>
</refentry>