/[svn]/doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html
ViewVC logotype

Diff of /doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3265 by schoenebeck, Thu Jun 1 00:31:12 2017 UTC revision 3336 by schoenebeck, Sun Jul 30 14:45:49 2017 UTC
# Line 28  Line 28 
28          <th>Function</th> <th>Description</th>          <th>Function</th> <th>Description</th>
29        </tr>        </tr>
30        <tr>        <tr>
31            <td><code lang="nksp">abort()</code></td>
32            <td>Stops execution of a script callback.</td>
33          </tr>
34          <tr>
35          <td><code lang="nksp">array_equal()</code></td>          <td><code lang="nksp">array_equal()</code></td>
36          <td>Check whether two arrays are equal.</td>          <td>Check whether two arrays are equal.</td>
37        </tr>        </tr>
38        <tr>        <tr>
39            <td><code>fork()</code></td>
40            <td>Creates new execution instances (threads).</td>
41          </tr>
42          <tr>
43            <td><code>callback_status()</code></td>
44            <td>Returns the current status of a callback (thread).</td>
45          </tr>
46          <tr>
47          <td><code lang="nksp">dec()</code></td>          <td><code lang="nksp">dec()</code></td>
48          <td>Decrements the passed integer variable by one.</td>          <td>Decrements the passed integer variable by one.</td>
49        </tr>        </tr>
# Line 119  Line 131 
131          <td>Changes panning of voices (stereo balance).</td>          <td>Changes panning of voices (stereo balance).</td>
132        </tr>        </tr>
133        <tr>        <tr>
134            <td><code>change_pan_time()</code></td>
135            <td>Changes the duration of panning (stereo balance) changes.</td>
136          </tr>
137          <tr>
138            <td><code>change_pan_curve()</code></td>
139            <td>Changes the curve type of panning (stereo balance) changes.</td>
140          </tr>
141          <tr>
142          <td><code>change_play_pos()</code></td>          <td><code>change_play_pos()</code></td>
143          <td>Change the sample playback position.</td>          <td>Change the sample playback position.</td>
144        </tr>        </tr>
# Line 163  Line 183 
183          <td>Modifies the decay time of voices.</td>          <td>Modifies the decay time of voices.</td>
184        </tr>        </tr>
185        <tr>        <tr>
186            <td><code>change_sustain()</code></td>
187            <td>Modifies the sustain level of voices.</td>
188          </tr>
189          <tr>
190          <td><code>change_release()</code></td>          <td><code>change_release()</code></td>
191          <td>Modifies the release time of voices.</td>          <td>Modifies the release time of voices.</td>
192        </tr>        </tr>
# Line 271  Line 295 
295          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
296        </tr>        </tr>
297        <tr>        <tr>
298            <td><code>$CALLBACK_STATUS_QUEUE</code></td>
299            <td>Built-in constant reflecting the status of a callback to be
300                alive but suspended. See <code>callback_status()</code> for details.</td>
301          </tr>
302          <tr>
303            <td><code>$CALLBACK_STATUS_RUNNING</code></td>
304            <td>Built-in constant reflecting the status of a callback to be
305                alive and currently executing. See <code>callback_status()</code>
306                for details.</td>
307          </tr>
308          <tr>
309            <td><code>$CALLBACK_STATUS_TERMINATED</code></td>
310            <td>Built-in constant reflecting the status of a callback to be
311                not alive. See <code>callback_status()</code> for details.</td>
312          </tr>
313          <tr>
314          <td><code>$KSP_TIMER</code></td>          <td><code>$KSP_TIMER</code></td>
315          <td>Preserved for compatiblity reasons with KSP, returns the same value          <td>Preserved for compatiblity reasons with KSP, returns the same value
316             as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).             as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
# Line 315  Line 355 
355          </td>          </td>
356        </tr>        </tr>
357        <tr>        <tr>
358            <td><code>%NKSP_CALLBACK_CHILD_ID[]</code></td>
359            <td>
360              Reflects the callback IDs of all child threads which the current
361              script callback instance spawned by having called <code>fork()</code> before.
362              See the latter function for details about this array variable.
363            </td>
364          </tr>
365          <tr>
366            <td><code>$NKSP_CALLBACK_PARENT_ID</code></td>
367            <td>
368              If the current execution thread is a child thread spawned by a <code>fork()</code>
369              call before, then this variable reflects the callback ID of the parent
370              thread which created this child thread. Otherwise this variable is <code>0</code>.
371              See <code>fork()</code> for more details about this variable.
372            </td>
373          </tr>
374          <tr>
375          <td><code>$NKSP_REAL_TIMER</code></td>          <td><code>$NKSP_REAL_TIMER</code></td>
376          <td>Returns the current time stamp in reality (in microseconds). You may          <td>Returns the current time stamp in reality (in microseconds). You may
377              read this variable from time to time to take              read this variable from time to time to take
# Line 682  Line 739 
739          <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>          <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>
740        </tr>        </tr>
741      </table>      </table>
742    
743            <h2>Built-In Preprocessor Conditions</h2>
744        <p>
745          These are the built-in preprocessor conditions available with the NKSP realt-time
746          instrument script language.
747        </p>
748            
749        <h3>Core Language Preprocessor Conditions</h3>
750        <p>
751          Most fundamental NKSP built-in preprocessor conditions, independent from
752          any purpose of being used in a sampler.
753        </p>
754        <table>
755          <tr>
756            <th>Condition</th> <th>Description</th>
757          </tr>
758          <tr>
759            <td><code>NKSP_NO_MESSAGE</code></td>
760            <td>
761              By default this condition is not set. By explicitly enabling this
762              condition with <code>SET_CONDITION(NKSP_NO_MESSAGE)</code> it
763              causes all subsequent <code>message()</code> calls to be ignored
764              and filtered out on preprocessor level. See function <code>message()</code>
765              for details.
766            </td>
767          </tr>
768        </table>
769    
770    </body>    </body>
771  </html>  </html>
Legend:
Removed from v.3265  
changed lines
  Added in v.3336
  ViewVC Help
Powered by ViewVC