← Back to branch summary

~ubuntu-branches/ubuntu/trusty/csound-manual/trusty-proposed

« back to all changes in this revision

Viewing changes to opcodes/setksmps.xml

  • Committer: Bazaar Package Importer
  • Author(s): Felipe Sateler
  • Date: 2011-08-01 22:21:58 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20110801222158-90kslkp5ujci2f5d
Tags: 1:5.13~dfsg-1
* New upstream release
 - Add Menno Knevel to the copyright file
 - Refresh patch 2000-stripped-opcodes.diff
 - Update copyright hints file
* Update Vcs-* headers
* Bump Standards-Version

Show diffs side-by-side

added added

removed removed

Lines of Context:
opcodes/setksmps.xml
18
18
    <para>
19
19
      Sets the local ksmps value in a user-defined opcode block.
20
20
    </para>
21
 
 
22
 
    <para>
23
 
      The <emphasis>setksmps</emphasis> statement can be used to set the local <link linkend="ksmps"><citetitle>ksmps</citetitle></link> value of the user-defined opcode block. It has one i-time parameter specifying the new <emphasis>ksmps</emphasis> value (which is left unchanged if zero is used). <emphasis>setksmps</emphasis> should be used before any other opcodes (but allowed after <link linkend="xin"><citetitle>xin</citetitle></link>), otherwise unpredictable results may occur.
24
 
    </para>
25
21
  </refsect1>
26
22
 
27
23
  <refsect1>
49
45
    <warning>
50
46
      <title>Warning about local ksmps</title>
51
47
      <para>
52
 
        When the local <emphasis>ksmps</emphasis> is not the same as the orchestra level <emphasis>ksmps</emphasis> value (as specified in the orchestra header). Global a-rate operations must not be used in the user-defined opcode block.
 
48
        When the local <emphasis>ksmps</emphasis> is not the same as the orchestra level <emphasis>ksmps</emphasis> value (as specified in the orchestra header), global a-rate operations must not be used in the user-defined opcode block.
53
49
      </para>
54
50
 
55
51
      <para>
69
65
    </warning>
70
66
 
71
67
    <para>
72
 
      The <link linkend="setksmps"><citetitle>setksmps</citetitle></link> statement can be used to set the local <emphasis>ksmps</emphasis> value of the user-defined opcode block. It has one i-time parameter specifying the new <emphasis>ksmps</emphasis> value (which is left unchanged if zero is used). <emphasis>setksmps</emphasis> should be used before any other opcodes (but allowed after <emphasis>xin</emphasis>), otherwise unpredictable results may occur.
 
68
      The <emphasis>setksmps</emphasis> statement can be used to set the local <link linkend="ksmps"><citetitle>ksmps</citetitle></link> value of the user-defined opcode block. It has one i-time parameter specifying the new <emphasis>ksmps</emphasis> value (which is left unchanged if zero is used). <emphasis>setksmps</emphasis> should be used before any other opcodes (but allowed after <link linkend="xin"><citetitle>xin</citetitle></link>), otherwise unpredictable results may occur.
73
69
    </para>
74
70
  </refsect1>
75
71
 
78
74
    <para>
79
75
      The syntax of a user-defined opcode block is as follows:
80
76
 
81
 
      <literallayout>
82
 
opcode  name, outtypes, intypes
83
 
xinarg1 [, xinarg2] [, xinarg3] ... [xinargN]  xin
84
 
[setksmps  iksmps]
 
77
      <programlisting>
 
78
<emphasis role="oblock">opcode</emphasis>  name, outtypes, intypes
 
79
xinarg1 [, xinarg2] [, xinarg3] ... [xinargN]  <emphasis role="opc">xin</emphasis>
 
80
[<emphasis role="opc">setksmps</emphasis>  iksmps]
85
81
... the rest of the instrument's code.
86
 
xout  xoutarg1 [, xoutarg2] [, xoutarg3] ... [xoutargN]
87
 
endop
88
 
      </literallayout>
 
82
<emphasis role="opc">xout</emphasis>  xoutarg1 [, xoutarg2] [, xoutarg3] ... [xoutargN]
 
83
<emphasis role="oblock">endop</emphasis>
 
84
      </programlisting>
89
85
    </para>
90
86
 
91
87
    <para>