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