diff options
author | Felipe Sateler <fsateler@debian.org> | 2014-01-24 13:54:37 -0300 |
---|---|---|
committer | Felipe Sateler <fsateler@debian.org> | 2014-01-24 13:54:37 -0300 |
commit | bcf06a42deb371baf3deb9f4addb474b08273120 (patch) | |
tree | 4a8c3fb811dd164d4486628d8eff6043ebe8a6c3 /opcodes/readscratch.xml | |
parent | 3a91171181113761a14bcc36a086a8dda144b77b (diff) |
Imported Upstream version 6.02~dfsg
Diffstat (limited to 'opcodes/readscratch.xml')
-rw-r--r-- | opcodes/readscratch.xml | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/opcodes/readscratch.xml b/opcodes/readscratch.xml new file mode 100644 index 0000000..60b8dda --- /dev/null +++ b/opcodes/readscratch.xml @@ -0,0 +1,74 @@ + +<refentry id="readscratch"> +<indexterm id="IndexReadscratch"><primary>readscratch</primary></indexterm> + <refentryinfo><title>Instrument Control:Sensing and Control</title></refentryinfo> + <refmeta> + <refentrytitle>readscratch</refentrytitle> + </refmeta> + + + + <refnamediv> + <refname>readscratch</refname> + + <refpurpose> + returns a value stored in the instance of an instrument. + </refpurpose> + </refnamediv> + + <refsect1> + <title>Description</title> + <para> + The <emphasis>readscratch</emphasis> opcode returns one of four + scalar values stored in the instance of an instrument. + </para> + </refsect1> + + <refsect1> + <title>Syntax</title> + <synopsis>ival <command>readscratch</command>[index]</synopsis> + </refsect1> + + <refsect1> + <title>Initialisation</title> + <para> + <emphasis>ival</emphasis> -- variable for result. + </para> + <para> + <emphasis>index</emphasis> -- which value to read, defaulting + to zero. + </para> + + </refsect1> + + <refsect1> + <title>Examples</title> + <para> + Here is an example of the readscratch opcode. It uses the file <ulink url="examples/readscratch.csd"><citetitle>readscratch.csd</citetitle></ulink>. + <example> + <title>Example of the readscratch 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/readscratch.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + </example> + </para> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <link linkend="writescratch"><citetitle>writescratch</citetitle></link>, + </para> + </refsect1> + + <refsect1> + <title>Credits</title> + <para> + <simplelist> + <member>Author: &namejohn;</member> + <member>March 2013</member> + </simplelist> + </para> + + <para>New in Csound version 6.00</para> + </refsect1> +</refentry> |