diff --git a/config.ld b/config.ld
index 9916742..9e08d3f 100644
--- a/config.ld
+++ b/config.ld
@@ -2,6 +2,7 @@ project = "sfxr.lua"
description = "A port of the sfxr sound effect synthesizer to Lua"
title = "sfxr.lua Documentation"
format = "markdown"
+not_luadoc = true
style = "!pale"
kind_names = {topic = "Topics", module = "API"}
dir = "./doc"
diff --git a/doc/api/sfxr.html b/doc/api/sfxr.html
index 0d75658..e9cb9d4 100644
--- a/doc/api/sfxr.html
+++ b/doc/api/sfxr.html
@@ -42,6 +42,8 @@
Parameters.lowpass
Parameters.highpass
Parameters.volume
+Randomization
+SavingLoading
@@ -127,63 +129,6 @@
| sfxr.Sound:generateSoundData ([rate=44100[, depth=0[, sounddata]]]) |
Synthesize the sound to a LÖVE SoundData instance. |
-
- | sfxr.Sound:randomize ([seed]) |
- Randomize all sound parameters |
-
-
- | sfxr.Sound:mutate ([by=1][, seed], whether) |
- Mutate all sound parameters |
-
-
- | sfxr.Sound:randomPickup ([seed]) |
- Randomize all sound parameters to generate an item pick up sound |
-
-
- | sfxr.Sound:randomLaser ([seed]) |
- Randomize all sound parameters to generate a laser sound |
-
-
- | sfxr.Sound:randomExplosion ([seed]) |
- Randomize all sound parameters to generate an explosion sound |
-
-
- | sfxr.Sound:randomPowerup ([seed]) |
- Randomize all sound parameters to generate a power up sound |
-
-
- | sfxr.Sound:randomHit ([seed]) |
- Randomize all sound parameters to generate a hit sound |
-
-
- | sfxr.Sound:randomJump ([seed]) |
- Randomize all sound parameters to generate a jump sound |
-
-
- | sfxr.Sound:randomBlip ([seed]) |
- Randomize all sound parameters to generate a blip sound |
-
-
- | sfxr.Sound:exportWAV (f[, rate=44100[, depth=0]]) |
- Generate and export the audio data to a PCM WAVE file. |
-
-
- | sfxr.Sound:save (f[, minify=true]) |
- Save the sound parameters to a file as a Lua table |
-
-
- | sfxr.Sound:load (f) |
- Load the sound parameters from a file containing a Lua table |
-
-
- | sfxr.Sound:saveBinary (f) |
- Save the sound parameters to a file in the sfxr binary format (version 102) |
-
-
- | sfxr.Sound:loadBinary (f) |
- Load the sound parameters from a file in the sfxr binary format
- (version 100-102) |
-
@@ -192,6 +137,10 @@
| The sound volume and gain all samples are multiplied with |
+ | self.supersampling |
+ Number of supersampling passes to perform (default 8) |
+
+
| self.repeatspeed |
Repeat speed:
Times to repeat the frequency slide over the course of the envelope
@@ -414,6 +363,69 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
| Additional gain (default 0.5) |
+
+
+
+
@@ -599,7 +611,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
Set all parameters to their default values. Does not affect
- ??? and volume.
+ supersampling and volume.
Called by the initializer.
@@ -819,345 +831,6 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
-
-
-
- sfxr.Sound:randomize ([seed])
-
-
- Randomize all sound parameters
-
-
- Parameters:
-
- - seed
- number
- a random seed
- (optional)
-
-
-
-
-
-
-
-
-
-
- sfxr.Sound:mutate ([by=1][, seed], whether)
-
-
- Mutate all sound parameters
-
-
- Parameters:
-
- - by
- amount
- how much to mutate the parameters
- (default 1)
-
- - seed
- number
- a random seed
- (optional)
-
- - whether
- bool
- to change the frequency parameters
-
-
-
-
-
-
-
-
-
-
- sfxr.Sound:randomPickup ([seed])
-
-
- Randomize all sound parameters to generate an item pick up sound
-
-
- Parameters:
-
- - seed
- number
- a random seed
- (optional)
-
-
-
-
-
-
-
-
-
-
- sfxr.Sound:randomLaser ([seed])
-
-
- Randomize all sound parameters to generate a laser sound
-
-
- Parameters:
-
- - seed
- number
- a random seed
- (optional)
-
-
-
-
-
-
-
-
-
-
- sfxr.Sound:randomExplosion ([seed])
-
-
- Randomize all sound parameters to generate an explosion sound
-
-
- Parameters:
-
- - seed
- number
- a random seed
- (optional)
-
-
-
-
-
-
-
-
-
-
- sfxr.Sound:randomPowerup ([seed])
-
-
- Randomize all sound parameters to generate a power up sound
-
-
- Parameters:
-
- - seed
- number
- a random seed
- (optional)
-
-
-
-
-
-
-
-
-
-
- sfxr.Sound:randomHit ([seed])
-
-
- Randomize all sound parameters to generate a hit sound
-
-
- Parameters:
-
- - seed
- number
- a random seed
- (optional)
-
-
-
-
-
-
-
-
-
-
- sfxr.Sound:randomJump ([seed])
-
-
- Randomize all sound parameters to generate a jump sound
-
-
- Parameters:
-
- - seed
- number
- a random seed
- (optional)
-
-
-
-
-
-
-
-
-
-
- sfxr.Sound:randomBlip ([seed])
-
-
- Randomize all sound parameters to generate a blip sound
-
-
- Parameters:
-
- - seed
- number
- a random seed
- (optional)
-
-
-
-
-
-
-
-
-
-
- sfxr.Sound:exportWAV (f[, rate=44100[, depth=0]])
-
-
- Generate and export the audio data to a PCM WAVE file.
-
-
- Parameters:
-
- - f
- string, file or love.filesystem.File
- a path or file in
wb-mode
- (passed files will not be closed)
-
- - rate
- SAMPLERATE
- the sampling rate
- (default 44100)
-
- - depth
- BITDEPTH
- the bit depth
- (default 0)
-
-
-
-
- Raises:
- "invalid sampling rate: x", "invalid bit depth: x"
-
-
-
-
-
-
- sfxr.Sound:save (f[, minify=true])
-
-
- Save the sound parameters to a file as a Lua table
-
-
- Parameters:
-
- - f
- string, file or love.filesystem.File
- a path or file in
w-mode
- (passed files will not be closed)
-
- - minify
- bool
- whether to minify the output or not
- (default true)
-
-
-
-
-
-
-
-
-
-
- sfxr.Sound:load (f)
-
-
- Load the sound parameters from a file containing a Lua table
-
-
- Parameters:
-
- - f
- string, file or love.filesystem.File
- a path or file in
r-mode
- (passed files will not be closed)
-
-
-
-
- Raises:
- "incompatible version: x.x.x"
-
-
-
-
-
-
- sfxr.Sound:saveBinary (f)
-
-
- Save the sound parameters to a file in the sfxr binary format (version 102)
-
-
- Parameters:
-
- - f
- string, file or love.filesystem.File
- a path or file in
wb-mode
- (passed files will not be closed)
-
-
-
-
-
-
-
-
-
-
- sfxr.Sound:loadBinary (f)
-
-
- Load the sound parameters from a file in the sfxr binary format
- (version 100-102)
-
-
- Parameters:
-
- - f
- string, file or love.filesystem.File
- a path or file in
rb-mode
- (passed files will not be closed)
-
-
-
-
- Raises:
- "incompatible version: x", "unexpected file length"
-
-
-
@@ -1176,6 +849,20 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
+
+
+
+ self.supersampling
+
+
+ Number of supersampling passes to perform (default 8)
+
+
+
+
+
+
+
@@ -1747,6 +1434,353 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
+
+
+
+
+
+ -
+
+ sfxr.Sound:randomize ([seed])
+
+ -
+ Randomize all sound parameters
+
+
+
Parameters:
+
+ - seed
+ number
+ a random seed
+ (optional)
+
+
+
+
+
+
+
+
+ -
+
+ sfxr.Sound:mutate ([amount=1][, seed], changefreq)
+
+ -
+ Mutate all sound parameters
+
+
+
Parameters:
+
+ - amount
+ number
+ by how much to mutate the parameters
+ (default 1)
+
+ - seed
+ number
+ a random seed
+ (optional)
+
+ - changefreq
+ bool
+ whether to change the frequency parameters
+
+
+
+
+
+
+
+
+ -
+
+ sfxr.Sound:randomPickup ([seed])
+
+ -
+ Randomize all sound parameters to generate a "pick up" sound
+
+
+
Parameters:
+
+ - seed
+ number
+ a random seed
+ (optional)
+
+
+
+
+
+
+
+
+ -
+
+ sfxr.Sound:randomLaser ([seed])
+
+ -
+ Randomize all sound parameters to generate a laser sound
+
+
+
Parameters:
+
+ - seed
+ number
+ a random seed
+ (optional)
+
+
+
+
+
+
+
+
+ -
+
+ sfxr.Sound:randomExplosion ([seed])
+
+ -
+ Randomize all sound parameters to generate an explosion sound
+
+
+
Parameters:
+
+ - seed
+ number
+ a random seed
+ (optional)
+
+
+
+
+
+
+
+
+ -
+
+ sfxr.Sound:randomPowerup ([seed])
+
+ -
+ Randomize all sound parameters to generate a "power up" sound
+
+
+
Parameters:
+
+ - seed
+ number
+ a random seed
+ (optional)
+
+
+
+
+
+
+
+
+ -
+
+ sfxr.Sound:randomHit ([seed])
+
+ -
+ Randomize all sound parameters to generate a hit sound
+
+
+
Parameters:
+
+ - seed
+ number
+ a random seed
+ (optional)
+
+
+
+
+
+
+
+
+ -
+
+ sfxr.Sound:randomJump ([seed])
+
+ -
+ Randomize all sound parameters to generate a jump sound
+
+
+
Parameters:
+
+ - seed
+ number
+ a random seed
+ (optional)
+
+
+
+
+
+
+
+
+ -
+
+ sfxr.Sound:randomBlip ([seed])
+
+ -
+ Randomize all sound parameters to generate a "blip" sound
+
+
+
Parameters:
+
+ - seed
+ number
+ a random seed
+ (optional)
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+ sfxr.Sound:exportWAV (f[, rate=44100[, depth=0]])
+
+ -
+ Generate and export the audio data to a PCM WAVE file.
+
+
+
Parameters:
+
+ - f
+ string, file or love.filesystem.File
+ a path or file in
wb-mode
+ (passed files will not be closed)
+
+ - rate
+ SAMPLERATE
+ the sampling rate
+ (default 44100)
+
+ - depth
+ BITDEPTH
+ the bit depth
+ (default 0)
+
+
+
+
+ Raises:
+ "invalid sampling rate: x", "invalid bit depth: x"
+
+
+
+
+ -
+
+ sfxr.Sound:save (f[, minify=true])
+
+ -
+ Save the sound parameters to a file as a Lua table
+
+
+
Parameters:
+
+ - f
+ string, file or love.filesystem.File
+ a path or file in
w-mode
+ (passed files will not be closed)
+
+ - minify
+ bool
+ whether to minify the output or not
+ (default true)
+
+
+
+
+
+
+
+
+ -
+
+ sfxr.Sound:load (f)
+
+ -
+ Load the sound parameters from a file containing a Lua table
+
+
+
Parameters:
+
+ - f
+ string, file or love.filesystem.File
+ a path or file in
r-mode
+ (passed files will not be closed)
+
+
+
+
+ Raises:
+ "incompatible version: x.x.x"
+
+
+
+
+ -
+
+ sfxr.Sound:saveBinary (f)
+
+ -
+ Save the sound parameters to a file in the sfxr binary format (version 102)
+
+
+
Parameters:
+
+ - f
+ string, file or love.filesystem.File
+ a path or file in
wb-mode
+ (passed files will not be closed)
+
+
+
+
+
+
+
+
+ -
+
+ sfxr.Sound:loadBinary (f)
+
+ -
+ Load the sound parameters from a file in the sfxr binary format
+ (version 100-102)
+
+
+
Parameters:
+
+ - f
+ string, file or love.filesystem.File
+ a path or file in
rb-mode
+ (passed files will not be closed)
+
+
+
+
+ Raises:
+ "incompatible version: x", "unexpected file length"
+
+
+
@@ -1755,7 +1789,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
generated by LDoc 1.4.3
-
Last updated 2016-03-05 20:46:41
+
Last updated 2016-03-05 21:02:39
diff --git a/doc/index.html b/doc/index.html
index 37ae11a..dc216fb 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -42,6 +42,8 @@