library-mirrors/sfxr.lua
1
0
Fork 0
mirror of https://github.com/nucular/sfxrlua.git synced 2024-12-24 18:44:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Renamed SavingAndLoading too

Browse Source
This commit is contained in:
nucular 2016-06-12 01:19:16 +02:00
parent 67dffe001c
commit f986205f91
3 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/api/sfxr.html
View File

@ -43,7 +43,7 @@
<li><a href="#Highpass">Highpass</a></li> <li><a href="#Highpass">Highpass</a></li>
<li><a href="#Vibrato">Vibrato</a></li> <li><a href="#Vibrato">Vibrato</a></li>
<li><a href="#Randomization">Randomization</a></li> <li><a href="#Randomization">Randomization</a></li>
<li><a href="#SavingAndLoading">SavingAndLoading</a></li> <li><a href="#Serialization">Serialization</a></li>
</ul> </ul>
@ -404,7 +404,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
<td class="summary">Randomize all sound parameters to generate a "blip" sound</td> <td class="summary">Randomize all sound parameters to generate a "blip" sound</td>
</tr> </tr>
</table> </table>
<h2><a href="#SavingAndLoading">SavingAndLoading</a></h2> <h2><a href="#Serialization">Serialization</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#sfxr.Sound:exportWAV">sfxr.Sound:exportWAV (f[, rate=44100[, depth=0]])</a></td> <td class="name" nowrap><a href="#sfxr.Sound:exportWAV">sfxr.Sound:exportWAV (f[, rate=44100[, depth=0]])</a></td>
@ -1650,7 +1650,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="SavingAndLoading"></a>SavingAndLoading</h2> <h2 class="section-header "><a name="Serialization"></a>Serialization</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1792,7 +1792,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2016-06-12 01:12:38 </i> <i style="float:right;">Last updated 2016-06-12 01:18:55 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

8
doc/index.html
View File

@ -43,7 +43,7 @@
<li><a href="#Highpass">Highpass</a></li> <li><a href="#Highpass">Highpass</a></li>
<li><a href="#Vibrato">Vibrato</a></li> <li><a href="#Vibrato">Vibrato</a></li>
<li><a href="#Randomization">Randomization</a></li> <li><a href="#Randomization">Randomization</a></li>
<li><a href="#SavingAndLoading">SavingAndLoading</a></li> <li><a href="#Serialization">Serialization</a></li>
</ul> </ul>
@ -404,7 +404,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
<td class="summary">Randomize all sound parameters to generate a "blip" sound</td> <td class="summary">Randomize all sound parameters to generate a "blip" sound</td>
</tr> </tr>
</table> </table>
<h2><a href="#SavingAndLoading">SavingAndLoading</a></h2> <h2><a href="#Serialization">Serialization</a></h2>
<table class="function_list"> <table class="function_list">
<tr> <tr>
<td class="name" nowrap><a href="#sfxr.Sound:exportWAV">sfxr.Sound:exportWAV (f[, rate=44100[, depth=0]])</a></td> <td class="name" nowrap><a href="#sfxr.Sound:exportWAV">sfxr.Sound:exportWAV (f[, rate=44100[, depth=0]])</a></td>
@ -1650,7 +1650,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd> </dd>
</dl> </dl>
<h2 class="section-header "><a name="SavingAndLoading"></a>SavingAndLoading</h2> <h2 class="section-header "><a name="Serialization"></a>Serialization</h2>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -1792,7 +1792,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2016-06-12 01:12:38 </i> <i style="float:right;">Last updated 2016-06-12 01:18:55 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

10
sfxr.lua
View File

@ -1192,7 +1192,7 @@ function sfxr.Sound:randomBlip(seed)
end end
--- Generate and export the audio data to a PCM WAVE file. --- Generate and export the audio data to a PCM WAVE file.
-- @within SavingAndLoading -- @within Serialization
-- @tparam ?string|file|love.filesystem.File f a path or file in `wb`-mode -- @tparam ?string|file|love.filesystem.File f a path or file in `wb`-mode
-- (passed files will not be closed) -- (passed files will not be closed)
-- @tparam[opt=44100] SAMPLERATE rate the sampling rate -- @tparam[opt=44100] SAMPLERATE rate the sampling rate
@ -1301,7 +1301,7 @@ function sfxr.Sound:exportWAV(f, rate, depth)
end end
--- Save the sound parameters to a file as a Lua table --- Save the sound parameters to a file as a Lua table
-- @within SavingAndLoading -- @within Serialization
-- @tparam ?string|file|love.filesystem.File f a path or file in `w`-mode -- @tparam ?string|file|love.filesystem.File f a path or file in `w`-mode
-- (passed files will not be closed) -- (passed files will not be closed)
-- @tparam[opt=true] bool minify whether to minify the output or not -- @tparam[opt=true] bool minify whether to minify the output or not
@ -1360,7 +1360,7 @@ function sfxr.Sound:save(f, minify)
end end
--- Load the sound parameters from a file containing a Lua table --- Load the sound parameters from a file containing a Lua table
-- @within SavingAndLoading -- @within Serialization
-- @tparam ?string|file|love.filesystem.File f a path or file in `r`-mode -- @tparam ?string|file|love.filesystem.File f a path or file in `r`-mode
-- (passed files will not be closed) -- (passed files will not be closed)
-- @raise "incompatible version: x.x.x" -- @raise "incompatible version: x.x.x"
@ -1392,7 +1392,7 @@ function sfxr.Sound:load(f)
end end
--- Save the sound parameters to a file in the sfxr binary format (version 102) --- Save the sound parameters to a file in the sfxr binary format (version 102)
-- @within SavingAndLoading -- @within Serialization
-- @tparam ?string|file|love.filesystem.File f a path or file in `wb`-mode -- @tparam ?string|file|love.filesystem.File f a path or file in `wb`-mode
-- (passed files will not be closed) -- (passed files will not be closed)
function sfxr.Sound:saveBinary(f) function sfxr.Sound:saveBinary(f)
@ -1451,7 +1451,7 @@ end
--- 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-102) -- (version 100-102)
-- @within SavingAndLoading -- @within Serialization
-- @tparam ?string|file|love.filesystem.File f a path or file in `rb`-mode -- @tparam ?string|file|love.filesystem.File f a path or file in `rb`-mode
-- (passed files will not be closed) -- (passed files will not be closed)
-- @raise "incompatible version: x", "unexpected file length" -- @raise "incompatible version: x", "unexpected file length"