diff --git a/README.md b/README.md
index cd1d76c..a8f0a86 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ by the demo. A move to a new GUI framework is pending.
Example usage
-------------
-These examples should play a randomly generated sound.
+The following code examples demonstrate how to play a randomly generated sound:
With [LÖVE](http://love2d.org):
```lua
@@ -28,7 +28,9 @@ local sfxr = require("sfxr")
function love.load()
local sound = sfxr.newSound()
sound:randomize()
- sound:play()
+ local sounddata = sound:generateSoundData()
+ local source = love.audio.newSource(sounddata)
+ source:play()
end
```
diff --git a/doc/api/sfxr.html b/doc/api/sfxr.html
index e9cb9d4..cd03fc2 100644
--- a/doc/api/sfxr.html
+++ b/doc/api/sfxr.html
@@ -33,17 +33,17 @@
Module sfxr
-
A port of the sfxr sound effect synthesizer to Lua
+
A port of the sfxr sound effect synthesizer to pure Lua, designed to be used
+together with the awesome LÖVE game framework.
@@ -151,7 +152,7 @@
The base waveform (default SQUARE) |
-
+
self.envelope |
@@ -185,7 +186,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
(default 0.0, min 0.0, max 1.0)
-
+
self.frequency |
@@ -217,7 +218,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
(default 0.0, min -1.0, max 1.0)
-
+
self.vibrato |
@@ -243,7 +244,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
(default 0.0, min 0.0, max 1.0)
-
+
self.change |
@@ -263,7 +264,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
(default 0.0, min 0.0, max 1.0)
-
+
self.duty |
@@ -283,7 +284,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
(default 0.0, min -1.0, max 1.0)
-
+
self.phaser |
@@ -303,7 +304,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
(default 0.0, min -1.0, max 1.0)
-
+
self.lowpass |
@@ -331,7 +332,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
(default 0.0, min 0.0, max 1.0)
-
+
self.highpass |
@@ -352,7 +353,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
(default 0.0, min -1.0, max 1.0)
-
+
self.volume.master |
@@ -402,7 +403,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
Randomize all sound parameters to generate a "blip" sound |
-
+
sfxr.Sound:exportWAV (f[, rate=44100[, depth=0]]) |
@@ -895,7 +896,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
-
+
-
@@ -980,7 +981,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
-
+
-
@@ -1063,7 +1064,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
-
+
-
@@ -1130,7 +1131,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
-
+
-
@@ -1181,7 +1182,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
-
+
-
@@ -1232,7 +1233,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
-
+
-
@@ -1283,7 +1284,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
-
+
-
@@ -1352,7 +1353,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
-
+
-
@@ -1404,7 +1405,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
-
+
-
@@ -1647,7 +1648,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the so
-
+
-
@@ -1789,7 +1790,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:02:39
+
Last updated 2016-03-05 21:40:35