diff options
Diffstat (limited to 'opcodes/until.xml')
| -rw-r--r-- | opcodes/until.xml | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/opcodes/until.xml b/opcodes/until.xml new file mode 100644 index 0000000..ac508dc --- /dev/null +++ b/opcodes/until.xml @@ -0,0 +1,84 @@ + +<refentry id="until"> +<indexterm id="IndexUntil"><primary>until</primary></indexterm> + <refentryinfo><title>Instrument Control:Program Flow Control</title></refentryinfo> + <refmeta> + <refentrytitle>until</refentrytitle> + </refmeta> + + <refnamediv> + <refname>until</refname> + <refpurpose> + A syntactic looping construction. + </refpurpose> + </refnamediv> + + <refsect1> + <title>Description</title> + <para> + A syntactic looping construction. + </para> + </refsect1> + + <refsect1> + <title>Syntax</title> + <synopsis><command>until</command> condition <command>do</command> + ... <command>od</command></synopsis> + </refsect1> + + <refsect1> + <title>Performance</title> + <para> + The statements between the <emphasis>do</emphasis> and + <emphasis>od</emphasis> form the body of a loop which is obeyed + until the conditional becomes true. + </para> + </refsect1> + + <refsect1> + <title>Examples</title> + <para> + Here is an example of the until construction. It uses the file <ulink url="examples/until.csd"><citetitle>until.csd</citetitle></ulink>. + <example> + <title>Example of the until 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/until.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + </example> + Its output should include lines like this: + <screen> +B 0.000 .. 1.000 T 1.000 TT 1.000 M: 0.0 +new alloc for instr 1: +instr 1: p4 = 3.000 +instr 1: p4 = 2.000 +instr 1: p4 = 1.000 +instr 1: p4 = 0.000 +instr 1: p4 = -1.000 +B 1.000 .. 2.000 T 2.000 TT 2.000 M: 0.0 +new alloc for instr 2: +instr 2: p4 = 3.000 +instr 2: p4 = 2.000 +instr 2: p4 = 1.000 +instr 2: p4 = 0.000 +instr 2: p4 = -1.000 +B 2.000 .. 3.000 T 3.000 TT 3.000 M: 0.0 + </screen> + </para> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <link linkend="loop_ge"><citetitle>loop_ge</citetitle></link>, + <link linkend="loop_gt"><citetitle>loop_gt</citetitle></link> and + <link linkend="loop_le"><citetitle>loop_le</citetitle></link>. + <link linkend="loop_lt"><citetitle>loop_lt</citetitle></link>. + </para> + + </refsect1> + + <refsect1> + <title>Credits</title> + <para>&namejohn;.</para> + <para>New in Csound version 5.14 with new parser</para> + </refsect1> +</refentry> |