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

Annotation of /doc/docbase/instrument_scripts/nksp/reference/functions/nksp_change_vol_curve_function.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3247 - (hide annotations) (download) (as text)
Sun May 28 22:28:23 2017 UTC (4 years, 2 months ago) by schoenebeck
File MIME type: text/html
File size: 1934 byte(s)
* NKSP: Added function change_vol_curve() and change_tune_curve().
* NKSP: Added built-in constants $NKSP_EASE_IN_EASE_OUT and $NKSP_LINEAR.

1 schoenebeck 3247 <html>
2     <head>
3     <meta name="author" content="Christian Schoenebeck">
4     <title>change_vol_curve() function</title>
5     <meta name="description" content="Changes the curve type of volume changes.">
6     </head>
7     <body>
8     <h1>change_vol_curve()</h1>
9     <p>
10     This function can be used to override the shape of the internal curve
11     type used for volume changes upon calls to <code lang="nksp">change_vol()</code>.
12     That fade curve type is not set globally, but rather on a per-note level.
13     By default, that is if you did not call this function, then
14     <code>$NKSP_EASE_IN_EASE_OUT</code> will be used as curve type.
15     </p>
16    
17     <h3>Function Prototype</h3>
18     <p/>
19     <code lang="nksp">
20     change_vol_curve(??note??, ??curve-type??)
21     </code>
22    
23     <h3>Arguments</h3>
24     <table>
25     <tr>
26     <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
27     </tr>
28     <tr>
29     <td><code>??note??</code></td>
30     <td>Note ID Number or Note ID Array</td>
31     <td>All voices of this note will be modified.<br>
32     [required]</td>
33     </tr>
34     <tr>
35     <td><code>??curve-type??</code></td>
36     <td>Integer Number</td>
37     <td>The curve type to be set, which must be one of the following values:<br>
38     <code>$NKSP_LINEAR</code>: Fade with constant speed throughout entire fade duration.<br>
39     <code>$NKSP_EASE_IN_EASE_OUT</code>: Accelerate fade speed at the beginning of the fade, slow down towards the end of the fade.<br>
40     [required]</td>
41     </tr>
42     </table>
43    
44     <h3>Return Value</h3>
45     <p>None.</p>
46    
47     <h3>Examples</h3>
48     <p>None yet.</p>
49    
50     <h3>See also</h3>
51     <p><code>change_vol()</code>, <code>change_vol_time()</code><p>
52    
53     <h3>Availability</h3>
54     <p>Since LinuxSampler 2.0.0.svn54.<p>
55    
56     <note>
57     This function exists only with NKSP, it is not available with KSP.
58     </note>
59    
60     </body>
61     </html>

  ViewVC Help
Powered by ViewVC