library-mirrors/sfxr.lua
1
0
Fork 0
mirror of https://github.com/nucular/sfxrlua.git synced 2024-12-24 18:44:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Moved and renamed some documentation sections

Browse Source
This commit is contained in:
nucular 2016-06-12 01:13:32 +02:00
parent a222352ea6
commit 67dffe001c
3 changed files with 378 additions and 371 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

296
doc/api/sfxr.html
View File

@ -33,15 +33,15 @@
<li><a href="#Constants">Constants</a></li> <li><a href="#Constants">Constants</a></li>
<li><a href="#Class_Sound">Class Sound </a></li> <li><a href="#Class_Sound">Class Sound </a></li>
<li><a href="#Parameters">Parameters</a></li> <li><a href="#Parameters">Parameters</a></li>
<li><a href="#ParametersEnvelope">ParametersEnvelope</a></li> <li><a href="#Volume">Volume</a></li>
<li><a href="#ParametersFrequency">ParametersFrequency</a></li> <li><a href="#Envelope">Envelope</a></li>
<li><a href="#ParametersVibrato">ParametersVibrato</a></li> <li><a href="#Frequency">Frequency</a></li>
<li><a href="#ParametersChange">ParametersChange</a></li> <li><a href="#Change">Change</a></li>
<li><a href="#ParametersDuty">ParametersDuty</a></li> <li><a href="#Duty">Duty</a></li>
<li><a href="#ParametersPhaser">ParametersPhaser</a></li> <li><a href="#Phaser">Phaser</a></li>
<li><a href="#ParametersLowpass">ParametersLowpass</a></li> <li><a href="#Lowpass">Lowpass</a></li>
<li><a href="#ParametersHighpass">ParametersHighpass</a></li> <li><a href="#Highpass">Highpass</a></li>
<li><a href="#ParametersVolume">ParametersVolume</a></li> <li><a href="#Vibrato">Vibrato</a></li>
<li><a href="#Randomization">Randomization</a></li> <li><a href="#Randomization">Randomization</a></li>
<li><a href="#SavingAndLoading">SavingAndLoading</a></li> <li><a href="#SavingAndLoading">SavingAndLoading</a></li>
</ul> </ul>
@ -101,6 +101,12 @@ together with the <em>awesome</em> <a href="https://love2d.org">LÖVE</a> game f
<tr> <tr>
<td class="name" nowrap><a href="#sfxr.Sound:__init">sfxr.Sound:__init ()</a></td> <td class="name" nowrap><a href="#sfxr.Sound:__init">sfxr.Sound:__init ()</a></td>
<td class="summary">Initialize the Sound instance.</td> <td class="summary">Initialize the Sound instance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.vibrato">self.vibrato</a></td>
<td class="summary"><strong>A <a href="https://en.wikipedia.org/wiki/Vibrato">vibrato</a>-like amplitude
modulation effect</strong>
SerializationVibrato</td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap><a href="#sfxr.Sound:resetParameters">sfxr.Sound:resetParameters ()</a></td> <td class="name" nowrap><a href="#sfxr.Sound:resetParameters">sfxr.Sound:resetParameters ()</a></td>
@ -133,10 +139,6 @@ together with the <em>awesome</em> <a href="https://love2d.org">LÖVE</a> game f
</table> </table>
<h2><a href="#Parameters">Parameters</a></h2> <h2><a href="#Parameters">Parameters</a></h2>
<table class="function_list"> <table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.volume">self.volume</a></td>
<td class="summary"><strong>The sound volume and gain all samples are multiplied with</strong></td>
</tr>
<tr> <tr>
<td class="name" nowrap><a href="#self.supersampling">self.supersampling</a></td> <td class="name" nowrap><a href="#self.supersampling">self.supersampling</a></td>
<td class="summary">Number of supersampling passes to perform (<em>default</em> 8)</td> <td class="summary">Number of supersampling passes to perform (<em>default</em> 8)</td>
@ -152,7 +154,22 @@ together with the <em>awesome</em> <a href="https://love2d.org">LÖVE</a> game f
<td class="summary">The base <a href="../index.html#WAVEFORM">waveform</a> (<em>default</em> <a href="../index.html#WAVEFORM">SQUARE</a>)</td> <td class="summary">The base <a href="../index.html#WAVEFORM">waveform</a> (<em>default</em> <a href="../index.html#WAVEFORM">SQUARE</a>)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersEnvelope">ParametersEnvelope</a></h2> <h2><a href="#Volume">Volume</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.volume">self.volume</a></td>
<td class="summary"><strong>The sound volume and gain all samples are multiplied with</strong></td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.volume.master">self.volume.master</a></td>
<td class="summary">Master volume (<em>default</em> 0.5)</td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.volume.sound">self.volume.sound</a></td>
<td class="summary">Additional gain (<em>default</em> 0.5)</td>
</tr>
</table>
<h2><a href="#Envelope">Envelope</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.envelope">self.envelope</a></td> <td class="name" nowrap><a href="#self.envelope">self.envelope</a></td>
@ -186,7 +203,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersFrequency">ParametersFrequency</a></h2> <h2><a href="#Frequency">Frequency</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.frequency">self.frequency</a></td> <td class="name" nowrap><a href="#self.frequency">self.frequency</a></td>
@ -218,33 +235,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersVibrato">ParametersVibrato</a></h2> <h2><a href="#Change">Change</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.vibrato">self.vibrato</a></td>
<td class="summary"><strong>A <a href="https://en.wikipedia.org/wiki/Vibrato">vibrato</a>-like amplitude
modulation effect</strong></td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.vibrato.depth">self.vibrato.depth</a></td>
<td class="summary">Vibrato depth:
Amount of amplitude modulation
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.vibrato.speed">self.vibrato.speed</a></td>
<td class="summary">Vibrato speed:
Oscillation speed of the vibrato
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.vibrato.delay">self.vibrato.delay</a></td>
<td class="summary">Vibrato delay:
Unused and unimplemented
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#ParametersChange">ParametersChange</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.change">self.change</a></td> <td class="name" nowrap><a href="#self.change">self.change</a></td>
@ -264,7 +255,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersDuty">ParametersDuty</a></h2> <h2><a href="#Duty">Duty</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.duty">self.duty</a></td> <td class="name" nowrap><a href="#self.duty">self.duty</a></td>
@ -284,7 +275,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersPhaser">ParametersPhaser</a></h2> <h2><a href="#Phaser">Phaser</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.phaser">self.phaser</a></td> <td class="name" nowrap><a href="#self.phaser">self.phaser</a></td>
@ -304,7 +295,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersLowpass">ParametersLowpass</a></h2> <h2><a href="#Lowpass">Lowpass</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.lowpass">self.lowpass</a></td> <td class="name" nowrap><a href="#self.lowpass">self.lowpass</a></td>
@ -332,7 +323,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersHighpass">ParametersHighpass</a></h2> <h2><a href="#Highpass">Highpass</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.highpass">self.highpass</a></td> <td class="name" nowrap><a href="#self.highpass">self.highpass</a></td>
@ -353,15 +344,25 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersVolume">ParametersVolume</a></h2> <h2><a href="#Vibrato">Vibrato</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.volume.master">self.volume.master</a></td> <td class="name" nowrap><a href="#self.vibrato.depth">self.vibrato.depth</a></td>
<td class="summary">Master volume (<em>default</em> 0.5)</td> <td class="summary">Vibrato depth:
Amount of amplitude modulation
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap><a href="#self.volume.sound">self.volume.sound</a></td> <td class="name" nowrap><a href="#self.vibrato.speed">self.vibrato.speed</a></td>
<td class="summary">Additional gain (<em>default</em> 0.5)</td> <td class="summary">Vibrato speed:
Oscillation speed of the vibrato
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.vibrato.delay">self.vibrato.delay</a></td>
<td class="summary">Vibrato delay:
Unused and unimplemented
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#Randomization">Randomization</a></h2> <h2><a href="#Randomization">Randomization</a></h2>
@ -605,6 +606,22 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
<dt>
<a name = "self.vibrato"></a>
<strong>self.vibrato</strong>
</dt>
<dd>
<strong>A <a href="https://en.wikipedia.org/wiki/Vibrato">vibrato</a>-like amplitude
modulation effect</strong>
SerializationVibrato
</dd> </dd>
<dt> <dt>
<a name = "sfxr.Sound:resetParameters"></a> <a name = "sfxr.Sound:resetParameters"></a>
@ -837,20 +854,6 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
<h2 class="section-header "><a name="Parameters"></a>Parameters</h2> <h2 class="section-header "><a name="Parameters"></a>Parameters</h2>
<dl class="function"> <dl class="function">
<dt>
<a name = "self.volume"></a>
<strong>self.volume</strong>
</dt>
<dd>
<strong>The sound volume and gain all samples are multiplied with</strong>
</dd>
<dt> <dt>
<a name = "self.supersampling"></a> <a name = "self.supersampling"></a>
<strong>self.supersampling</strong> <strong>self.supersampling</strong>
@ -896,7 +899,53 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersEnvelope"></a>ParametersEnvelope</h2> <h2 class="section-header "><a name="Volume"></a>Volume</h2>
<dl class="function">
<dt>
<a name = "self.volume"></a>
<strong>self.volume</strong>
</dt>
<dd>
<strong>The sound volume and gain all samples are multiplied with</strong>
</dd>
<dt>
<a name = "self.volume.master"></a>
<strong>self.volume.master</strong>
</dt>
<dd>
Master volume (<em>default</em> 0.5)
</dd>
<dt>
<a name = "self.volume.sound"></a>
<strong>self.volume.sound</strong>
</dt>
<dd>
Additional gain (<em>default</em> 0.5)
</dd>
</dl>
<h2 class="section-header "><a name="Envelope"></a>Envelope</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -981,7 +1030,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersFrequency"></a>ParametersFrequency</h2> <h2 class="section-header "><a name="Frequency"></a>Frequency</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1064,74 +1113,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersVibrato"></a>ParametersVibrato</h2> <h2 class="section-header "><a name="Change"></a>Change</h2>
<dl class="function">
<dt>
<a name = "self.vibrato"></a>
<strong>self.vibrato</strong>
</dt>
<dd>
<strong>A <a href="https://en.wikipedia.org/wiki/Vibrato">vibrato</a>-like amplitude
modulation effect</strong>
</dd>
<dt>
<a name = "self.vibrato.depth"></a>
<strong>self.vibrato.depth</strong>
</dt>
<dd>
Vibrato depth:
Amount of amplitude modulation
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
</dd>
<dt>
<a name = "self.vibrato.speed"></a>
<strong>self.vibrato.speed</strong>
</dt>
<dd>
Vibrato speed:
Oscillation speed of the vibrato
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
</dd>
<dt>
<a name = "self.vibrato.delay"></a>
<strong>self.vibrato.delay</strong>
</dt>
<dd>
Vibrato delay:
Unused and unimplemented
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
</dd>
</dl>
<h2 class="section-header "><a name="ParametersChange"></a>ParametersChange</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1182,7 +1164,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersDuty"></a>ParametersDuty</h2> <h2 class="section-header "><a name="Duty"></a>Duty</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1233,7 +1215,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersPhaser"></a>ParametersPhaser</h2> <h2 class="section-header "><a name="Phaser"></a>Phaser</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1284,7 +1266,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersLowpass"></a>ParametersLowpass</h2> <h2 class="section-header "><a name="Lowpass"></a>Lowpass</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1353,7 +1335,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersHighpass"></a>ParametersHighpass</h2> <h2 class="section-header "><a name="Highpass"></a>Highpass</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1405,15 +1387,17 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersVolume"></a>ParametersVolume</h2> <h2 class="section-header "><a name="Vibrato"></a>Vibrato</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
<a name = "self.volume.master"></a> <a name = "self.vibrato.depth"></a>
<strong>self.volume.master</strong> <strong>self.vibrato.depth</strong>
</dt> </dt>
<dd> <dd>
Master volume (<em>default</em> 0.5) Vibrato depth:
Amount of amplitude modulation
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
@ -1423,11 +1407,29 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
<dt> <dt>
<a name = "self.volume.sound"></a> <a name = "self.vibrato.speed"></a>
<strong>self.volume.sound</strong> <strong>self.vibrato.speed</strong>
</dt> </dt>
<dd> <dd>
Additional gain (<em>default</em> 0.5) Vibrato speed:
Oscillation speed of the vibrato
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
</dd>
<dt>
<a name = "self.vibrato.delay"></a>
<strong>self.vibrato.delay</strong>
</dt>
<dd>
Vibrato delay:
Unused and unimplemented
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
@ -1790,7 +1792,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2016-03-05 21:40:35 </i> <i style="float:right;">Last updated 2016-06-12 01:12:38 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

296
doc/index.html
View File

@ -33,15 +33,15 @@
<li><a href="#Constants">Constants</a></li> <li><a href="#Constants">Constants</a></li>
<li><a href="#Class_Sound">Class Sound </a></li> <li><a href="#Class_Sound">Class Sound </a></li>
<li><a href="#Parameters">Parameters</a></li> <li><a href="#Parameters">Parameters</a></li>
<li><a href="#ParametersEnvelope">ParametersEnvelope</a></li> <li><a href="#Volume">Volume</a></li>
<li><a href="#ParametersFrequency">ParametersFrequency</a></li> <li><a href="#Envelope">Envelope</a></li>
<li><a href="#ParametersVibrato">ParametersVibrato</a></li> <li><a href="#Frequency">Frequency</a></li>
<li><a href="#ParametersChange">ParametersChange</a></li> <li><a href="#Change">Change</a></li>
<li><a href="#ParametersDuty">ParametersDuty</a></li> <li><a href="#Duty">Duty</a></li>
<li><a href="#ParametersPhaser">ParametersPhaser</a></li> <li><a href="#Phaser">Phaser</a></li>
<li><a href="#ParametersLowpass">ParametersLowpass</a></li> <li><a href="#Lowpass">Lowpass</a></li>
<li><a href="#ParametersHighpass">ParametersHighpass</a></li> <li><a href="#Highpass">Highpass</a></li>
<li><a href="#ParametersVolume">ParametersVolume</a></li> <li><a href="#Vibrato">Vibrato</a></li>
<li><a href="#Randomization">Randomization</a></li> <li><a href="#Randomization">Randomization</a></li>
<li><a href="#SavingAndLoading">SavingAndLoading</a></li> <li><a href="#SavingAndLoading">SavingAndLoading</a></li>
</ul> </ul>
@ -101,6 +101,12 @@ together with the <em>awesome</em> <a href="https://love2d.org">LÖVE</a> game f
<tr> <tr>
<td class="name" nowrap><a href="#sfxr.Sound:__init">sfxr.Sound:__init ()</a></td> <td class="name" nowrap><a href="#sfxr.Sound:__init">sfxr.Sound:__init ()</a></td>
<td class="summary">Initialize the Sound instance.</td> <td class="summary">Initialize the Sound instance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.vibrato">self.vibrato</a></td>
<td class="summary"><strong>A <a href="https://en.wikipedia.org/wiki/Vibrato">vibrato</a>-like amplitude
modulation effect</strong>
SerializationVibrato</td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap><a href="#sfxr.Sound:resetParameters">sfxr.Sound:resetParameters ()</a></td> <td class="name" nowrap><a href="#sfxr.Sound:resetParameters">sfxr.Sound:resetParameters ()</a></td>
@ -133,10 +139,6 @@ together with the <em>awesome</em> <a href="https://love2d.org">LÖVE</a> game f
</table> </table>
<h2><a href="#Parameters">Parameters</a></h2> <h2><a href="#Parameters">Parameters</a></h2>
<table class="function_list"> <table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.volume">self.volume</a></td>
<td class="summary"><strong>The sound volume and gain all samples are multiplied with</strong></td>
</tr>
<tr> <tr>
<td class="name" nowrap><a href="#self.supersampling">self.supersampling</a></td> <td class="name" nowrap><a href="#self.supersampling">self.supersampling</a></td>
<td class="summary">Number of supersampling passes to perform (<em>default</em> 8)</td> <td class="summary">Number of supersampling passes to perform (<em>default</em> 8)</td>
@ -152,7 +154,22 @@ together with the <em>awesome</em> <a href="https://love2d.org">LÖVE</a> game f
<td class="summary">The base <a href="index.html#WAVEFORM">waveform</a> (<em>default</em> <a href="index.html#WAVEFORM">SQUARE</a>)</td> <td class="summary">The base <a href="index.html#WAVEFORM">waveform</a> (<em>default</em> <a href="index.html#WAVEFORM">SQUARE</a>)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersEnvelope">ParametersEnvelope</a></h2> <h2><a href="#Volume">Volume</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.volume">self.volume</a></td>
<td class="summary"><strong>The sound volume and gain all samples are multiplied with</strong></td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.volume.master">self.volume.master</a></td>
<td class="summary">Master volume (<em>default</em> 0.5)</td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.volume.sound">self.volume.sound</a></td>
<td class="summary">Additional gain (<em>default</em> 0.5)</td>
</tr>
</table>
<h2><a href="#Envelope">Envelope</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.envelope">self.envelope</a></td> <td class="name" nowrap><a href="#self.envelope">self.envelope</a></td>
@ -186,7 +203,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersFrequency">ParametersFrequency</a></h2> <h2><a href="#Frequency">Frequency</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.frequency">self.frequency</a></td> <td class="name" nowrap><a href="#self.frequency">self.frequency</a></td>
@ -218,33 +235,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersVibrato">ParametersVibrato</a></h2> <h2><a href="#Change">Change</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.vibrato">self.vibrato</a></td>
<td class="summary"><strong>A <a href="https://en.wikipedia.org/wiki/Vibrato">vibrato</a>-like amplitude
modulation effect</strong></td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.vibrato.depth">self.vibrato.depth</a></td>
<td class="summary">Vibrato depth:
Amount of amplitude modulation
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.vibrato.speed">self.vibrato.speed</a></td>
<td class="summary">Vibrato speed:
Oscillation speed of the vibrato
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.vibrato.delay">self.vibrato.delay</a></td>
<td class="summary">Vibrato delay:
Unused and unimplemented
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#ParametersChange">ParametersChange</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.change">self.change</a></td> <td class="name" nowrap><a href="#self.change">self.change</a></td>
@ -264,7 +255,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersDuty">ParametersDuty</a></h2> <h2><a href="#Duty">Duty</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.duty">self.duty</a></td> <td class="name" nowrap><a href="#self.duty">self.duty</a></td>
@ -284,7 +275,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersPhaser">ParametersPhaser</a></h2> <h2><a href="#Phaser">Phaser</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.phaser">self.phaser</a></td> <td class="name" nowrap><a href="#self.phaser">self.phaser</a></td>
@ -304,7 +295,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersLowpass">ParametersLowpass</a></h2> <h2><a href="#Lowpass">Lowpass</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.lowpass">self.lowpass</a></td> <td class="name" nowrap><a href="#self.lowpass">self.lowpass</a></td>
@ -332,7 +323,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersHighpass">ParametersHighpass</a></h2> <h2><a href="#Highpass">Highpass</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.highpass">self.highpass</a></td> <td class="name" nowrap><a href="#self.highpass">self.highpass</a></td>
@ -353,15 +344,25 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td> (<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#ParametersVolume">ParametersVolume</a></h2> <h2><a href="#Vibrato">Vibrato</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#self.volume.master">self.volume.master</a></td> <td class="name" nowrap><a href="#self.vibrato.depth">self.vibrato.depth</a></td>
<td class="summary">Master volume (<em>default</em> 0.5)</td> <td class="summary">Vibrato depth:
Amount of amplitude modulation
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap><a href="#self.volume.sound">self.volume.sound</a></td> <td class="name" nowrap><a href="#self.vibrato.speed">self.vibrato.speed</a></td>
<td class="summary">Additional gain (<em>default</em> 0.5)</td> <td class="summary">Vibrato speed:
Oscillation speed of the vibrato
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
<tr>
<td class="name" nowrap><a href="#self.vibrato.delay">self.vibrato.delay</a></td>
<td class="summary">Vibrato delay:
Unused and unimplemented
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr> </tr>
</table> </table>
<h2><a href="#Randomization">Randomization</a></h2> <h2><a href="#Randomization">Randomization</a></h2>
@ -605,6 +606,22 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
<dt>
<a name = "self.vibrato"></a>
<strong>self.vibrato</strong>
</dt>
<dd>
<strong>A <a href="https://en.wikipedia.org/wiki/Vibrato">vibrato</a>-like amplitude
modulation effect</strong>
SerializationVibrato
</dd> </dd>
<dt> <dt>
<a name = "sfxr.Sound:resetParameters"></a> <a name = "sfxr.Sound:resetParameters"></a>
@ -837,20 +854,6 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
<h2 class="section-header "><a name="Parameters"></a>Parameters</h2> <h2 class="section-header "><a name="Parameters"></a>Parameters</h2>
<dl class="function"> <dl class="function">
<dt>
<a name = "self.volume"></a>
<strong>self.volume</strong>
</dt>
<dd>
<strong>The sound volume and gain all samples are multiplied with</strong>
</dd>
<dt> <dt>
<a name = "self.supersampling"></a> <a name = "self.supersampling"></a>
<strong>self.supersampling</strong> <strong>self.supersampling</strong>
@ -896,7 +899,53 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersEnvelope"></a>ParametersEnvelope</h2> <h2 class="section-header "><a name="Volume"></a>Volume</h2>
<dl class="function">
<dt>
<a name = "self.volume"></a>
<strong>self.volume</strong>
</dt>
<dd>
<strong>The sound volume and gain all samples are multiplied with</strong>
</dd>
<dt>
<a name = "self.volume.master"></a>
<strong>self.volume.master</strong>
</dt>
<dd>
Master volume (<em>default</em> 0.5)
</dd>
<dt>
<a name = "self.volume.sound"></a>
<strong>self.volume.sound</strong>
</dt>
<dd>
Additional gain (<em>default</em> 0.5)
</dd>
</dl>
<h2 class="section-header "><a name="Envelope"></a>Envelope</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -981,7 +1030,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersFrequency"></a>ParametersFrequency</h2> <h2 class="section-header "><a name="Frequency"></a>Frequency</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1064,74 +1113,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersVibrato"></a>ParametersVibrato</h2> <h2 class="section-header "><a name="Change"></a>Change</h2>
<dl class="function">
<dt>
<a name = "self.vibrato"></a>
<strong>self.vibrato</strong>
</dt>
<dd>
<strong>A <a href="https://en.wikipedia.org/wiki/Vibrato">vibrato</a>-like amplitude
modulation effect</strong>
</dd>
<dt>
<a name = "self.vibrato.depth"></a>
<strong>self.vibrato.depth</strong>
</dt>
<dd>
Vibrato depth:
Amount of amplitude modulation
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
</dd>
<dt>
<a name = "self.vibrato.speed"></a>
<strong>self.vibrato.speed</strong>
</dt>
<dd>
Vibrato speed:
Oscillation speed of the vibrato
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
</dd>
<dt>
<a name = "self.vibrato.delay"></a>
<strong>self.vibrato.delay</strong>
</dt>
<dd>
Vibrato delay:
Unused and unimplemented
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
</dd>
</dl>
<h2 class="section-header "><a name="ParametersChange"></a>ParametersChange</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1182,7 +1164,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersDuty"></a>ParametersDuty</h2> <h2 class="section-header "><a name="Duty"></a>Duty</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1233,7 +1215,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersPhaser"></a>ParametersPhaser</h2> <h2 class="section-header "><a name="Phaser"></a>Phaser</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1284,7 +1266,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersLowpass"></a>ParametersLowpass</h2> <h2 class="section-header "><a name="Lowpass"></a>Lowpass</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1353,7 +1335,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersHighpass"></a>ParametersHighpass</h2> <h2 class="section-header "><a name="Highpass"></a>Highpass</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1405,15 +1387,17 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="ParametersVolume"></a>ParametersVolume</h2> <h2 class="section-header "><a name="Vibrato"></a>Vibrato</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
<a name = "self.volume.master"></a> <a name = "self.vibrato.depth"></a>
<strong>self.volume.master</strong> <strong>self.vibrato.depth</strong>
</dt> </dt>
<dd> <dd>
Master volume (<em>default</em> 0.5) Vibrato depth:
Amount of amplitude modulation
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
@ -1423,11 +1407,29 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
<dt> <dt>
<a name = "self.volume.sound"></a> <a name = "self.vibrato.speed"></a>
<strong>self.volume.sound</strong> <strong>self.vibrato.speed</strong>
</dt> </dt>
<dd> <dd>
Additional gain (<em>default</em> 0.5) Vibrato speed:
Oscillation speed of the vibrato
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
</dd>
<dt>
<a name = "self.vibrato.delay"></a>
<strong>self.vibrato.delay</strong>
</dt>
<dd>
Vibrato delay:
Unused and unimplemented
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
@ -1790,7 +1792,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2016-03-05 21:40:35 </i> <i style="float:right;">Last updated 2016-06-12 01:12:38 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

157
sfxr.lua
View File

@ -249,64 +249,9 @@ sfxr.Sound.__index = sfxr.Sound
--- Initialize the Sound instance. --- Initialize the Sound instance.
-- Called by @{sfxr.newSound|the constructor}. -- Called by @{sfxr.newSound|the constructor}.
function sfxr.Sound:__init() function sfxr.Sound:__init()
-- Build tables to store the parameters in
--- **The sound volume and gain all samples are multiplied with**
-- @within Parameters
self.volume = {}
--- **The [ASD envelope](https://en.wikipedia.org/wiki/Synthesizer#Attack_
--Decay_Sustain_Release_.28ADSR.29_envelope) that controls the sound
-- amplitude (volume) over time**
-- @within ParametersEnvelope
self.envelope = {}
--- **The base and minimum frequencies of the tone generator and their
-- slides**
-- @within ParametersFrequency
self.frequency = {}
--- **A [vibrato](https://en.wikipedia.org/wiki/Vibrato)-like amplitude
-- modulation effect**
-- @within ParametersVibrato
self.vibrato = {}
--- **Changes the frequency mid-sound to create a characteristic
-- "coin"-effect**
-- @within ParametersChange
self.change = {}
--- **The [duty](https://en.wikipedia.org/wiki/Duty_cycle) of the square
-- waveform**
-- @within ParametersDuty
self.duty = {}
--- **A simple [phaser](https://en.wikipedia.org/wiki/Phaser_(effect))
-- effect**
-- @within ParametersPhaser
self.phaser = {}
--- **A [lowpass filter](https://en.wikipedia.org/wiki/Low-pass_filter)
-- effect**
-- @within ParametersLowpass
self.lowpass = {}
--- **A [highpass filter](https://en.wikipedia.org/wiki/High-pass_filter)
-- effect**
-- @within ParametersHighpass
self.highpass = {}
-- These are not affected by resetParameters()
--- Number of supersampling passes to perform (*default* 8) --- Number of supersampling passes to perform (*default* 8)
-- @within Parameters -- @within Parameters
self.supersampling = 8 self.supersampling = 8
--- Master volume (*default* 0.5)
-- @within ParametersVolume
self.volume.master = 0.5
--- Additional gain (*default* 0.5)
-- @within ParametersVolume
self.volume.sound = 0.5
self:resetParameters()
end
--- Set all parameters to their default values. Does not affect
-- @{self.supersampling|supersampling} and @{self.volume|volume}.
-- Called by @{sfxr.Sound:__init|the initializer}.
function sfxr.Sound:resetParameters()
--- Repeat speed: --- Repeat speed:
-- Times to repeat the frequency slide over the course of the envelope -- Times to repeat the frequency slide over the course of the envelope
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
@ -316,125 +261,183 @@ function sfxr.Sound:resetParameters()
-- @within Parameters -- @within Parameters
self.waveform = sfxr.WAVEFORM.SQUARE self.waveform = sfxr.WAVEFORM.SQUARE
-- Build tables to store the parameters in
--- **The sound volume and gain all samples are multiplied with**
-- @within Volume
self.volume = {}
--- **The [ASD envelope](https://en.wikipedia.org/wiki/Synthesizer#Attack_
--Decay_Sustain_Release_.28ADSR.29_envelope) that controls the sound
-- amplitude (volume) over time**
-- @within Envelope
self.envelope = {}
--- **The base and minimum frequencies of the tone generator and their
-- slides**
-- @within Frequency
self.frequency = {}
--- **A [vibrato](https://en.wikipedia.org/wiki/Vibrato)-like amplitude
-- modulation effect**
-- SerializationVibrato
self.vibrato = {}
--- **Changes the frequency mid-sound to create a characteristic
-- "coin"-effect**
-- @within Change
self.change = {}
--- **The [duty](https://en.wikipedia.org/wiki/Duty_cycle) of the square
-- waveform**
-- @within Duty
self.duty = {}
--- **A simple [phaser](https://en.wikipedia.org/wiki/Phaser_(effect))
-- effect**
-- @within Phaser
self.phaser = {}
--- **A [lowpass filter](https://en.wikipedia.org/wiki/Low-pass_filter)
-- effect**
-- @within Lowpass
self.lowpass = {}
--- **A [highpass filter](https://en.wikipedia.org/wiki/High-pass_filter)
-- effect**
-- @within Highpass
self.highpass = {}
-- These are not affected by resetParameters()
--- Master volume (*default* 0.5)
-- @within Volume
self.volume.master = 0.5
--- Additional gain (*default* 0.5)
-- @within Volume
self.volume.sound = 0.5
self:resetParameters()
end
--- Set all parameters to their default values. Does not affect
-- @{self.supersampling|supersampling} and @{self.volume|volume}.
-- Called by @{sfxr.Sound:__init|the initializer}.
function sfxr.Sound:resetParameters()
self.repeatspeed = 0.0
self.waveform = sfxr.WAVEFORM.SQUARE
--- Attack time: --- Attack time:
-- Time the sound takes to reach its peak amplitude -- Time the sound takes to reach its peak amplitude
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersEnvelope -- @within Envelope
self.envelope.attack = 0.0 self.envelope.attack = 0.0
--- Sustain time: --- Sustain time:
-- Time the sound stays on its peak amplitude -- Time the sound stays on its peak amplitude
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersEnvelope -- @within Envelope
self.envelope.sustain = 0.3 self.envelope.sustain = 0.3
--- Sustain punch: --- Sustain punch:
-- Amount by which the sound peak amplitude is increased at the start of the -- Amount by which the sound peak amplitude is increased at the start of the
-- sustain time -- sustain time
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersEnvelope -- @within Envelope
self.envelope.punch = 0.0 self.envelope.punch = 0.0
--- Decay time: --- Decay time:
-- Time the sound takes to decay after its sustain time -- Time the sound takes to decay after its sustain time
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersEnvelope -- @within Envelope
self.envelope.decay = 0.4 self.envelope.decay = 0.4
--- Start frequency: --- Start frequency:
-- Base tone of the sound, before sliding -- Base tone of the sound, before sliding
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersFrequency -- @within Frequency
self.frequency.start = 0.3 self.frequency.start = 0.3
--- Min frequency: --- Min frequency:
-- Tone below which the sound will get cut off -- Tone below which the sound will get cut off
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersFrequency -- @within Frequency
self.frequency.min = 0.0 self.frequency.min = 0.0
--- Slide: --- Slide:
-- Amount by which the frequency is increased or decreased over time -- Amount by which the frequency is increased or decreased over time
-- (*default* 0.0, *min* -1.0, *max* 1.0) -- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within ParametersFrequency -- @within Frequency
self.frequency.slide = 0.0 self.frequency.slide = 0.0
--- Delta slide: --- Delta slide:
-- Amount by which the slide is increased or decreased over time -- Amount by which the slide is increased or decreased over time
-- (*default* 0.0, *min* -1.0, *max* 1.0) -- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within ParametersFrequency -- @within Frequency
self.frequency.dslide = 0.0 self.frequency.dslide = 0.0
--- Vibrato depth: --- Vibrato depth:
-- Amount of amplitude modulation -- Amount of amplitude modulation
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersVibrato -- @within Vibrato
self.vibrato.depth = 0.0 self.vibrato.depth = 0.0
--- Vibrato speed: --- Vibrato speed:
-- Oscillation speed of the vibrato -- Oscillation speed of the vibrato
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersVibrato -- @within Vibrato
self.vibrato.speed = 0.0 self.vibrato.speed = 0.0
--- Vibrato delay: --- Vibrato delay:
-- Unused and unimplemented -- Unused and unimplemented
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersVibrato -- @within Vibrato
self.vibrato.delay = 0.0 self.vibrato.delay = 0.0
--- Change amount: --- Change amount:
-- Amount by which the frequency is changed mid-sound -- Amount by which the frequency is changed mid-sound
-- (*default* 0.0, *min* -1.0, *max* 1.0) -- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within ParametersChange -- @within Change
self.change.amount = 0.0 self.change.amount = 0.0
--- Change speed: --- Change speed:
-- Time before the frequency change happens -- Time before the frequency change happens
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersChange -- @within Change
self.change.speed = 0.0 self.change.speed = 0.0
--- Square duty: --- Square duty:
-- Width of the square wave pulse cycle (doesn't affect other waveforms) -- Width of the square wave pulse cycle (doesn't affect other waveforms)
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersDuty -- @within Duty
self.duty.ratio = 0.0 self.duty.ratio = 0.0
--- Duty sweep: --- Duty sweep:
-- Amount by which the square duty is increased or decreased over time -- Amount by which the square duty is increased or decreased over time
-- (*default* 0.0, *min* -1.0, *max* 1.0) -- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within ParametersDuty -- @within Duty
self.duty.sweep = 0.0 self.duty.sweep = 0.0
--- Phaser offset: --- Phaser offset:
-- Amount by which the phaser signal is offset from the sound -- Amount by which the phaser signal is offset from the sound
-- (*default* 0.0, *min* -1.0, *max* 1.0) -- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within ParametersPhaser -- @within Phaser
self.phaser.offset = 0.0 self.phaser.offset = 0.0
--- Phaser sweep: --- Phaser sweep:
-- Amount by which the phaser offset is increased or decreased over time -- Amount by which the phaser offset is increased or decreased over time
-- (*default* 0.0, *min* -1.0, *max* 1.0) -- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within ParametersPhaser -- @within Phaser
self.phaser.sweep = 0.0 self.phaser.sweep = 0.0
--- Lowpass filter cutoff: --- Lowpass filter cutoff:
-- Lower bound for frequencies allowed to pass through this filter -- Lower bound for frequencies allowed to pass through this filter
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersLowpass -- @within Lowpass
self.lowpass.cutoff = 1.0 self.lowpass.cutoff = 1.0
--- Lowpass filter cutoff sweep: --- Lowpass filter cutoff sweep:
-- Amount by which the LP filter cutoff is increased or decreased -- Amount by which the LP filter cutoff is increased or decreased
-- over time -- over time
-- (*default* 0.0, *min* -1.0, *max* 1.0) -- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within ParametersLowpass -- @within Lowpass
self.lowpass.sweep = 0.0 self.lowpass.sweep = 0.0
--- Lowpass filter resonance: --- Lowpass filter resonance:
-- Amount by which certain resonant frequencies near the cutoff are -- Amount by which certain resonant frequencies near the cutoff are
-- increased -- increased
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersLowpass -- @within Lowpass
self.lowpass.resonance = 0.0 self.lowpass.resonance = 0.0
--- Highpass filter cutoff: --- Highpass filter cutoff:
-- Upper bound for frequencies allowed to pass through this filter -- Upper bound for frequencies allowed to pass through this filter
-- (*default* 0.0, *min* 0.0, *max* 1.0) -- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within ParametersHighpass -- @within Highpass
self.highpass.cutoff = 0.0 self.highpass.cutoff = 0.0
--- Highpass filter cutoff sweep: --- Highpass filter cutoff sweep:
-- Amount by which the HP filter cutoff is increased or decreased -- Amount by which the HP filter cutoff is increased or decreased
-- over time -- over time
-- (*default* 0.0, *min* -1.0, *max* 1.0) -- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within ParametersHighpass -- @within Highpass
self.highpass.sweep = 0.0 self.highpass.sweep = 0.0
end end