diff --git a/README.md b/README.md
index 882a740..cd1d76c 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,6 @@ Documentation
This project uses [LDoc](http://stevedonovan.github.io/ldoc/) for autogenerated
API documentation.
-(Reminder to self: `ldoc . && git subtree push --prefix doc origin gh-pages`)
+(Note to self: `ldoc . && git subtree push --prefix doc origin gh-pages`)
The old documentation is still available on the
[Project Wiki](https://github.com/nucular/sfxrlua/wiki).
diff --git a/doc/api/sfxr.html b/doc/api/sfxr.html
index 9b5e6cf..3eb434c 100644
--- a/doc/api/sfxr.html
+++ b/doc/api/sfxr.html
@@ -63,21 +63,21 @@
@@ -94,6 +94,47 @@
Initialize the Sound instance. |
+ self.volume |
+ The sound volume and gain all samples are multiplied with |
+
+
+ self.envelope |
+ The ASD envelope that controls the sound amplitude
+ (volume) over time |
+
+
+ self.frequency |
+ The base and minimum frequencies of the tone generator and their slides |
+
+
+ self.vibrato |
+ A vibrato-like amplitude
+ modulation effect. |
+
+
+ self.change |
+ Changes the frequency mid-sound to create the characteristic
+ "coin"-effect |
+
+
+ self.duty |
+ The duty of the square
+ waveform |
+
+
+ self.phaser |
+ A simple phaser effect |
+
+
+ self.lowpass |
+ A lowpass filter effect |
+
+
+ self.highpass |
+ A highpass filter effect |
+
+
self.volume.master |
Master volume (default 0.5) |
@@ -113,24 +154,24 @@
self.waveform |
- The base wave form (default SQUARE) |
+ The base waveform (default SQUARE) |
self.envelope.attack |
Attack time:
- Time the sound takes to reach its peak volume
+ Time the sound takes to reach its peak amplitude
(default 0.0, min 0.0, max 1.0) |
self.envelope.sustain |
Sustain time:
- Time the sound stays on its peak volume
+ Time the sound stays on its peak amplitude
(default 0.0, min 0.0, max 1.0) |
self.envelope.punch |
Sustain punch:
- Amount by which the sound peak volume is increased at the start of the
+ 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) |
@@ -155,19 +196,19 @@
self.frequency.slide |
Slide:
- Amount by which the frequency is increased or decreased through time
+ Amount by which the frequency is increased or decreased over time
(default 0.0, min -1.0, max 1.0) |
self.frequency.dslide |
Delta slide:
- Amount by which the slide is increased or decreased through time
+ Amount by which the slide is increased or decreased over time
(default 0.0, min -1.0, max 1.0) |
self.vibrato.depth |
Vibrato depth:
- Amount of vibrato-like amplitude (volume) modulation
+ Amount of amplitude modulation
(default 0.0, min 0.0, max 1.0) |
@@ -203,7 +244,7 @@
self.duty.sweep |
Duty sweep:
- Amount by which the square duty is increased or decreased through time
+ Amount by which the square duty is increased or decreased over time
(default 0.0, min -1.0, max 1.0) |
@@ -215,7 +256,7 @@
self.phaser.sweep |
Phaser sweep:
- Amount by which the phaser offset is increased or decreased through time
+ Amount by which the phaser offset is increased or decreased over time
(default 0.0, min -1.0, max 1.0) |
@@ -228,7 +269,7 @@
self.lowpass.sweep |
Lowpass filter cutoff sweep:
Amount by which the LP filter cutoff is increased or decreased
- through time
+ over time
(default 0.0, min -1.0, max 1.0) |
@@ -248,12 +289,12 @@
self.highpass.sweep |
Highpass filter cutoff sweep:
Amount by which the HP filter cutoff is increased or decreased
- through time
+ over time
(default 0.0, min -1.0, max 1.0) |
sfxr.Sound:sanitizeParameters () |
- Clamp all parameters within sane ranges. |
+ Clamp all parameters within their sane ranges. |
sfxr.Sound:generate ([rate=44100[, depth=0]]) |
@@ -330,7 +371,7 @@
sfxr.Sound:loadBinary (f) |
Load the sound parameters from a file in the sfxr binary format
- (version 100, 101, 102) |
+ (version 100-102)
@@ -378,7 +419,7 @@
WAVEFORM
- Wave form constants
+ Waveform constants
Fields:
@@ -407,7 +448,7 @@
SAMPLERATE
- Sample rate constants
+ Sampling rate constants
(use the number values directly, these are just for lookup)
@@ -431,7 +472,7 @@
BITDEPTH
- Bit depth constants
+ Bit depth constants
(use the number values directly, these are just for lookup)
@@ -458,7 +499,7 @@
ENDIANNESS
- Endianness constants
+ Endianness constants
Fields:
@@ -515,6 +556,137 @@
+
+
+
+ self.volume
+
+
+ The sound volume and gain all samples are multiplied with
+
+
+
+
+
+
+
+
+
+
+ self.envelope
+
+
+ The ASD envelope that controls the sound amplitude
+ (volume) over time
+
+
+
+
+
+
+
+
+
+
+ self.frequency
+
+
+ The base and minimum frequencies of the tone generator and their slides
+
+
+
+
+
+
+
+
+
+
+ self.vibrato
+
+
+ A vibrato-like amplitude
+ modulation effect.
+
+
+
+
+
+
+
+
+
+
+ self.change
+
+
+ Changes the frequency mid-sound to create the characteristic
+ "coin"-effect
+
+
+
+
+
+
+
+
+
+
+ self.duty
+
+
+ The duty of the square
+ waveform
+
+
+
+
+
+
+
+
+
+
+ self.phaser
+
+
+ A simple phaser effect
+
+
+
+
+
+
+
+
+
+
+ self.lowpass
+
+
+ A lowpass filter effect
+
+
+
+
+
+
+
+
+
+
+ self.highpass
+
+
+ A highpass filter effect
+
+
+
+
+
+
+
@@ -580,7 +752,7 @@
self.waveform
- The base wave form (default SQUARE)
+ The base waveform (default SQUARE)
@@ -595,7 +767,7 @@
Attack time:
- Time the sound takes to reach its peak volume
+ Time the sound takes to reach its peak amplitude
(default 0.0, min 0.0, max 1.0)
@@ -611,7 +783,7 @@
Sustain time:
- Time the sound stays on its peak volume
+ Time the sound stays on its peak amplitude
(default 0.0, min 0.0, max 1.0)
@@ -627,7 +799,7 @@
Sustain punch:
- Amount by which the sound peak volume is increased at the start of the
+ 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)
@@ -692,7 +864,7 @@
Slide:
- Amount by which the frequency is increased or decreased through time
+ Amount by which the frequency is increased or decreased over time
(default 0.0, min -1.0, max 1.0)
@@ -708,7 +880,7 @@
Delta slide:
- Amount by which the slide is increased or decreased through time
+ Amount by which the slide is increased or decreased over time
(default 0.0, min -1.0, max 1.0)
@@ -724,7 +896,7 @@
Vibrato depth:
- Amount of vibrato-like amplitude (volume) modulation
+ Amount of amplitude modulation
(default 0.0, min 0.0, max 1.0)
@@ -820,7 +992,7 @@
Duty sweep:
- Amount by which the square duty is increased or decreased through time
+ Amount by which the square duty is increased or decreased over time
(default 0.0, min -1.0, max 1.0)
@@ -852,7 +1024,7 @@
Phaser sweep:
- Amount by which the phaser offset is increased or decreased through time
+ Amount by which the phaser offset is increased or decreased over time
(default 0.0, min -1.0, max 1.0)
@@ -885,7 +1057,7 @@
Lowpass filter cutoff sweep:
Amount by which the LP filter cutoff is increased or decreased
- through time
+ over time
(default 0.0, min -1.0, max 1.0)
@@ -935,7 +1107,7 @@
Highpass filter cutoff sweep:
Amount by which the HP filter cutoff is increased or decreased
- through time
+ over time
(default 0.0, min -1.0, max 1.0)
@@ -950,7 +1122,7 @@
sfxr.Sound:sanitizeParameters ()
- Clamp all parameters within sane ranges.
+ Clamp all parameters within their sane ranges.
@@ -971,7 +1143,7 @@
- rate
SAMPLERATE
- the sample rate
+ the sampling rate
(default 44100)
- depth
@@ -985,11 +1157,11 @@
function()
- a generator that yields the sample data when called
+ a generator that yields the next sample when called
Raises:
- "invalid sample rate: x", "invalid bit depth: x"
+ "invalid sampling rate: x", "invalid bit depth: x"
Usage:
@@ -1014,14 +1186,14 @@
- rate
SAMPLERATE
- the sample rate
+ the sampling rate
(default 44100)
Raises:
- "invalid sample rate: x", "invalid bit depth: x"
+ "invalid sampling rate: x", "invalid bit depth: x"
@@ -1038,7 +1210,7 @@
- rate
SAMPLERATE
- the sample rate
+ the sampling rate
(default 44100)
- depth
@@ -1064,7 +1236,7 @@
Raises:
- "invalid sample rate: x", "invalid bit depth: x"
+ "invalid sampling rate: x", "invalid bit depth: x"
@@ -1081,7 +1253,7 @@
- rate
SAMPLERATE
- the sample rate
+ the sampling rate
(default 44100)
- depth
@@ -1107,7 +1279,7 @@
Raises:
- "invalid sample rate: x", "invalid bit depth: x", "invalid endianness: x"
+ "invalid sampling rate: x", "invalid bit depth: x", "invalid endianness: x"
@@ -1124,7 +1296,7 @@
- rate
SAMPLERATE
- the sample rate
+ the sampling rate
(default 44100)
- depth
@@ -1151,7 +1323,7 @@
Raises:
- "invalid sample rate: x", "invalid bit depth: x"
+ "invalid sampling rate: x", "invalid bit depth: x"
@@ -1380,7 +1552,7 @@
- rate
SAMPLERATE
- the sample rate
+ the sampling rate
(default 44100)
- depth
@@ -1392,7 +1564,7 @@
Raises:
- "invalid sample rate: x", "invalid bit depth: x"
+ "invalid sampling rate: x", "invalid bit depth: x"
@@ -1476,7 +1648,7 @@
-
Load the sound parameters from a file in the sfxr binary format
- (version 100, 101, 102)
+ (version 100-102)
Parameters:
@@ -1502,7 +1674,7 @@
generated by LDoc 1.4.3
-
Last updated 2016-03-05 19:36:51
+
Last updated 2016-03-05 20:16:35