summaryrefslogtreecommitdiff
path: root/opcodes/cngoto.xml
blob: 30456a36610c1d6d4d54edfd3fa6102e42d6b143 (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
<refentry id="cngoto">
<indexterm id="IndexCngoto"><primary>cngoto</primary></indexterm>
  <refentryinfo><title>Instrument Control:Program Flow Control</title></refentryinfo>
  <refmeta>
    <refentrytitle>cngoto</refentrytitle>
  </refmeta>



  <refnamediv>
    <refname>cngoto</refname>
    <refpurpose>
      Transfers control on every pass when a condition is not true.
          </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      Transfers control on every pass when the condition is <emphasis>not</emphasis> true.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>cngoto</command> condition, label</synopsis>

    <para>
      where <emphasis>label</emphasis> is in the same instrument block and is not an expression, and where <emphasis>R</emphasis> is one of the Relational operators (<emphasis>&lt;</emphasis>,<emphasis> =</emphasis>, <emphasis>&lt;=</emphasis>, <emphasis>==</emphasis>, <emphasis>!=</emphasis>) (and <emphasis>=</emphasis> for convenience, see also under <link linkend="ControlConditional"><citetitle>Conditional Values</citetitle></link>).
    </para>
  </refsect1>

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

      <example>
        <title>Example of the cngoto 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/cngoto.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>

      Its output should include lines like:
      <screen>
kval = 0.000000, kfreq = 880.000000
kval = 0.999732, kfreq = 880.000000
kval = 1.999639, kfreq = 440.000000
      </screen>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="cggoto"><citetitle>cggoto</citetitle></link>,
      <link linkend="cigoto"><citetitle>cigoto</citetitle></link>,
      <link linkend="ckgoto"><citetitle>ckgoto</citetitle></link>,
      <link linkend="goto"><citetitle>goto</citetitle></link>,
      <link linkend="if"><citetitle>if</citetitle></link>,
      <link linkend="igoto"><citetitle>igoto</citetitle></link>,
      <link linkend="tigoto"><citetitle>tigoto</citetitle></link>,
      <link linkend="timout"><citetitle>timout</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Example written by &namekevin;.</para>
    <para>New in version 4.21</para>
  </refsect1>
</refentry>