/[svn]/doc/docbase/instrument_scripts/nksp/reference/functions/nksp_lsb_function.html
ViewVC logotype

Contents of /doc/docbase/instrument_scripts/nksp/reference/functions/nksp_lsb_function.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3679 - (show annotations) (download) (as text)
Fri Dec 27 23:31:04 2019 UTC (4 years, 3 months ago) by schoenebeck
File MIME type: text/html
File size: 1765 byte(s)
* NKSP: Added recently added built-in functions msb() and lsb() to reference
  docs.

1 <html>
2 <head>
3 <meta name="author" content="Christian Schoenebeck">
4 <title>lsb() function</title>
5 <meta name="description" content="Least significant byte of a 14-bit value.">
6 </head>
7 <body>
8 <h1>lsb()</h1>
9 <p>
10 Calculates the least significant byte of a 14 bit value.
11 Low-end bits 1 to 7 of argument are returned as result by this function.
12 </p>
13
14 <h3>Function Prototype</h3>
15 <p/>
16 <code lang="nksp">
17 lsb(??number??)
18 </code>
19
20 <h3>Arguments</h3>
21 <table>
22 <tr>
23 <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
24 </tr>
25 <tr>
26 <td><code>??number??</code></td>
27 <td>Integer Number</td>
28 <td>Original 14 bit input value.<br>
29 [required]</td>
30 </tr>
31 </table>
32
33 <h3>Return Value</h3>
34 <table>
35 <tr>
36 <th>Data Type</th> <th>Description</th>
37 </tr>
38 <tr>
39 <td>Integer Number</td>
40 <td>Low-end 7 bits of passed argument.</td>
41 </tr>
42 </table>
43
44 <h3>Remarks</h3>
45 <p>
46 This functions neither allows finalness,
47 nor unit types for its argument <code>??number??</code>.
48 </p>
49
50 <h3>Examples</h3>
51 <p/>
52 <code>
53 on init
54 message("msb(0) = " & msb(0))
55 message("lsb(0) = " & lsb(0))
56 message("msb(1) = " & msb(1))
57 message("lsb(1) = " & lsb(1))
58 message("msb(2) = " & msb(2))
59 message("lsb(2) = " & lsb(2))
60 message("msb(128) = " & msb(128))
61 message("lsb(128) = " & lsb(128))
62 message("msb(129) = " & msb(129))
63 message("lsb(129) = " & lsb(129))
64 end on
65 </code>
66
67 <h3>See also</h3>
68 <p><code>msb()</code>, <code>sh_left()</code>, <code>sh_right()</code><p>
69
70 <h3>Availability</h3>
71 <p>Since LinuxSampler 2.1.1.svn26.<p>
72
73 </body>
74 </html>

  ViewVC Help
Powered by ViewVC