/[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 3312 by schoenebeck, Sat Jul 15 17:04:05 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 271  Line 283 
283          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
284        </tr>        </tr>
285        <tr>        <tr>
286            <td><code>$CALLBACK_STATUS_QUEUE</code></td>
287            <td>Built-in constant reflecting the status of a callback to be
288                alive but suspended. See <code>callback_status()</code> for details.</td>
289          </tr>
290          <tr>
291            <td><code>$CALLBACK_STATUS_RUNNING</code></td>
292            <td>Built-in constant reflecting the status of a callback to be
293                alive and currently executing. See <code>callback_status()</code>
294                for details.</td>
295          </tr>
296          <tr>
297            <td><code>$CALLBACK_STATUS_TERMINATED</code></td>
298            <td>Built-in constant reflecting the status of a callback to be
299                not alive. See <code>callback_status()</code> for details.</td>
300          </tr>
301          <tr>
302          <td><code>$KSP_TIMER</code></td>          <td><code>$KSP_TIMER</code></td>
303          <td>Preserved for compatiblity reasons with KSP, returns the same value          <td>Preserved for compatiblity reasons with KSP, returns the same value
304             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 343 
343          </td>          </td>
344        </tr>        </tr>
345        <tr>        <tr>
346            <td><code>%NKSP_CALLBACK_CHILD_ID[]</code></td>
347            <td>
348              Reflects the callback IDs of all child threads which the current
349              script callback instance spawned by having called <code>fork()</code> before.
350              See the latter function for details about this array variable.
351            </td>
352          </tr>
353          <tr>
354            <td><code>$NKSP_CALLBACK_PARENT_ID</code></td>
355            <td>
356              If the current execution thread is a child thread spawned by a <code>fork()</code>
357              call before, then this variable reflects the callback ID of the parent
358              thread which created this child thread. Otherwise this variable is <code>0</code>.
359              See <code>fork()</code> for more details about this variable.
360            </td>
361          </tr>
362          <tr>
363          <td><code>$NKSP_REAL_TIMER</code></td>          <td><code>$NKSP_REAL_TIMER</code></td>
364          <td>Returns the current time stamp in reality (in microseconds). You may          <td>Returns the current time stamp in reality (in microseconds). You may
365              read this variable from time to time to take              read this variable from time to time to take
# Line 682  Line 727 
727          <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>
728        </tr>        </tr>
729      </table>      </table>
730    
731            <h2>Built-In Preprocessor Conditions</h2>
732        <p>
733          These are the built-in preprocessor conditions available with the NKSP realt-time
734          instrument script language.
735        </p>
736            
737        <h3>Core Language Preprocessor Conditions</h3>
738        <p>
739          Most fundamental NKSP built-in preprocessor conditions, independent from
740          any purpose of being used in a sampler.
741        </p>
742        <table>
743          <tr>
744            <th>Condition</th> <th>Description</th>
745          </tr>
746          <tr>
747            <td><code>NKSP_NO_MESSAGE</code></td>
748            <td>
749              By default this condition is not set. By explicitly enabling this
750              condition with <code>SET_CONDITION(NKSP_NO_MESSAGE)</code> it
751              causes all subsequent <code>message()</code> calls to be ignored
752              and filtered out on preprocessor level. See function <code>message()</code>
753              for details.
754            </td>
755          </tr>
756        </table>
757    
758    </body>    </body>
759  </html>  </html>
Legend:
Removed from v.3265  
changed lines
  Added in v.3312
  ViewVC Help
Powered by ViewVC