@@ -38,6 +38,9 @@ ifneq (,$(wildcard $(CURDIR)/bin/vst/cabbage-Additive.so)) | |||
cp -r bin/vst/* $(DESTDIR)$(PREFIX)/lib/vst/ | |||
endif | |||
# install protoplug files | |||
cp -r ports/protoplug/ProtoplugFiles $(DESTDIR)$(PREFIX)/share/ | |||
# ----------------------------------------- | |||
# clean | |||
@@ -14,6 +14,8 @@ lv2: | |||
$(MAKE) -C cabbage/LV2-fx | |||
$(MAKE) -C cabbage/LV2-ins | |||
$(MAKE) -C cabbage/LV2-midi | |||
$(MAKE) -C protoplug/LV2-fx | |||
$(MAKE) -C protoplug/LV2-gen | |||
# ----------------------------------------- | |||
# vst | |||
@@ -24,6 +26,8 @@ vst: | |||
$(MAKE) -C cabbage/VST-fx | |||
$(MAKE) -C cabbage/VST-ins | |||
$(MAKE) -C cabbage/VST-midi | |||
$(MAKE) -C protoplug/VST-fx | |||
$(MAKE) -C protoplug/VST-gen | |||
# ----------------------------------------- | |||
# clean | |||
@@ -34,12 +38,16 @@ clean: | |||
$(MAKE) clean -C cabbage/LV2-fx | |||
$(MAKE) clean -C cabbage/LV2-ins | |||
$(MAKE) clean -C cabbage/LV2-midi | |||
$(MAKE) clean -C protoplug/LV2-fx | |||
$(MAKE) clean -C protoplug/LV2-gen | |||
# VST | |||
$(MAKE) clean -C argotlunar/VST | |||
$(MAKE) clean -C cabbage/VST-fx | |||
$(MAKE) clean -C cabbage/VST-ins | |||
$(MAKE) clean -C cabbage/VST-midi | |||
$(MAKE) clean -C protoplug/VST-fx | |||
$(MAKE) clean -C protoplug/VST-gen | |||
rm -rf */LV2/intermediate | |||
rm -rf */VST/intermediate | |||
@@ -0,0 +1,24 @@ | |||
dofile("../../../scripts/make-project.lua") | |||
package = make_juce_lv2_project("protoplug-fx") | |||
package.defines = { | |||
package.defines, | |||
"PROTOPLUGFX=1" | |||
} | |||
package.includepaths = { | |||
package.includepaths, | |||
"../Source", | |||
"../JuceLibraryCode" | |||
} | |||
package.files = { | |||
matchfiles ( | |||
"../Source/*.cpp", | |||
"../Source/guiclasses/*.cpp", | |||
"../Source/vflib/*.cpp", | |||
"../../../libs/juce-plugin/JucePluginMain.cpp" | |||
) | |||
} |
@@ -0,0 +1,24 @@ | |||
dofile("../../../scripts/make-project.lua") | |||
package = make_juce_lv2_project("protoplug-gen") | |||
package.defines = { | |||
package.defines, | |||
"PROTOPLUGFX=0" | |||
} | |||
package.includepaths = { | |||
package.includepaths, | |||
"../Source", | |||
"../JuceLibraryCode" | |||
} | |||
package.files = { | |||
matchfiles ( | |||
"../Source/*.cpp", | |||
"../Source/guiclasses/*.cpp", | |||
"../Source/vflib/*.cpp", | |||
"../../../libs/juce-plugin/JucePluginMain.cpp" | |||
) | |||
} |
@@ -0,0 +1,469 @@ | |||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | |||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | |||
<html> | |||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> | |||
<head> | |||
<title>protoplug: Class juce.AffineTransform</title> | |||
<link rel="stylesheet" href="../ldoc.css" type="text/css" /> | |||
</head> | |||
<body> | |||
<div id="container"> | |||
<div id="product"> | |||
<div id="product_logo"></div> | |||
<div id="product_name"><big><b></b></big></div> | |||
<div id="product_description"></div> | |||
</div> <!-- id="product" --> | |||
<div id="main"> | |||
<!-- Menu --> | |||
<div id="navigation"> | |||
<a href="http://osar.fr"> | |||
<div class=osarlogo> </div> | |||
</a> | |||
<br/> | |||
<a href="http://osar.fr/protoplug"> | |||
<h1>protoplug</h1> | |||
</a> | |||
<span class="proto_subtitle">Lua API reference</span> | |||
<ul> | |||
<li><a href="../index.html">Index</a></li> | |||
</ul> | |||
<h2>Contents</h2> | |||
<ul> | |||
<li><a href="#Constructors">Constructors</a></li> | |||
<li><a href="#Methods">Methods</a></li> | |||
<li><a href="#Fields">Fields</a></li> | |||
<li><a href="#Predefined_values">Predefined values</a></li> | |||
</ul> | |||
<h2>Classes</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><strong>juce.AffineTransform</strong></li> | |||
<li><a href="../classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></li> | |||
<li><a href="../classes/juce.Colour.html">juce.Colour</a></li> | |||
<li><a href="../classes/juce.ColourGradient.html">juce.ColourGradient</a></li> | |||
<li><a href="../classes/juce.Component.html">juce.Component</a></li> | |||
<li><a href="../classes/juce.FillType.html">juce.FillType</a></li> | |||
<li><a href="../classes/juce.Font.html">juce.Font</a></li> | |||
<li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li> | |||
<li><a href="../classes/juce.Image.html">juce.Image</a></li> | |||
<li><a href="../classes/juce.Justification.html">juce.Justification</a></li> | |||
<li><a href="../classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></li> | |||
<li><a href="../classes/juce.Line.html">juce.Line</a></li> | |||
<li><a href="../classes/juce.Path.html">juce.Path</a></li> | |||
<li><a href="../classes/juce.Point.html">juce.Point</a></li> | |||
<li><a href="../classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></li> | |||
<li><a href="../classes/juce.Rectangle_float.html">juce.Rectangle_float</a></li> | |||
<li><a href="../classes/juce.Rectangle_int.html">juce.Rectangle_int</a></li> | |||
</ul> | |||
<h2>Modules</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../modules/plugin.html">plugin</a></li> | |||
<li><a href="../modules/script.html">script</a></li> | |||
<li><a href="../modules/midi.html">midi</a></li> | |||
<li><a href="../modules/gui.html">gui</a></li> | |||
<li><a href="../modules/polyGen.html">polyGen</a></li> | |||
<li><a href="../modules/stereoFx.html">stereoFx</a></li> | |||
</ul> | |||
<h2>Examples</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../examples/classic-filter.lua.html">classic-filter.lua</a></li> | |||
<li><a href="../examples/sine-organ.lua.html">sine-organ.lua</a></li> | |||
<li><a href="../examples/midi-chordify.lua.html">midi-chordify.lua</a></li> | |||
<li><a href="../examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></li> | |||
<li><a href="../examples/soundfile-test.lua.html">soundfile-test.lua</a></li> | |||
</ul> | |||
</div> | |||
<div id="content"> | |||
<h1>Class <code>juce.AffineTransform</code></h1> | |||
<p>A geometric transformation.</p> | |||
<p> | |||
<p> Is converted to a <a href="http://www.juce.com/api/classAffineTransform.html">JUCE AffineTransform</a>.</p> | |||
<p> The default constructor makes an <a href="../classes/juce.AffineTransform.html#juce.AffineTransform.identity">identity</a> transform, so all kinds of | |||
transformations can be created as follows :</p> | |||
<pre><code>rot180 = juce.AffineTransform():rotated(math.pi) | |||
chainey = juce.AffineTransform():scaled(2.5):translated(140,140) | |||
</code></pre> | |||
</p> | |||
<h2><a href="#Constructors">Constructors</a></h2> | |||
<table class="function_list"> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AffineTransform.AffineTransform"><span class="proto_prefix">juce</span>.AffineTransform (mat00, mat01, mat02, mat10, mat11, mat12)</a></td> | |||
<td class="summary">Constuctor.</td> | |||
</tr> | |||
</table> | |||
<h2><a href="#Methods">Methods</a></h2> | |||
<table class="function_list"> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AffineTransform:translated"><span class="proto_prefix">juce.AffineTransform</span>:translated (dx, dy)</a></td> | |||
<td class="summary">Translated.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AffineTransform:rotated"><span class="proto_prefix">juce.AffineTransform</span>:rotated (rad)</a></td> | |||
<td class="summary">Rotated.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AffineTransform:scaled"><span class="proto_prefix">juce.AffineTransform</span>:scaled (scaleX[, scaleY=scaleX])</a></td> | |||
<td class="summary">Scaled.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AffineTransform:followedBy"><span class="proto_prefix">juce.AffineTransform</span>:followedBy (other)</a></td> | |||
<td class="summary">Followed by.</td> | |||
</tr> | |||
</table> | |||
<h2><a href="#Fields">Fields</a></h2> | |||
<table class="function_list"> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AffineTransform.mat00"><span class="proto_prefix">juce.AffineTransform</span>.mat00</a></td> | |||
<td class="summary">Matrix [0] [0]</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AffineTransform.mat01"><span class="proto_prefix">juce.AffineTransform</span>.mat01</a></td> | |||
<td class="summary">Matrix [0] [1]</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AffineTransform.mat02"><span class="proto_prefix">juce.AffineTransform</span>.mat02</a></td> | |||
<td class="summary">Matrix [0] [2]</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AffineTransform.mat10"><span class="proto_prefix">juce.AffineTransform</span>.mat10</a></td> | |||
<td class="summary">Matrix [1] [0]</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AffineTransform.mat11"><span class="proto_prefix">juce.AffineTransform</span>.mat11</a></td> | |||
<td class="summary">Matrix [1] [1]</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AffineTransform.mat12"><span class="proto_prefix">juce.AffineTransform</span>.mat12</a></td> | |||
<td class="summary">Matrix [1] [2]</td> | |||
</tr> | |||
</table> | |||
<h2><a href="#Predefined_values">Predefined values</a></h2> | |||
<table class="function_list"> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AffineTransform.identity"><span class="proto_prefix">juce.AffineTransform</span>.identity</a></td> | |||
<td class="summary">Identity.</td> | |||
</tr> | |||
</table> | |||
<br/> | |||
<br/> | |||
<h2><a name="Constructors"></a>Constructors</h2> | |||
<dl class="function"> | |||
<dt> | |||
<a name = "juce.AffineTransform.AffineTransform"></a> | |||
<strong><span class="proto_prefix">juce</span>.AffineTransform (mat00, mat01, mat02, mat10, mat11, mat12)</strong> | |||
</dt> | |||
<dd> | |||
<p>Constuctor. | |||
parameters thusly define a transformation matrix :</p> | |||
<pre><code>(mat00 mat01 mat02) | |||
(mat10 mat11 mat12) | |||
(0 0 1) | |||
</code></pre> | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">mat00</span> | |||
</li> | |||
<li><span class="parameter">mat01</span> | |||
</li> | |||
<li><span class="parameter">mat02</span> | |||
</li> | |||
<li><span class="parameter">mat10</span> | |||
</li> | |||
<li><span class="parameter">mat11</span> | |||
</li> | |||
<li><span class="parameter">mat12</span> | |||
</li> | |||
</ul> | |||
</dd> | |||
</dl> | |||
<h2><a name="Methods"></a>Methods</h2> | |||
<dl class="function"> | |||
<dt> | |||
<a name = "juce.AffineTransform:translated"></a> | |||
<strong><span class="proto_prefix">juce.AffineTransform</span>:translated (dx, dy)</strong> | |||
</dt> | |||
<dd> | |||
Translated. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">dx</span> | |||
the horizontal offset | |||
</li> | |||
<li><span class="parameter">dy</span> | |||
the vertical offset | |||
</li> | |||
</ul> | |||
<h3>Returns:</h3> | |||
<ol> | |||
a translated version of this transform | |||
</ol> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AffineTransform:rotated"></a> | |||
<strong><span class="proto_prefix">juce.AffineTransform</span>:rotated (rad)</strong> | |||
</dt> | |||
<dd> | |||
Rotated. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">rad</span> | |||
the degree of rotation in radians | |||
</li> | |||
</ul> | |||
<h3>Returns:</h3> | |||
<ol> | |||
a rotated version of this transform | |||
</ol> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AffineTransform:scaled"></a> | |||
<strong><span class="proto_prefix">juce.AffineTransform</span>:scaled (scaleX[, scaleY=scaleX])</strong> | |||
</dt> | |||
<dd> | |||
Scaled. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">scaleX</span> | |||
</li> | |||
<li><span class="parameter">scaleY</span> | |||
(<em>default</em> scaleX) | |||
</li> | |||
</ul> | |||
<h3>Returns:</h3> | |||
<ol> | |||
a scaled version of this transform | |||
</ol> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AffineTransform:followedBy"></a> | |||
<strong><span class="proto_prefix">juce.AffineTransform</span>:followedBy (other)</strong> | |||
</dt> | |||
<dd> | |||
Followed by. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">other</span> | |||
</li> | |||
</ul> | |||
<h3>Returns:</h3> | |||
<ol> | |||
a version of this transform followed by another | |||
</ol> | |||
</dd> | |||
</dl> | |||
<h2><a name="Fields"></a>Fields</h2> | |||
<dl class="function"> | |||
<dt> | |||
<a name = "juce.AffineTransform.mat00"></a> | |||
<strong><span class="proto_prefix">juce.AffineTransform</span>.mat00</strong> | |||
</dt> | |||
<dd> | |||
Matrix [0] [0] | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AffineTransform.mat01"></a> | |||
<strong><span class="proto_prefix">juce.AffineTransform</span>.mat01</strong> | |||
</dt> | |||
<dd> | |||
Matrix [0] [1] | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AffineTransform.mat02"></a> | |||
<strong><span class="proto_prefix">juce.AffineTransform</span>.mat02</strong> | |||
</dt> | |||
<dd> | |||
Matrix [0] [2] | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AffineTransform.mat10"></a> | |||
<strong><span class="proto_prefix">juce.AffineTransform</span>.mat10</strong> | |||
</dt> | |||
<dd> | |||
Matrix [1] [0] | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AffineTransform.mat11"></a> | |||
<strong><span class="proto_prefix">juce.AffineTransform</span>.mat11</strong> | |||
</dt> | |||
<dd> | |||
Matrix [1] [1] | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AffineTransform.mat12"></a> | |||
<strong><span class="proto_prefix">juce.AffineTransform</span>.mat12</strong> | |||
</dt> | |||
<dd> | |||
Matrix [1] [2] | |||
</ul> | |||
</dd> | |||
</dl> | |||
<h2><a name="Predefined_values"></a>Predefined values</h2> | |||
<dl class="function"> | |||
<dt> | |||
<a name = "juce.AffineTransform.identity"></a> | |||
<strong><span class="proto_prefix">juce.AffineTransform</span>.identity</strong> | |||
</dt> | |||
<dd> | |||
Identity. | |||
The non-transform. | |||
</ul> | |||
</dd> | |||
</dl> | |||
</div> <!-- id="content" --> | |||
</div> <!-- id="main" --> | |||
<div id="about"> | |||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i> | |||
</div> <!-- id="about" --> | |||
</div> <!-- id="container" --> | |||
</body> | |||
</html> |
@@ -0,0 +1,389 @@ | |||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | |||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | |||
<html> | |||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> | |||
<head> | |||
<title>protoplug: Class juce.AudioFormatReader</title> | |||
<link rel="stylesheet" href="../ldoc.css" type="text/css" /> | |||
</head> | |||
<body> | |||
<div id="container"> | |||
<div id="product"> | |||
<div id="product_logo"></div> | |||
<div id="product_name"><big><b></b></big></div> | |||
<div id="product_description"></div> | |||
</div> <!-- id="product" --> | |||
<div id="main"> | |||
<!-- Menu --> | |||
<div id="navigation"> | |||
<a href="http://osar.fr"> | |||
<div class=osarlogo> </div> | |||
</a> | |||
<br/> | |||
<a href="http://osar.fr/protoplug"> | |||
<h1>protoplug</h1> | |||
</a> | |||
<span class="proto_subtitle">Lua API reference</span> | |||
<ul> | |||
<li><a href="../index.html">Index</a></li> | |||
</ul> | |||
<h2>Contents</h2> | |||
<ul> | |||
<li><a href="#Constructors">Constructors</a></li> | |||
<li><a href="#Methods">Methods</a></li> | |||
<li><a href="#Fields">Fields</a></li> | |||
</ul> | |||
<h2>Classes</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../classes/juce.AffineTransform.html">juce.AffineTransform</a></li> | |||
<li><strong>juce.AudioFormatReader</strong></li> | |||
<li><a href="../classes/juce.Colour.html">juce.Colour</a></li> | |||
<li><a href="../classes/juce.ColourGradient.html">juce.ColourGradient</a></li> | |||
<li><a href="../classes/juce.Component.html">juce.Component</a></li> | |||
<li><a href="../classes/juce.FillType.html">juce.FillType</a></li> | |||
<li><a href="../classes/juce.Font.html">juce.Font</a></li> | |||
<li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li> | |||
<li><a href="../classes/juce.Image.html">juce.Image</a></li> | |||
<li><a href="../classes/juce.Justification.html">juce.Justification</a></li> | |||
<li><a href="../classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></li> | |||
<li><a href="../classes/juce.Line.html">juce.Line</a></li> | |||
<li><a href="../classes/juce.Path.html">juce.Path</a></li> | |||
<li><a href="../classes/juce.Point.html">juce.Point</a></li> | |||
<li><a href="../classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></li> | |||
<li><a href="../classes/juce.Rectangle_float.html">juce.Rectangle_float</a></li> | |||
<li><a href="../classes/juce.Rectangle_int.html">juce.Rectangle_int</a></li> | |||
</ul> | |||
<h2>Modules</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../modules/plugin.html">plugin</a></li> | |||
<li><a href="../modules/script.html">script</a></li> | |||
<li><a href="../modules/midi.html">midi</a></li> | |||
<li><a href="../modules/gui.html">gui</a></li> | |||
<li><a href="../modules/polyGen.html">polyGen</a></li> | |||
<li><a href="../modules/stereoFx.html">stereoFx</a></li> | |||
</ul> | |||
<h2>Examples</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../examples/classic-filter.lua.html">classic-filter.lua</a></li> | |||
<li><a href="../examples/sine-organ.lua.html">sine-organ.lua</a></li> | |||
<li><a href="../examples/midi-chordify.lua.html">midi-chordify.lua</a></li> | |||
<li><a href="../examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></li> | |||
<li><a href="../examples/soundfile-test.lua.html">soundfile-test.lua</a></li> | |||
</ul> | |||
</div> | |||
<div id="content"> | |||
<h1>Class <code>juce.AudioFormatReader</code></h1> | |||
<p>Class to read audio files.</p> | |||
<p> Example usage: <a href="../examples/soundfile-test.lua.html#">soundfile-test.lua</a>.</p> | |||
<p> Reads the formats that JUCE supports, namely: WAV, AIFF, Flac, Ogg-Vorbis, Windows Media codecs, | |||
CoreAudio codecs, MP3. </p> | |||
<p> Is a pointer to a <a href="http://www.juce.com/api/classAudioFormatReader.html">JUCE AudioFormatReader</a>, | |||
and wraps some <a href="http://www.juce.com/api/classAudioFormatManager.html">AudioFormatManager</a> | |||
functionality. </p> | |||
<h2><a href="#Constructors">Constructors</a></h2> | |||
<table class="function_list"> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AudioFormatReader.AudioFormatReader"><span class="proto_prefix">juce</span>.AudioFormatReader (filename)</a></td> | |||
<td class="summary">Load a sound file as an AudioFormatReader.</td> | |||
</tr> | |||
</table> | |||
<h2><a href="#Methods">Methods</a></h2> | |||
<table class="function_list"> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AudioFormatReader:read"><span class="wrapman"><span class="proto_prefix">juce.AudioFormatReader</span>:read<br> (destSamples, numDestChannels, startSampleInSource, numSamplesToRead[, fillLeftoverChannelsWithCopies=true])</span></a></td> | |||
<td class="summary">Read samples.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AudioFormatReader:readToFloat"><span class="proto_prefix">juce.AudioFormatReader</span>:readToFloat<br> ([nChannels=2[, resample=true]])</a></td> | |||
<td class="summary">Read entire wave to float array.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AudioFormatReader:readToDouble"><span class="proto_prefix">juce.AudioFormatReader</span>:readToDouble<br> ([nChannels=2[, resample=true]])</a></td> | |||
<td class="summary">Read entire wave to double array.</td> | |||
</tr> | |||
</table> | |||
<h2><a href="#Fields">Fields</a></h2> | |||
<table class="function_list"> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AudioFormatReader.sampleRate"><span class="proto_prefix">juce.AudioFormatReader</span>.sampleRate</a></td> | |||
<td class="summary">Sample rate</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AudioFormatReader.bitsPerSample"><span class="proto_prefix">juce.AudioFormatReader</span>.bitsPerSample</a></td> | |||
<td class="summary">Bits per sample</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AudioFormatReader.lengthInSamples"><span class="proto_prefix">juce.AudioFormatReader</span>.lengthInSamples</a></td> | |||
<td class="summary">Length in samples</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AudioFormatReader.numChannels"><span class="proto_prefix">juce.AudioFormatReader</span>.numChannels</a></td> | |||
<td class="summary">Number of channels</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.AudioFormatReader.usesFloatingPointData"><span class="proto_prefix">juce.AudioFormatReader</span>.usesFloatingPointData</a></td> | |||
<td class="summary">Uses floating point data (boolean)</td> | |||
</tr> | |||
</table> | |||
<br/> | |||
<br/> | |||
<h2><a name="Constructors"></a>Constructors</h2> | |||
<dl class="function"> | |||
<dt> | |||
<a name = "juce.AudioFormatReader.AudioFormatReader"></a> | |||
<strong><span class="proto_prefix">juce</span>.AudioFormatReader (filename)</strong> | |||
</dt> | |||
<dd> | |||
Load a sound file as an AudioFormatReader. | |||
The path can be absolute or relative to the protoplug directory. | |||
Returns <code>nil</code> if unsuccessful. The file will remain open until the | |||
AudioFormatReader is unset or otherwise garbage-collected. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">filename</span> | |||
</li> | |||
</ul> | |||
</dd> | |||
</dl> | |||
<h2><a name="Methods"></a>Methods</h2> | |||
<dl class="function"> | |||
<dt> | |||
<a name = "juce.AudioFormatReader:read"></a> | |||
<strong><span class="wrapman"><span class="proto_prefix">juce.AudioFormatReader</span>:read<br> (destSamples, numDestChannels, startSampleInSource, numSamplesToRead[, fillLeftoverChannelsWithCopies=true])</span></strong> | |||
</dt> | |||
<dd> | |||
Read samples. <br/> | |||
Copies a number of samples from the file into the provided array. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">destSamples</span> | |||
a cdata array of pointers to buffers for each channel (<code>int * const *</code>) | |||
</li> | |||
<li><span class="parameter">numDestChannels</span> | |||
the number of elements in <code>destSamples</code> | |||
</li> | |||
<li><span class="parameter">startSampleInSource</span> | |||
</li> | |||
<li><span class="parameter">numSamplesToRead</span> | |||
</li> | |||
<li><span class="parameter">fillLeftoverChannelsWithCopies</span> | |||
<span class="types"><span class="type">boolean</span></span> | |||
used if <code>destSamples</code> has more channels than the source. | |||
(<em>default</em> true) | |||
</li> | |||
</ul> | |||
<h3>Returns:</h3> | |||
<ol> | |||
<span class="types"><span class="type">boolean</span></span> | |||
success | |||
</ol> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AudioFormatReader:readToFloat"></a> | |||
<strong><span class="proto_prefix">juce.AudioFormatReader</span>:readToFloat<br> ([nChannels=2[, resample=true]])</strong> | |||
</dt> | |||
<dd> | |||
Read entire wave to float array. <br/> | |||
A simplified wrapper function for <a href="../classes/juce.AudioFormatReader.html#juce.AudioFormatReader:read">read</a> | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">nChannels</span> | |||
number of channels to be returned | |||
(<em>default</em> 2) | |||
</li> | |||
<li><span class="parameter">resample</span> | |||
whether to perform samplerate conversion to match the host's sample rate. | |||
If <code>true</code>, the length of the returned array may not be the wave's original <a href="../classes/juce.AudioFormatReader.html#juce.AudioFormatReader.lengthInSamples">lengthInSamples</a> . | |||
It will be given by the second returned value. | |||
(<em>default</em> true) | |||
</li> | |||
</ul> | |||
<h3>Returns:</h3> | |||
<ol> | |||
<li> | |||
a two-dimensional cdata array of channels containing samples (<code>float [nChannels][nSamples]</code>)</li> | |||
<li> | |||
the number of samples in each channel of the returned array</li> | |||
</ol> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AudioFormatReader:readToDouble"></a> | |||
<strong><span class="proto_prefix">juce.AudioFormatReader</span>:readToDouble<br> ([nChannels=2[, resample=true]])</strong> | |||
</dt> | |||
<dd> | |||
Read entire wave to double array. <br/> | |||
This wraps <a href="../classes/juce.AudioFormatReader.html#juce.AudioFormatReader:readToFloat">readToFloat</a> and returns an array containing <code>double</code>-precision numbers. | |||
This takes twice as much space, but it may be faster to use, as this is the native Lua type. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">nChannels</span> | |||
number of channels to be returned | |||
(<em>default</em> 2) | |||
</li> | |||
<li><span class="parameter">resample</span> | |||
whether to perform samplerate conversion to match the host's sample rate. | |||
If <code>true</code>, the length of the returned array may not be the wave's original <a href="../classes/juce.AudioFormatReader.html#juce.AudioFormatReader.lengthInSamples">lengthInSamples</a> . | |||
It will be given by the second returned value. | |||
(<em>default</em> true) | |||
</li> | |||
</ul> | |||
<h3>Returns:</h3> | |||
<ol> | |||
<li> | |||
a two-dimensional cdata array of channels containing samples (<code>double [nChannels][nSamples]</code>)</li> | |||
<li> | |||
the number of samples in each channel of the returned array</li> | |||
</ol> | |||
</dd> | |||
</dl> | |||
<h2><a name="Fields"></a>Fields</h2> | |||
<dl class="function"> | |||
<dt> | |||
<a name = "juce.AudioFormatReader.sampleRate"></a> | |||
<strong><span class="proto_prefix">juce.AudioFormatReader</span>.sampleRate</strong> | |||
</dt> | |||
<dd> | |||
Sample rate | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AudioFormatReader.bitsPerSample"></a> | |||
<strong><span class="proto_prefix">juce.AudioFormatReader</span>.bitsPerSample</strong> | |||
</dt> | |||
<dd> | |||
Bits per sample | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AudioFormatReader.lengthInSamples"></a> | |||
<strong><span class="proto_prefix">juce.AudioFormatReader</span>.lengthInSamples</strong> | |||
</dt> | |||
<dd> | |||
Length in samples | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AudioFormatReader.numChannels"></a> | |||
<strong><span class="proto_prefix">juce.AudioFormatReader</span>.numChannels</strong> | |||
</dt> | |||
<dd> | |||
Number of channels | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.AudioFormatReader.usesFloatingPointData"></a> | |||
<strong><span class="proto_prefix">juce.AudioFormatReader</span>.usesFloatingPointData</strong> | |||
</dt> | |||
<dd> | |||
Uses floating point data (boolean) | |||
</ul> | |||
</dd> | |||
</dl> | |||
</div> <!-- id="content" --> | |||
</div> <!-- id="main" --> | |||
<div id="about"> | |||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i> | |||
</div> <!-- id="about" --> | |||
</div> <!-- id="container" --> | |||
</body> | |||
</html> |
@@ -0,0 +1,381 @@ | |||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | |||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | |||
<html> | |||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> | |||
<head> | |||
<title>protoplug: Class juce.Colour</title> | |||
<link rel="stylesheet" href="../ldoc.css" type="text/css" /> | |||
</head> | |||
<body> | |||
<div id="container"> | |||
<div id="product"> | |||
<div id="product_logo"></div> | |||
<div id="product_name"><big><b></b></big></div> | |||
<div id="product_description"></div> | |||
</div> <!-- id="product" --> | |||
<div id="main"> | |||
<!-- Menu --> | |||
<div id="navigation"> | |||
<a href="http://osar.fr"> | |||
<div class=osarlogo> </div> | |||
</a> | |||
<br/> | |||
<a href="http://osar.fr/protoplug"> | |||
<h1>protoplug</h1> | |||
</a> | |||
<span class="proto_subtitle">Lua API reference</span> | |||
<ul> | |||
<li><a href="../index.html">Index</a></li> | |||
</ul> | |||
<h2>Contents</h2> | |||
<ul> | |||
<li><a href="#Constructors">Constructors</a></li> | |||
<li><a href="#Fields">Fields</a></li> | |||
<li><a href="#Predefined_values">Predefined values</a></li> | |||
</ul> | |||
<h2>Classes</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../classes/juce.AffineTransform.html">juce.AffineTransform</a></li> | |||
<li><a href="../classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></li> | |||
<li><strong>juce.Colour</strong></li> | |||
<li><a href="../classes/juce.ColourGradient.html">juce.ColourGradient</a></li> | |||
<li><a href="../classes/juce.Component.html">juce.Component</a></li> | |||
<li><a href="../classes/juce.FillType.html">juce.FillType</a></li> | |||
<li><a href="../classes/juce.Font.html">juce.Font</a></li> | |||
<li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li> | |||
<li><a href="../classes/juce.Image.html">juce.Image</a></li> | |||
<li><a href="../classes/juce.Justification.html">juce.Justification</a></li> | |||
<li><a href="../classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></li> | |||
<li><a href="../classes/juce.Line.html">juce.Line</a></li> | |||
<li><a href="../classes/juce.Path.html">juce.Path</a></li> | |||
<li><a href="../classes/juce.Point.html">juce.Point</a></li> | |||
<li><a href="../classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></li> | |||
<li><a href="../classes/juce.Rectangle_float.html">juce.Rectangle_float</a></li> | |||
<li><a href="../classes/juce.Rectangle_int.html">juce.Rectangle_int</a></li> | |||
</ul> | |||
<h2>Modules</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../modules/plugin.html">plugin</a></li> | |||
<li><a href="../modules/script.html">script</a></li> | |||
<li><a href="../modules/midi.html">midi</a></li> | |||
<li><a href="../modules/gui.html">gui</a></li> | |||
<li><a href="../modules/polyGen.html">polyGen</a></li> | |||
<li><a href="../modules/stereoFx.html">stereoFx</a></li> | |||
</ul> | |||
<h2>Examples</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../examples/classic-filter.lua.html">classic-filter.lua</a></li> | |||
<li><a href="../examples/sine-organ.lua.html">sine-organ.lua</a></li> | |||
<li><a href="../examples/midi-chordify.lua.html">midi-chordify.lua</a></li> | |||
<li><a href="../examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></li> | |||
<li><a href="../examples/soundfile-test.lua.html">soundfile-test.lua</a></li> | |||
</ul> | |||
</div> | |||
<div id="content"> | |||
<h1>Class <code>juce.Colour</code></h1> | |||
<p>A simple colour class.</p> | |||
<p> Is converted to a <a href="http://www.juce.com/api/classColour.html">JUCE Colour</a></p> | |||
<h2><a href="#Constructors">Constructors</a></h2> | |||
<table class="function_list"> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Colour.Colour"><span class="proto_prefix">juce</span>.Colour (r, g, b[, a])</a></td> | |||
<td class="summary">Constuctor with classical arguments.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Colour.Colour"><span class="proto_prefix">juce</span>.Colour (args)</a></td> | |||
<td class="summary">Constuctor with named arguments.</td> | |||
</tr> | |||
</table> | |||
<h2><a href="#Fields">Fields</a></h2> | |||
<table class="function_list"> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Colour.r"><span class="proto_prefix">juce.Colour</span>.r</a></td> | |||
<td class="summary">Red (0-255)</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Colour.g"><span class="proto_prefix">juce.Colour</span>.g</a></td> | |||
<td class="summary">Green (0-255)</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Colour.b"><span class="proto_prefix">juce.Colour</span>.b</a></td> | |||
<td class="summary">Blue (0-255)</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Colour.a"><span class="proto_prefix">juce.Colour</span>.a</a></td> | |||
<td class="summary">Alpha (0-255)</td> | |||
</tr> | |||
</table> | |||
<h2><a href="#Predefined_values">Predefined values</a></h2> | |||
<table class="function_list"> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Colour.black"><span class="proto_prefix">juce.Colour</span>.black</a></td> | |||
<td class="summary"> | |||
</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Colour.white"><span class="proto_prefix">juce.Colour</span>.white</a></td> | |||
<td class="summary"> | |||
</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Colour.red"><span class="proto_prefix">juce.Colour</span>.red</a></td> | |||
<td class="summary"> | |||
</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Colour.green"><span class="proto_prefix">juce.Colour</span>.green</a></td> | |||
<td class="summary"> | |||
</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Colour.blue"><span class="proto_prefix">juce.Colour</span>.blue</a></td> | |||
<td class="summary"> | |||
</td> | |||
</tr> | |||
</table> | |||
<br/> | |||
<br/> | |||
<h2><a name="Constructors"></a>Constructors</h2> | |||
<dl class="function"> | |||
<dt> | |||
<a name = "juce.Colour.Colour"></a> | |||
<strong><span class="proto_prefix">juce</span>.Colour (r, g, b[, a])</strong> | |||
</dt> | |||
<dd> | |||
Constuctor with classical arguments. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">r</span> | |||
red | |||
</li> | |||
<li><span class="parameter">g</span> | |||
green | |||
</li> | |||
<li><span class="parameter">b</span> | |||
blue | |||
</li> | |||
<li><span class="parameter">a</span> | |||
alpha | |||
</li> | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.Colour.Colour"></a> | |||
<strong><span class="proto_prefix">juce</span>.Colour (args)</strong> | |||
</dt> | |||
<dd> | |||
Constuctor with named arguments. | |||
Every field is optional. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">args</span> | |||
<ul> | |||
<li><span class="parameter">r</span> | |||
red | |||
</li> | |||
<li><span class="parameter">g</span> | |||
green | |||
</li> | |||
<li><span class="parameter">b</span> | |||
blue, | |||
</li> | |||
<li><span class="parameter">a</span> | |||
alpha | |||
</li> | |||
</li></ul> | |||
</ul> | |||
</dd> | |||
</dl> | |||
<h2><a name="Fields"></a>Fields</h2> | |||
<dl class="function"> | |||
<dt> | |||
<a name = "juce.Colour.r"></a> | |||
<strong><span class="proto_prefix">juce.Colour</span>.r</strong> | |||
</dt> | |||
<dd> | |||
Red (0-255) | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.Colour.g"></a> | |||
<strong><span class="proto_prefix">juce.Colour</span>.g</strong> | |||
</dt> | |||
<dd> | |||
Green (0-255) | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.Colour.b"></a> | |||
<strong><span class="proto_prefix">juce.Colour</span>.b</strong> | |||
</dt> | |||
<dd> | |||
Blue (0-255) | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.Colour.a"></a> | |||
<strong><span class="proto_prefix">juce.Colour</span>.a</strong> | |||
</dt> | |||
<dd> | |||
Alpha (0-255) | |||
</ul> | |||
</dd> | |||
</dl> | |||
<h2><a name="Predefined_values"></a>Predefined values</h2> | |||
<dl class="function"> | |||
<dt> | |||
<a name = "juce.Colour.black"></a> | |||
<strong><span class="proto_prefix">juce.Colour</span>.black</strong> | |||
</dt> | |||
<dd> | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.Colour.white"></a> | |||
<strong><span class="proto_prefix">juce.Colour</span>.white</strong> | |||
</dt> | |||
<dd> | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.Colour.red"></a> | |||
<strong><span class="proto_prefix">juce.Colour</span>.red</strong> | |||
</dt> | |||
<dd> | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.Colour.green"></a> | |||
<strong><span class="proto_prefix">juce.Colour</span>.green</strong> | |||
</dt> | |||
<dd> | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.Colour.blue"></a> | |||
<strong><span class="proto_prefix">juce.Colour</span>.blue</strong> | |||
</dt> | |||
<dd> | |||
</ul> | |||
</dd> | |||
</dl> | |||
</div> <!-- id="content" --> | |||
</div> <!-- id="main" --> | |||
<div id="about"> | |||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i> | |||
</div> <!-- id="about" --> | |||
</div> <!-- id="container" --> | |||
</body> | |||
</html> |
@@ -0,0 +1,371 @@ | |||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | |||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | |||
<html> | |||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> | |||
<head> | |||
<title>protoplug: Class juce.ColourGradient</title> | |||
<link rel="stylesheet" href="../ldoc.css" type="text/css" /> | |||
</head> | |||
<body> | |||
<div id="container"> | |||
<div id="product"> | |||
<div id="product_logo"></div> | |||
<div id="product_name"><big><b></b></big></div> | |||
<div id="product_description"></div> | |||
</div> <!-- id="product" --> | |||
<div id="main"> | |||
<!-- Menu --> | |||
<div id="navigation"> | |||
<a href="http://osar.fr"> | |||
<div class=osarlogo> </div> | |||
</a> | |||
<br/> | |||
<a href="http://osar.fr/protoplug"> | |||
<h1>protoplug</h1> | |||
</a> | |||
<span class="proto_subtitle">Lua API reference</span> | |||
<ul> | |||
<li><a href="../index.html">Index</a></li> | |||
</ul> | |||
<h2>Contents</h2> | |||
<ul> | |||
<li><a href="#Constructors">Constructors</a></li> | |||
<li><a href="#Methods">Methods</a></li> | |||
</ul> | |||
<h2>Classes</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../classes/juce.AffineTransform.html">juce.AffineTransform</a></li> | |||
<li><a href="../classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></li> | |||
<li><a href="../classes/juce.Colour.html">juce.Colour</a></li> | |||
<li><strong>juce.ColourGradient</strong></li> | |||
<li><a href="../classes/juce.Component.html">juce.Component</a></li> | |||
<li><a href="../classes/juce.FillType.html">juce.FillType</a></li> | |||
<li><a href="../classes/juce.Font.html">juce.Font</a></li> | |||
<li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li> | |||
<li><a href="../classes/juce.Image.html">juce.Image</a></li> | |||
<li><a href="../classes/juce.Justification.html">juce.Justification</a></li> | |||
<li><a href="../classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></li> | |||
<li><a href="../classes/juce.Line.html">juce.Line</a></li> | |||
<li><a href="../classes/juce.Path.html">juce.Path</a></li> | |||
<li><a href="../classes/juce.Point.html">juce.Point</a></li> | |||
<li><a href="../classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></li> | |||
<li><a href="../classes/juce.Rectangle_float.html">juce.Rectangle_float</a></li> | |||
<li><a href="../classes/juce.Rectangle_int.html">juce.Rectangle_int</a></li> | |||
</ul> | |||
<h2>Modules</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../modules/plugin.html">plugin</a></li> | |||
<li><a href="../modules/script.html">script</a></li> | |||
<li><a href="../modules/midi.html">midi</a></li> | |||
<li><a href="../modules/gui.html">gui</a></li> | |||
<li><a href="../modules/polyGen.html">polyGen</a></li> | |||
<li><a href="../modules/stereoFx.html">stereoFx</a></li> | |||
</ul> | |||
<h2>Examples</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../examples/classic-filter.lua.html">classic-filter.lua</a></li> | |||
<li><a href="../examples/sine-organ.lua.html">sine-organ.lua</a></li> | |||
<li><a href="../examples/midi-chordify.lua.html">midi-chordify.lua</a></li> | |||
<li><a href="../examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></li> | |||
<li><a href="../examples/soundfile-test.lua.html">soundfile-test.lua</a></li> | |||
</ul> | |||
</div> | |||
<div id="content"> | |||
<h1>Class <code>juce.ColourGradient</code></h1> | |||
<p>Colour Gradient.</p> | |||
<p> Is a pointer to a <a href="http://www.juce.com/api/classColourGradient.html">JUCE ColourGradient</a></p> | |||
<h2><a href="#Constructors">Constructors</a></h2> | |||
<table class="function_list"> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.ColourGradient.Colour"><span class="proto_prefix">juce</span>.ColourGradient (colour1, x1, y1, colour2, x2, y2, isRadial)</a></td> | |||
<td class="summary">Constuctor.</td> | |||
</tr> | |||
</table> | |||
<h2><a href="#Methods">Methods</a></h2> | |||
<table class="function_list"> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.ColourGradient:addColour"><span class="proto_prefix">juce.ColourGradient</span>:addColour<br> (proportionAlongGradient, colour)</a></td> | |||
<td class="summary">Add colour.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.ColourGradient:removeColour"><span class="proto_prefix">juce.ColourGradient</span>:removeColour (index)</a></td> | |||
<td class="summary">Remove colour.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.ColourGradient:multiplyOpacity"><span class="proto_prefix">juce.ColourGradient</span>:multiplyOpacity (multiplier)</a></td> | |||
<td class="summary">Multiply opacity.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.ColourGradient:getNumColours"><span class="proto_prefix">juce.ColourGradient</span>:getNumColours ()</a></td> | |||
<td class="summary">Get number colour.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.ColourGradient:getColour"><span class="proto_prefix">juce.ColourGradient</span>:getColour (index)</a></td> | |||
<td class="summary">Get colour.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.ColourGradient:setColour"><span class="proto_prefix">juce.ColourGradient</span>:setColour (index, newColour)</a></td> | |||
<td class="summary">Get colour.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.ColourGradient:getColourAtPosition"><span class="proto_prefix">juce.ColourGradient</span>:getColourAtPosition (position)</a></td> | |||
<td class="summary">Get interpolated colour</td> | |||
</tr> | |||
</table> | |||
<br/> | |||
<br/> | |||
<h2><a name="Constructors"></a>Constructors</h2> | |||
<dl class="function"> | |||
<dt> | |||
<a name = "juce.ColourGradient.Colour"></a> | |||
<strong><span class="proto_prefix">juce</span>.ColourGradient (colour1, x1, y1, colour2, x2, y2, isRadial)</strong> | |||
</dt> | |||
<dd> | |||
Constuctor. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">colour1</span> | |||
<span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span> | |||
colour at the beginning of the gradient | |||
</li> | |||
<li><span class="parameter">x1</span> | |||
coordinates of colour1 | |||
</li> | |||
<li><span class="parameter">y1</span> | |||
coordinates of colour1 | |||
</li> | |||
<li><span class="parameter">colour2</span> | |||
<span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span> | |||
colour at the end of the gradient | |||
</li> | |||
<li><span class="parameter">x2</span> | |||
coordinates of colour2 | |||
</li> | |||
<li><span class="parameter">y2</span> | |||
coordinates of colour2 | |||
</li> | |||
<li><span class="parameter">isRadial</span> | |||
<span class="types"><span class="type">boolean</span></span> | |||
whether the gradient should be linear or radial | |||
</li> | |||
</ul> | |||
</dd> | |||
</dl> | |||
<h2><a name="Methods"></a>Methods</h2> | |||
<dl class="function"> | |||
<dt> | |||
<a name = "juce.ColourGradient:addColour"></a> | |||
<strong><span class="proto_prefix">juce.ColourGradient</span>:addColour<br> (proportionAlongGradient, colour)</strong> | |||
</dt> | |||
<dd> | |||
Add colour. | |||
Any number of colours can be added between the start and end of the gradient. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">proportionAlongGradient</span> | |||
</li> | |||
<li><span class="parameter">colour</span> | |||
<span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span> | |||
</li> | |||
</ul> | |||
<h3>Returns:</h3> | |||
<ol> | |||
the new colour's index | |||
</ol> | |||
</dd> | |||
<dt> | |||
<a name = "juce.ColourGradient:removeColour"></a> | |||
<strong><span class="proto_prefix">juce.ColourGradient</span>:removeColour (index)</strong> | |||
</dt> | |||
<dd> | |||
Remove colour. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">index</span> | |||
colour index between 0 and getNumColours() - 1 | |||
</li> | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.ColourGradient:multiplyOpacity"></a> | |||
<strong><span class="proto_prefix">juce.ColourGradient</span>:multiplyOpacity (multiplier)</strong> | |||
</dt> | |||
<dd> | |||
Multiply opacity. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">multiplier</span> | |||
factor to multiply the alpha values by | |||
</li> | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.ColourGradient:getNumColours"></a> | |||
<strong><span class="proto_prefix">juce.ColourGradient</span>:getNumColours ()</strong> | |||
</dt> | |||
<dd> | |||
Get number colour. | |||
</ul> | |||
<h3>Returns:</h3> | |||
<ol> | |||
the number of colours | |||
</ol> | |||
</dd> | |||
<dt> | |||
<a name = "juce.ColourGradient:getColour"></a> | |||
<strong><span class="proto_prefix">juce.ColourGradient</span>:getColour (index)</strong> | |||
</dt> | |||
<dd> | |||
Get colour. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">index</span> | |||
colour index between 0 and getNumColours() - 1 | |||
</li> | |||
</ul> | |||
<h3>Returns:</h3> | |||
<ol> | |||
<span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span> | |||
the coulour at the specified index | |||
</ol> | |||
</dd> | |||
<dt> | |||
<a name = "juce.ColourGradient:setColour"></a> | |||
<strong><span class="proto_prefix">juce.ColourGradient</span>:setColour (index, newColour)</strong> | |||
</dt> | |||
<dd> | |||
Get colour. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">index</span> | |||
colour index between 0 and getNumColours() - 1 | |||
</li> | |||
<li><span class="parameter">newColour</span> | |||
<span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span> | |||
</li> | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.ColourGradient:getColourAtPosition"></a> | |||
<strong><span class="proto_prefix">juce.ColourGradient</span>:getColourAtPosition (position)</strong> | |||
</dt> | |||
<dd> | |||
Get interpolated colour | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">position</span> | |||
the position between 0 and 1 | |||
</li> | |||
</ul> | |||
<h3>Returns:</h3> | |||
<ol> | |||
<span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span> | |||
the interpolated colour at the specified position | |||
</ol> | |||
</dd> | |||
</dl> | |||
</div> <!-- id="content" --> | |||
</div> <!-- id="main" --> | |||
<div id="about"> | |||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i> | |||
</div> <!-- id="about" --> | |||
</div> <!-- id="container" --> | |||
</body> | |||
</html> |
@@ -0,0 +1,249 @@ | |||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | |||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | |||
<html> | |||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> | |||
<head> | |||
<title>protoplug: Class juce.Component</title> | |||
<link rel="stylesheet" href="../ldoc.css" type="text/css" /> | |||
</head> | |||
<body> | |||
<div id="container"> | |||
<div id="product"> | |||
<div id="product_logo"></div> | |||
<div id="product_name"><big><b></b></big></div> | |||
<div id="product_description"></div> | |||
</div> <!-- id="product" --> | |||
<div id="main"> | |||
<!-- Menu --> | |||
<div id="navigation"> | |||
<a href="http://osar.fr"> | |||
<div class=osarlogo> </div> | |||
</a> | |||
<br/> | |||
<a href="http://osar.fr/protoplug"> | |||
<h1>protoplug</h1> | |||
</a> | |||
<span class="proto_subtitle">Lua API reference</span> | |||
<ul> | |||
<li><a href="../index.html">Index</a></li> | |||
</ul> | |||
<h2>Contents</h2> | |||
<ul> | |||
<li><a href="#Methods">Methods</a></li> | |||
</ul> | |||
<h2>Classes</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../classes/juce.AffineTransform.html">juce.AffineTransform</a></li> | |||
<li><a href="../classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></li> | |||
<li><a href="../classes/juce.Colour.html">juce.Colour</a></li> | |||
<li><a href="../classes/juce.ColourGradient.html">juce.ColourGradient</a></li> | |||
<li><strong>juce.Component</strong></li> | |||
<li><a href="../classes/juce.FillType.html">juce.FillType</a></li> | |||
<li><a href="../classes/juce.Font.html">juce.Font</a></li> | |||
<li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li> | |||
<li><a href="../classes/juce.Image.html">juce.Image</a></li> | |||
<li><a href="../classes/juce.Justification.html">juce.Justification</a></li> | |||
<li><a href="../classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></li> | |||
<li><a href="../classes/juce.Line.html">juce.Line</a></li> | |||
<li><a href="../classes/juce.Path.html">juce.Path</a></li> | |||
<li><a href="../classes/juce.Point.html">juce.Point</a></li> | |||
<li><a href="../classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></li> | |||
<li><a href="../classes/juce.Rectangle_float.html">juce.Rectangle_float</a></li> | |||
<li><a href="../classes/juce.Rectangle_int.html">juce.Rectangle_int</a></li> | |||
</ul> | |||
<h2>Modules</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../modules/plugin.html">plugin</a></li> | |||
<li><a href="../modules/script.html">script</a></li> | |||
<li><a href="../modules/midi.html">midi</a></li> | |||
<li><a href="../modules/gui.html">gui</a></li> | |||
<li><a href="../modules/polyGen.html">polyGen</a></li> | |||
<li><a href="../modules/stereoFx.html">stereoFx</a></li> | |||
</ul> | |||
<h2>Examples</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../examples/classic-filter.lua.html">classic-filter.lua</a></li> | |||
<li><a href="../examples/sine-organ.lua.html">sine-organ.lua</a></li> | |||
<li><a href="../examples/midi-chordify.lua.html">midi-chordify.lua</a></li> | |||
<li><a href="../examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></li> | |||
<li><a href="../examples/soundfile-test.lua.html">soundfile-test.lua</a></li> | |||
</ul> | |||
</div> | |||
<div id="content"> | |||
<h1>Class <code>juce.Component</code></h1> | |||
<p>JUCE Component.</p> | |||
<p> Is a pointer to a <a href="http://www.juce.com/api/classComponent.html">JUCE Component</a></p> | |||
<p> As of now, components can't be created by protoplug scripts. This is mainly | |||
for accessing the custom GUI component using <a href="../modules/gui.html#getComponent">gui.getComponent</a>.</p> | |||
<h2><a href="#Methods">Methods</a></h2> | |||
<table class="function_list"> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Component:repaint"><span class="proto_prefix">juce.Component</span>:repaint ()</a></td> | |||
<td class="summary">Request total repaint.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Component:repaint"><span class="proto_prefix">juce.Component</span>:repaint (area)</a></td> | |||
<td class="summary">Request partial repaint.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Component:repaint"><span class="proto_prefix">juce.Component</span>:repaint (x, y, width, height)</a></td> | |||
<td class="summary">Request partial repaint.</td> | |||
</tr> | |||
<tr> | |||
<td class="name" nowrap><a href="#juce.Component:createComponentSnapshot"><span class="wrapman"><span class="proto_prefix">juce.Component</span>:createComponentSnapshot<br> (areaToGrab[, clipImageToComponentBounds=true[, scaleFactor=1]])</span></a></td> | |||
<td class="summary">Create component snapshot.</td> | |||
</tr> | |||
</table> | |||
<br/> | |||
<br/> | |||
<h2><a name="Methods"></a>Methods</h2> | |||
<dl class="function"> | |||
<dt> | |||
<a name = "juce.Component:repaint"></a> | |||
<strong><span class="proto_prefix">juce.Component</span>:repaint ()</strong> | |||
</dt> | |||
<dd> | |||
Request total repaint. | |||
Tell the operating system that the component is "dirty" and needs to be redrawn. | |||
The component's paint method will be called asynchronously (<a href="../modules/gui.html#paint">gui.paint</a>) | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.Component:repaint"></a> | |||
<strong><span class="proto_prefix">juce.Component</span>:repaint (area)</strong> | |||
</dt> | |||
<dd> | |||
Request partial repaint. | |||
Tell the operating system that a portion of the component is "dirty" and needs to be redrawn. | |||
The component's paint method will be called asynchronously (<a href="../modules/gui.html#paint">gui.paint</a>). The dirty region will be accessible | |||
with Graphics.getClipBounds(). | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">area</span> | |||
<span class="types"><span class="type">juce.Rectangle_int</span></span> | |||
the region needing the be redrawn | |||
</li> | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.Component:repaint"></a> | |||
<strong><span class="proto_prefix">juce.Component</span>:repaint (x, y, width, height)</strong> | |||
</dt> | |||
<dd> | |||
Request partial repaint. | |||
Tell the operating system that a portion of the component is "dirty" and needs to be redrawn. | |||
The component's paint method will be called asynchronously (<a href="../modules/gui.html#paint">gui.paint</a>). The dirty region will be accessible | |||
with Graphics.getClipBounds(). | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">x</span> | |||
the region needing the be redrawn | |||
</li> | |||
<li><span class="parameter">y</span> | |||
the region needing the be redrawn | |||
</li> | |||
<li><span class="parameter">width</span> | |||
the region needing the be redrawn | |||
</li> | |||
<li><span class="parameter">height</span> | |||
the region needing the be redrawn | |||
</li> | |||
</ul> | |||
</dd> | |||
<dt> | |||
<a name = "juce.Component:createComponentSnapshot"></a> | |||
<strong><span class="wrapman"><span class="proto_prefix">juce.Component</span>:createComponentSnapshot<br> (areaToGrab[, clipImageToComponentBounds=true[, scaleFactor=1]])</span></strong> | |||
</dt> | |||
<dd> | |||
Create component snapshot. | |||
Paint the component into a virtual buffer and return it as an image. | |||
</ul> | |||
<h3>Parameters:</h3> | |||
<ul> | |||
<li><span class="parameter">areaToGrab</span> | |||
<span class="types"><span class="type">juce.Rectangle_int</span></span> | |||
the region to the be drawn | |||
</li> | |||
<li><span class="parameter">clipImageToComponentBounds</span> | |||
(<em>default</em> true) | |||
</li> | |||
<li><span class="parameter">scaleFactor</span> | |||
(<em>default</em> 1) | |||
</li> | |||
</ul> | |||
<h3>Returns:</h3> | |||
<ol> | |||
<span class="types"><a class="type" href="../classes/juce.Image.html#">juce.Image</a></span> | |||
</ol> | |||
</dd> | |||
</dl> | |||
</div> <!-- id="content" --> | |||
</div> <!-- id="main" --> | |||
<div id="about"> | |||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i> | |||
</div> <!-- id="about" --> | |||
</div> <!-- id="container" --> | |||
</body> | |||
</html> |
@@ -0,0 +1,315 @@ | |||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | |||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | |||
<html> | |||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> | |||
<head> | |||
<title>protoplug: Class juce.FillType</title> | |||
<link rel="stylesheet" href="../ldoc.css" type="text/css" /> | |||
</head> | |||
<body> | |||
<div id="container"> | |||
<div id="product"> | |||
<div id="product_logo"></div> | |||
<div id="product_name"><big><b></b></big></div> | |||
<div id="product_description"></div> | |||
</div> <!-- id="product" --> | |||
<div id="main"> | |||
<!-- Menu --> | |||
<div id="navigation"> | |||
<a href="http://osar.fr"> | |||
<div class=osarlogo> </div> | |||
</a> | |||
<br/> | |||
<a href="http://osar.fr/protoplug"> | |||
<h1>protoplug</h1> | |||
</a> | |||
<span class="proto_subtitle">Lua API reference</span> | |||
<ul> | |||
<li><a href="../index.html">Index</a></li> | |||
</ul> | |||
<h2>Contents</h2> | |||
<ul> | |||
<li><a href="#Constructors">Constructors</a></li> | |||
<li><a href="#Methods">Methods</a></li> | |||
<li><a href="#Predefined_values">Predefined values</a></li> | |||
</ul> | |||
<h2>Classes</h2> | |||
<ul class="$(kind=='Topics' and '' or 'nowrap'"> | |||
<li><a href="../classes/juce.AffineTransform.html">juce.AffineTransform</a></li> | |||
<li><a href="../classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></li> | |||
<li><a href="../classes/juce.Colour.html">juce.Colour</a></li> | |||
<li><a href="../classes/juce.ColourGradient.html">juce.ColourGradient</a></li> | |||
<li><a href="../classes/juce.Component.html">juce.Component</a></li> | |||
<li><strong>juce.FillType</strong></li> | |||
<li><a href="../classes/juce.Font.html">juce.Font</a></li> | |||
<li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li> | |||
<li><a href="../classes/juce.Image.html">juce.Image</a></li> | |||
<li><a href="../classes/juce.Justification.html">juce.Justification</a></li> | |||
<li><a href="../cla |