From 67dffe001cca93d89eded0b3de2fe83a910a5581 Mon Sep 17 00:00:00 2001 From: nucular Date: Sun, 12 Jun 2016 01:13:32 +0200 Subject: [PATCH] Moved and renamed some documentation sections --- doc/api/sfxr.html | 296 +++++++++++++++++++++++----------------------- doc/index.html | 296 +++++++++++++++++++++++----------------------- sfxr.lua | 157 ++++++++++++------------ 3 files changed, 378 insertions(+), 371 deletions(-) diff --git a/doc/api/sfxr.html b/doc/api/sfxr.html index cd03fc2..f76ddb5 100644 --- a/doc/api/sfxr.html +++ b/doc/api/sfxr.html @@ -33,15 +33,15 @@
  • Constants
  • Class Sound
  • Parameters
    • -
  • ParametersEnvelope
    • -
  • ParametersFrequency
    • -
  • ParametersVibrato
    • -
  • ParametersChange
    • -
  • ParametersDuty
    • -
  • ParametersPhaser
    • -
  • ParametersLowpass
    • -
  • ParametersHighpass
    • -
  • ParametersVolume
    • +
  • Volume
    • +
  • Envelope
    • +
  • Frequency
    • +
  • Change
    • +
  • Duty
    • +
  • Phaser
    • +
  • Lowpass
    • +
  • Highpass
    • +
  • Vibrato
  • Randomization
  • SavingAndLoading
    • @@ -101,6 +101,12 @@ together with the awesome LÖVE game f sfxr.Sound:__init () Initialize the Sound instance. + + + self.vibrato + A vibrato-like amplitude + modulation effect + SerializationVibrato sfxr.Sound:resetParameters () @@ -133,10 +139,6 @@ together with the awesome LÖVE game f

    Parameters

    - - - - @@ -152,7 +154,22 @@ together with the awesomeLÖVE game f
    self.volumeThe sound volume and gain all samples are multiplied with
    self.supersampling Number of supersampling passes to perform (default 8) The base waveform (default SQUARE)
    -

    ParametersEnvelope

    +

    Volume

    + + + + + + + + + + + + + +
    self.volumeThe sound volume and gain all samples are multiplied with
    self.volume.masterMaster volume (default 0.5)
    self.volume.soundAdditional gain (default 0.5)
    +

    Envelope

    @@ -186,7 +203,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min 0.0, max 1.0)
    self.envelope
    -

    ParametersFrequency

    +

    Frequency

    @@ -218,33 +235,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min -1.0, max 1.0)
    self.frequency
    -

    ParametersVibrato

    - - - - - - - - - - - - - - - - - -
    self.vibratoA vibrato-like amplitude - modulation effect
    self.vibrato.depthVibrato depth: - Amount of amplitude modulation - (default 0.0, min 0.0, max 1.0)
    self.vibrato.speedVibrato speed: - Oscillation speed of the vibrato - (default 0.0, min 0.0, max 1.0)
    self.vibrato.delayVibrato delay: - Unused and unimplemented - (default 0.0, min 0.0, max 1.0)
    -

    ParametersChange

    +

    Change

    @@ -264,7 +255,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min 0.0, max 1.0)
    self.change
    -

    ParametersDuty

    +

    Duty

    @@ -284,7 +275,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min -1.0, max 1.0)
    self.duty
    -

    ParametersPhaser

    +

    Phaser

    @@ -304,7 +295,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min -1.0, max 1.0)
    self.phaser
    -

    ParametersLowpass

    +

    Lowpass

    @@ -332,7 +323,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min 0.0, max 1.0)
    self.lowpass
    -

    ParametersHighpass

    +

    Highpass

    @@ -353,15 +344,25 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min -1.0, max 1.0)
    self.highpass
    -

    ParametersVolume

    +

    Vibrato

    - - + + - - + + + + + +
    self.volume.masterMaster volume (default 0.5)self.vibrato.depthVibrato depth: + Amount of amplitude modulation + (default 0.0, min 0.0, max 1.0)
    self.volume.soundAdditional gain (default 0.5)self.vibrato.speedVibrato speed: + Oscillation speed of the vibrato + (default 0.0, min 0.0, max 1.0)
    self.vibrato.delayVibrato delay: + Unused and unimplemented + (default 0.0, min 0.0, max 1.0)

    Randomization

    @@ -605,6 +606,22 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so + +
    + + self.vibrato +
    +
    + A vibrato-like amplitude + modulation effect + SerializationVibrato + + + + + + +
    @@ -837,20 +854,6 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so

    Parameters

    -
    - - self.volume -
    -
    - The sound volume and gain all samples are multiplied with - - - - - - - -
    self.supersampling @@ -896,7 +899,53 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersEnvelope

    +

    Volume

    + +
    +
    + + self.volume +
    +
    + The sound volume and gain all samples are multiplied with + + + + + + + +
    +
    + + self.volume.master +
    +
    + Master volume (default 0.5) + + + + + + + +
    +
    + + self.volume.sound +
    +
    + Additional gain (default 0.5) + + + + + + + +
    +
    +

    Envelope

    @@ -981,7 +1030,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersFrequency

    +

    Frequency

    @@ -1064,74 +1113,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersVibrato

    - -
    -
    - - self.vibrato -
    -
    - A vibrato-like amplitude - modulation effect - - - - - - - -
    -
    - - self.vibrato.depth -
    -
    - Vibrato depth: - Amount of amplitude modulation - (default 0.0, min 0.0, max 1.0) - - - - - - - -
    -
    - - self.vibrato.speed -
    -
    - Vibrato speed: - Oscillation speed of the vibrato - (default 0.0, min 0.0, max 1.0) - - - - - - - -
    -
    - - self.vibrato.delay -
    -
    - Vibrato delay: - Unused and unimplemented - (default 0.0, min 0.0, max 1.0) - - - - - - - -
    -
    -

    ParametersChange

    +

    Change

    @@ -1182,7 +1164,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersDuty

    +

    Duty

    @@ -1233,7 +1215,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersPhaser

    +

    Phaser

    @@ -1284,7 +1266,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersLowpass

    +

    Lowpass

    @@ -1353,7 +1335,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersHighpass

    +

    Highpass

    @@ -1405,15 +1387,17 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersVolume

    +

    Vibrato

    - - self.volume.master + + self.vibrato.depth
    - Master volume (default 0.5) + Vibrato depth: + Amount of amplitude modulation + (default 0.0, min 0.0, max 1.0) @@ -1423,11 +1407,29 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    - - self.volume.sound + + self.vibrato.speed
    - Additional gain (default 0.5) + Vibrato speed: + Oscillation speed of the vibrato + (default 0.0, min 0.0, max 1.0) + + + + + + + +
    +
    + + self.vibrato.delay +
    +
    + Vibrato delay: + Unused and unimplemented + (default 0.0, min 0.0, max 1.0) @@ -1790,7 +1792,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    generated by LDoc 1.4.3 -Last updated 2016-03-05 21:40:35 +Last updated 2016-06-12 01:12:38
    diff --git a/doc/index.html b/doc/index.html index 8bd98e1..6f7e81a 100644 --- a/doc/index.html +++ b/doc/index.html @@ -33,15 +33,15 @@
  • Constants
  • Class Sound
  • Parameters
    • -
  • ParametersEnvelope
    • -
  • ParametersFrequency
    • -
  • ParametersVibrato
    • -
  • ParametersChange
    • -
  • ParametersDuty
    • -
  • ParametersPhaser
    • -
  • ParametersLowpass
    • -
  • ParametersHighpass
    • -
  • ParametersVolume
    • +
  • Volume
    • +
  • Envelope
    • +
  • Frequency
    • +
  • Change
    • +
  • Duty
    • +
  • Phaser
    • +
  • Lowpass
    • +
  • Highpass
    • +
  • Vibrato
  • Randomization
  • SavingAndLoading
    • @@ -101,6 +101,12 @@ together with the awesome LÖVE game f sfxr.Sound:__init () Initialize the Sound instance. + + + self.vibrato + A vibrato-like amplitude + modulation effect + SerializationVibrato sfxr.Sound:resetParameters () @@ -133,10 +139,6 @@ together with the awesome LÖVE game f

    Parameters

    - - - - @@ -152,7 +154,22 @@ together with the awesomeLÖVE game f
    self.volumeThe sound volume and gain all samples are multiplied with
    self.supersampling Number of supersampling passes to perform (default 8) The base waveform (default SQUARE)
    -

    ParametersEnvelope

    +

    Volume

    + + + + + + + + + + + + + +
    self.volumeThe sound volume and gain all samples are multiplied with
    self.volume.masterMaster volume (default 0.5)
    self.volume.soundAdditional gain (default 0.5)
    +

    Envelope

    @@ -186,7 +203,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min 0.0, max 1.0)
    self.envelope
    -

    ParametersFrequency

    +

    Frequency

    @@ -218,33 +235,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min -1.0, max 1.0)
    self.frequency
    -

    ParametersVibrato

    - - - - - - - - - - - - - - - - - -
    self.vibratoA vibrato-like amplitude - modulation effect
    self.vibrato.depthVibrato depth: - Amount of amplitude modulation - (default 0.0, min 0.0, max 1.0)
    self.vibrato.speedVibrato speed: - Oscillation speed of the vibrato - (default 0.0, min 0.0, max 1.0)
    self.vibrato.delayVibrato delay: - Unused and unimplemented - (default 0.0, min 0.0, max 1.0)
    -

    ParametersChange

    +

    Change

    @@ -264,7 +255,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min 0.0, max 1.0)
    self.change
    -

    ParametersDuty

    +

    Duty

    @@ -284,7 +275,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min -1.0, max 1.0)
    self.duty
    -

    ParametersPhaser

    +

    Phaser

    @@ -304,7 +295,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min -1.0, max 1.0)
    self.phaser
    -

    ParametersLowpass

    +

    Lowpass

    @@ -332,7 +323,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min 0.0, max 1.0)
    self.lowpass
    -

    ParametersHighpass

    +

    Highpass

    @@ -353,15 +344,25 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so (default 0.0, min -1.0, max 1.0)
    self.highpass
    -

    ParametersVolume

    +

    Vibrato

    - - + + - - + + + + + +
    self.volume.masterMaster volume (default 0.5)self.vibrato.depthVibrato depth: + Amount of amplitude modulation + (default 0.0, min 0.0, max 1.0)
    self.volume.soundAdditional gain (default 0.5)self.vibrato.speedVibrato speed: + Oscillation speed of the vibrato + (default 0.0, min 0.0, max 1.0)
    self.vibrato.delayVibrato delay: + Unused and unimplemented + (default 0.0, min 0.0, max 1.0)

    Randomization

    @@ -605,6 +606,22 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so +
    +
    + + self.vibrato +
    +
    + A vibrato-like amplitude + modulation effect + SerializationVibrato + + + + + + +
    @@ -837,20 +854,6 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so

    Parameters

    -
    - - self.volume -
    -
    - The sound volume and gain all samples are multiplied with - - - - - - - -
    self.supersampling @@ -896,7 +899,53 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersEnvelope

    +

    Volume

    + +
    +
    + + self.volume +
    +
    + The sound volume and gain all samples are multiplied with + + + + + + + +
    +
    + + self.volume.master +
    +
    + Master volume (default 0.5) + + + + + + + +
    +
    + + self.volume.sound +
    +
    + Additional gain (default 0.5) + + + + + + + +
    +
    +

    Envelope

    @@ -981,7 +1030,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersFrequency

    +

    Frequency

    @@ -1064,74 +1113,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersVibrato

    - -
    -
    - - self.vibrato -
    -
    - A vibrato-like amplitude - modulation effect - - - - - - - -
    -
    - - self.vibrato.depth -
    -
    - Vibrato depth: - Amount of amplitude modulation - (default 0.0, min 0.0, max 1.0) - - - - - - - -
    -
    - - self.vibrato.speed -
    -
    - Vibrato speed: - Oscillation speed of the vibrato - (default 0.0, min 0.0, max 1.0) - - - - - - - -
    -
    - - self.vibrato.delay -
    -
    - Vibrato delay: - Unused and unimplemented - (default 0.0, min 0.0, max 1.0) - - - - - - - -
    -
    -

    ParametersChange

    +

    Change

    @@ -1182,7 +1164,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersDuty

    +

    Duty

    @@ -1233,7 +1215,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersPhaser

    +

    Phaser

    @@ -1284,7 +1266,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersLowpass

    +

    Lowpass

    @@ -1353,7 +1335,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersHighpass

    +

    Highpass

    @@ -1405,15 +1387,17 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    -

    ParametersVolume

    +

    Vibrato

    - - self.volume.master + + self.vibrato.depth
    - Master volume (default 0.5) + Vibrato depth: + Amount of amplitude modulation + (default 0.0, min 0.0, max 1.0) @@ -1423,11 +1407,29 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    - - self.volume.sound + + self.vibrato.speed
    - Additional gain (default 0.5) + Vibrato speed: + Oscillation speed of the vibrato + (default 0.0, min 0.0, max 1.0) + + + + + + + +
    +
    + + self.vibrato.delay +
    +
    + Vibrato delay: + Unused and unimplemented + (default 0.0, min 0.0, max 1.0) @@ -1790,7 +1792,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
    generated by LDoc 1.4.3 -Last updated 2016-03-05 21:40:35 +Last updated 2016-06-12 01:12:38
    diff --git a/sfxr.lua b/sfxr.lua index 9b90206..6bda8a2 100644 --- a/sfxr.lua +++ b/sfxr.lua @@ -249,64 +249,9 @@ sfxr.Sound.__index = sfxr.Sound --- Initialize the Sound instance. -- Called by @{sfxr.newSound|the constructor}. 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) -- @within Parameters 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: -- Times to repeat the frequency slide over the course of the envelope -- (*default* 0.0, *min* 0.0, *max* 1.0) @@ -316,125 +261,183 @@ function sfxr.Sound:resetParameters() -- @within Parameters 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: -- Time the sound takes to reach its peak amplitude -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersEnvelope + -- @within Envelope self.envelope.attack = 0.0 --- Sustain time: -- Time the sound stays on its peak amplitude -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersEnvelope + -- @within Envelope self.envelope.sustain = 0.3 --- Sustain punch: -- Amount by which the sound peak amplitude is increased at the start of the -- sustain time -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersEnvelope + -- @within Envelope self.envelope.punch = 0.0 --- Decay time: -- Time the sound takes to decay after its sustain time -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersEnvelope + -- @within Envelope self.envelope.decay = 0.4 --- Start frequency: -- Base tone of the sound, before sliding -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersFrequency + -- @within Frequency self.frequency.start = 0.3 --- Min frequency: -- Tone below which the sound will get cut off -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersFrequency + -- @within Frequency self.frequency.min = 0.0 --- Slide: -- Amount by which the frequency is increased or decreased over time -- (*default* 0.0, *min* -1.0, *max* 1.0) - -- @within ParametersFrequency + -- @within Frequency self.frequency.slide = 0.0 --- Delta slide: -- Amount by which the slide is increased or decreased over time -- (*default* 0.0, *min* -1.0, *max* 1.0) - -- @within ParametersFrequency + -- @within Frequency self.frequency.dslide = 0.0 --- Vibrato depth: -- Amount of amplitude modulation -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersVibrato + -- @within Vibrato self.vibrato.depth = 0.0 --- Vibrato speed: -- Oscillation speed of the vibrato -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersVibrato + -- @within Vibrato self.vibrato.speed = 0.0 --- Vibrato delay: -- Unused and unimplemented -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersVibrato + -- @within Vibrato self.vibrato.delay = 0.0 --- Change amount: -- Amount by which the frequency is changed mid-sound -- (*default* 0.0, *min* -1.0, *max* 1.0) - -- @within ParametersChange + -- @within Change self.change.amount = 0.0 --- Change speed: -- Time before the frequency change happens -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersChange + -- @within Change self.change.speed = 0.0 --- Square duty: -- Width of the square wave pulse cycle (doesn't affect other waveforms) -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersDuty + -- @within Duty self.duty.ratio = 0.0 --- Duty sweep: -- Amount by which the square duty is increased or decreased over time -- (*default* 0.0, *min* -1.0, *max* 1.0) - -- @within ParametersDuty + -- @within Duty self.duty.sweep = 0.0 --- Phaser offset: -- Amount by which the phaser signal is offset from the sound -- (*default* 0.0, *min* -1.0, *max* 1.0) - -- @within ParametersPhaser + -- @within Phaser self.phaser.offset = 0.0 --- Phaser sweep: -- Amount by which the phaser offset is increased or decreased over time -- (*default* 0.0, *min* -1.0, *max* 1.0) - -- @within ParametersPhaser + -- @within Phaser self.phaser.sweep = 0.0 --- Lowpass filter cutoff: -- Lower bound for frequencies allowed to pass through this filter -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersLowpass + -- @within Lowpass self.lowpass.cutoff = 1.0 --- Lowpass filter cutoff sweep: -- Amount by which the LP filter cutoff is increased or decreased -- over time -- (*default* 0.0, *min* -1.0, *max* 1.0) - -- @within ParametersLowpass + -- @within Lowpass self.lowpass.sweep = 0.0 --- Lowpass filter resonance: -- Amount by which certain resonant frequencies near the cutoff are -- increased -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersLowpass + -- @within Lowpass self.lowpass.resonance = 0.0 --- Highpass filter cutoff: -- Upper bound for frequencies allowed to pass through this filter -- (*default* 0.0, *min* 0.0, *max* 1.0) - -- @within ParametersHighpass + -- @within Highpass self.highpass.cutoff = 0.0 --- Highpass filter cutoff sweep: -- Amount by which the HP filter cutoff is increased or decreased -- over time -- (*default* 0.0, *min* -1.0, *max* 1.0) - -- @within ParametersHighpass + -- @within Highpass self.highpass.sweep = 0.0 end