diff --git a/doc/api/sfxr.html b/doc/api/sfxr.html
index 7ecacca..9b5e6cf 100644
--- a/doc/api/sfxr.html
+++ b/doc/api/sfxr.html
@@ -113,7 +113,7 @@
self.waveform |
- (WAVEFORM) The base wave form |
+ The base wave form (default SQUARE) |
self.envelope.attack |
@@ -124,7 +124,7 @@
self.envelope.sustain |
Sustain time:
- Time the sound sustains on its peak volume
+ Time the sound stays on its peak volume
(default 0.0, min 0.0, max 1.0) |
@@ -272,7 +272,7 @@
Generate the sound to a binary string. |
- sfxr.Sound:generateSoundData ([rate=44100[, depth=0[, a]]]) |
+ sfxr.Sound:generateSoundData ([rate=44100[, depth=0[, sounddata]]]) |
Synthesize the sound to a LÖVE SoundData instance. |
@@ -316,7 +316,7 @@
Generate and export the audio data to a PCM WAVE file. |
- sfxr.Sound:save (f[, to=true]) |
+ sfxr.Sound:save (f[, minify=true]) |
Save the sound parameters to a file as a Lua table |
@@ -325,11 +325,12 @@
sfxr.Sound:saveBinary (f) |
- Save the sound parameters to a file in the sfxr binary format |
+ 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 |
+ Load the sound parameters from a file in the sfxr binary format
+ (version 100, 101, 102) |
@@ -579,7 +580,7 @@
self.waveform
- (WAVEFORM) The base wave form
+ The base wave form (default SQUARE)
@@ -610,7 +611,7 @@
Sustain time:
- Time the sound sustains on its peak volume
+ Time the sound stays on its peak volume
(default 0.0, min 0.0, max 1.0)
@@ -987,6 +988,8 @@
a generator that yields the sample data when called
+ Raises:
+ "invalid sample rate: x", "invalid bit depth: x"
Usage:
@@ -1017,6 +1020,8 @@
+ Raises:
+ "invalid sample rate: x", "invalid bit depth: x"
@@ -1058,6 +1063,8 @@
the number of written samples (== #tab)
+ Raises:
+ "invalid sample rate: x", "invalid bit depth: x"
@@ -1099,13 +1106,15 @@
the number of written samples
+ Raises:
+ "invalid sample rate: x", "invalid bit depth: x", "invalid endianness: x"
- sfxr.Sound:generateSoundData ([rate=44100[, depth=0[, a]]])
+ sfxr.Sound:generateSoundData ([rate=44100[, depth=0[, sounddata]]])
Synthesize the sound to a LÖVE SoundData instance.
@@ -1123,10 +1132,10 @@
the bit depth
(default 0)
- a
+ sounddata
love.sound.SoundData
- SoundData instance (will be created if
- not passed)
+ a SoundData instance (will be
+ created if not passed)
(optional)
@@ -1141,6 +1150,8 @@
the number of written samples
+ Raises:
+ "invalid sample rate: x", "invalid bit depth: x"
@@ -1364,7 +1375,8 @@
- f
string, file or love.filesystem.File
- a file path, a Lua file object, a love.filesystem.File instance
+ a path or file in
wb
-mode
+ (passed files will not be closed)
- rate
SAMPLERATE
@@ -1379,13 +1391,15 @@
+ Raises:
+ "invalid sample rate: x", "invalid bit depth: x"
- sfxr.Sound:save (f[, to=true])
+ sfxr.Sound:save (f[, minify=true])
Save the sound parameters to a file as a Lua table
@@ -1395,11 +1409,12 @@
- f
string, file or love.filesystem.File
- a file path, a Lua file object, a love.filesystem.File instance
+ a path or file in
w
-mode
+ (passed files will not be closed)
- - to
- whether
- minify the output
+
- minify
+ bool
+ whether to minify the output or not
(default true)
@@ -1421,11 +1436,14 @@
- f
string, file or love.filesystem.File
- a file path, a Lua file object, a love.filesystem.File instance
+ a path or file in
r
-mode
+ (passed files will not be closed)
+ Raises:
+ "incompatible version: x.x.x"
@@ -1435,14 +1453,15 @@
sfxr.Sound:saveBinary (f)
- Save the sound parameters to a file in the sfxr binary format
+ Save the sound parameters to a file in the sfxr binary format (version 102)
Parameters:
- f
string, file or love.filesystem.File
- a file path, a Lua file object, a love.filesystem.File instance
+ a path or file in
wb
-mode
+ (passed files will not be closed)
@@ -1457,17 +1476,21 @@
Load the sound parameters from a file in the sfxr binary format
+ (version 100, 101, 102)
Parameters:
- f
string, file or love.filesystem.File
- a file path, a Lua file object, a love.filesystem.File instance
+ a path or file in
rb
-mode
+ (passed files will not be closed)
+ Raises:
+ "incompatible version: x", "unexpected file length"
@@ -1479,7 +1502,7 @@
generated by LDoc 1.4.3
-
Last updated 2016-03-02 00:35:01
+
Last updated 2016-03-05 19:36:51