/[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 3294 by schoenebeck, Tue Jun 27 23:29:31 2017 UTC revision 3362 by schoenebeck, Fri Oct 27 21:26:26 2017 UTC
# Line 37  Line 37 
37        </tr>        </tr>
38        <tr>        <tr>
39          <td><code>fork()</code></td>          <td><code>fork()</code></td>
40          <td>Creates new execution instances.</td>          <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>        </tr>
46        <tr>        <tr>
47          <td><code lang="nksp">dec()</code></td>          <td><code lang="nksp">dec()</code></td>
# Line 127  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 164  Line 176 
176        </tr>        </tr>
177        <tr>        <tr>
178          <td><code>change_attack()</code></td>          <td><code>change_attack()</code></td>
179          <td>Modifies the attack time of voices.</td>          <td>Modifies the amplitude attack time of voices.</td>
180        </tr>        </tr>
181        <tr>        <tr>
182          <td><code>change_decay()</code></td>          <td><code>change_decay()</code></td>
183          <td>Modifies the decay time of voices.</td>          <td>Modifies the amplitude decay time of voices.</td>
184          </tr>
185          <tr>
186            <td><code>change_sustain()</code></td>
187            <td>Modifies the amplitude sustain level of voices.</td>
188        </tr>        </tr>
189        <tr>        <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 amplitude release time of voices.</td>
192          </tr>
193    
194          <tr>
195            <td><code>change_cutoff_attack()</code></td>
196            <td>Modifies the filter cutoff attack time of voices.</td>
197        </tr>        </tr>
198        <tr>        <tr>
199            <td><code>change_cutoff_decay()</code></td>
200            <td>Modifies the filter cutoff decay time of voices.</td>
201          </tr>
202          <tr>
203            <td><code>change_cutoff_sustain()</code></td>
204            <td>Modifies the filter cutoff sustain level of voices.</td>
205          </tr>
206          <tr>
207            <td><code>change_cutoff_release()</code></td>
208            <td>Modifies the filter cutoff release time of voices.</td>
209          </tr>
210    
211          <tr>
212          <td><code>change_amp_lfo_depth()</code></td>          <td><code>change_amp_lfo_depth()</code></td>
213          <td>Modifies the amplitude LFO depth.</td>          <td>Modifies the amplitude LFO depth.</td>
214        </tr>        </tr>
# Line 182  Line 216 
216          <td><code>change_amp_lfo_freq()</code></td>          <td><code>change_amp_lfo_freq()</code></td>
217          <td>Modifies the amplitude LFO frequency.</td>          <td>Modifies the amplitude LFO frequency.</td>
218        </tr>        </tr>
219    
220          <tr>
221            <td><code>change_cutoff_lfo_depth()</code></td>
222            <td>Modifies the filter cutoff LFO depth.</td>
223          </tr>
224          <tr>
225            <td><code>change_cutoff_lfo_freq()</code></td>
226            <td>Modifies the filter cutoff LFO frequency.</td>
227          </tr>
228    
229        <tr>        <tr>
230          <td><code>change_pitch_lfo_depth()</code></td>          <td><code>change_pitch_lfo_depth()</code></td>
231          <td>Modifies the pitch LFO depth.</td>          <td>Modifies the pitch LFO depth.</td>
# Line 279  Line 323 
323          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
324        </tr>        </tr>
325        <tr>        <tr>
326            <td><code>$CALLBACK_STATUS_QUEUE</code></td>
327            <td>Built-in constant reflecting the status of a callback to be
328                alive but suspended. See <code>callback_status()</code> for details.</td>
329          </tr>
330          <tr>
331            <td><code>$CALLBACK_STATUS_RUNNING</code></td>
332            <td>Built-in constant reflecting the status of a callback to be
333                alive and currently executing. See <code>callback_status()</code>
334                for details.</td>
335          </tr>
336          <tr>
337            <td><code>$CALLBACK_STATUS_TERMINATED</code></td>
338            <td>Built-in constant reflecting the status of a callback to be
339                not alive. See <code>callback_status()</code> for details.</td>
340          </tr>
341          <tr>
342          <td><code>$KSP_TIMER</code></td>          <td><code>$KSP_TIMER</code></td>
343          <td>Preserved for compatiblity reasons with KSP, returns the same value          <td>Preserved for compatiblity reasons with KSP, returns the same value
344             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 326  Line 386 
386          <td><code>%NKSP_CALLBACK_CHILD_ID[]</code></td>          <td><code>%NKSP_CALLBACK_CHILD_ID[]</code></td>
387          <td>          <td>
388            Reflects the callback IDs of all child threads which the current            Reflects the callback IDs of all child threads which the current
389            script callback instance spawned by calling function <code>fork()</code>.            script callback instance spawned by having called <code>fork()</code> before.
390            See the latter function for details about this array variable.            See the latter function for details about this array variable.
391          </td>          </td>
392        </tr>        </tr>
# Line 335  Line 395 
395          <td>          <td>
396            If the current execution thread is a child thread spawned by a <code>fork()</code>            If the current execution thread is a child thread spawned by a <code>fork()</code>
397            call before, then this variable reflects the callback ID of the parent            call before, then this variable reflects the callback ID of the parent
398            thread which created this child thread. Otherwise this variable is zero.            thread which created this child thread. Otherwise this variable is <code>0</code>.
399            See function <code>fork()</code> for more details about this variable.            See <code>fork()</code> for more details about this variable.
400          </td>          </td>
401        </tr>        </tr>
402        <tr>        <tr>
# Line 707  Line 767 
767          <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>
768        </tr>        </tr>
769      </table>      </table>
770    
771            <h2>Built-In Preprocessor Conditions</h2>
772        <p>
773          These are the built-in preprocessor conditions available with the NKSP realt-time
774          instrument script language.
775        </p>
776            
777        <h3>Core Language Preprocessor Conditions</h3>
778        <p>
779          Most fundamental NKSP built-in preprocessor conditions, independent from
780          any purpose of being used in a sampler.
781        </p>
782        <table>
783          <tr>
784            <th>Condition</th> <th>Description</th>
785          </tr>
786          <tr>
787            <td><code>NKSP_NO_MESSAGE</code></td>
788            <td>
789              By default this condition is not set. By explicitly enabling this
790              condition with <code>SET_CONDITION(NKSP_NO_MESSAGE)</code> it
791              causes all subsequent <code>message()</code> calls to be ignored
792              and filtered out on preprocessor level. See function <code>message()</code>
793              for details.
794            </td>
795          </tr>
796        </table>
797    
798    </body>    </body>
799  </html>  </html>
Legend:
Removed from v.3294  
changed lines
  Added in v.3362
  ViewVC Help
Powered by ViewVC