469 changes: 469 additions & 0 deletions ports/protoplug/ProtoplugFiles/doc/classes/juce.AffineTransform.html
View file

Large diffs are not rendered by default.

389 changes: 389 additions & 0 deletions ports/protoplug/ProtoplugFiles/doc/classes/juce.AudioFormatReader.html
View file
@@ -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>
381 changes: 381 additions & 0 deletions ports/protoplug/ProtoplugFiles/doc/classes/juce.Colour.html
View file
@@ -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>
371 changes: 371 additions & 0 deletions ports/protoplug/ProtoplugFiles/doc/classes/juce.ColourGradient.html
View file
@@ -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>
249 changes: 249 additions & 0 deletions ports/protoplug/ProtoplugFiles/doc/classes/juce.Component.html
View file
@@ -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>
315 changes: 315 additions & 0 deletions ports/protoplug/ProtoplugFiles/doc/classes/juce.FillType.html
View file
@@ -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="../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.FillType</code></h1>
<p>Fill Type.</p>
<p> Is a pointer to a <a href="http://www.juce.com/api/classFillType.html">JUCE FillType</a>.
Can be used by <a href="../classes/juce.Graphics.html#">juce.Graphics</a> for fill operations.</p>


<h2><a href="#Constructors">Constructors</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#juce.FillType.FillType"><span class="proto_prefix">juce</span>.FillType (Colour)</a></td>
<td class="summary">Constuct from a <a href="../classes/juce.Colour.html#">juce.Colour</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#juce.FillType.FillType"><span class="proto_prefix">juce</span>.FillType (Gradient)</a></td>
<td class="summary">Constuct from a <a href="../classes/juce.ColourGradient.html#">juce.ColourGradient</a>.</td>
</tr>
</table>
<h2><a href="#Methods">Methods</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#juce.FillType:setOpacity"><span class="proto_prefix">juce.FillType</span>:setOpacity (newOpacity)</a></td>
<td class="summary">Set Overall Opacity.</td>
</tr>
</table>
<h2><a href="#Predefined_values">Predefined values</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#juce.FillType.black"><span class="proto_prefix">juce.FillType</span>.black</a></td>
<td class="summary">

</td>
</tr>
<tr>
<td class="name" nowrap><a href="#juce.FillType.white"><span class="proto_prefix">juce.FillType</span>.white</a></td>
<td class="summary">

</td>
</tr>
<tr>
<td class="name" nowrap><a href="#juce.FillType.red"><span class="proto_prefix">juce.FillType</span>.red</a></td>
<td class="summary">

</td>
</tr>
<tr>
<td class="name" nowrap><a href="#juce.FillType.green"><span class="proto_prefix">juce.FillType</span>.green</a></td>
<td class="summary">

</td>
</tr>
<tr>
<td class="name" nowrap><a href="#juce.FillType.blue"><span class="proto_prefix">juce.FillType</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.FillType.FillType"></a>
<strong><span class="proto_prefix">juce</span>.FillType (Colour)</strong>
</dt>
<dd>
Constuct from a <a href="../classes/juce.Colour.html#">juce.Colour</a>.

</ul>

<h3>Parameters:</h3>
<ul>
<li><span class="parameter">Colour</span>
<span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span>



</li>
</ul>





</dd>
<dt>
<a name = "juce.FillType.FillType"></a>
<strong><span class="proto_prefix">juce</span>.FillType (Gradient)</strong>
</dt>
<dd>
Constuct from a <a href="../classes/juce.ColourGradient.html#">juce.ColourGradient</a>.

</ul>

<h3>Parameters:</h3>
<ul>
<li><span class="parameter">Gradient</span>
<span class="types"><a class="type" href="../classes/juce.ColourGradient.html#">juce.ColourGradient</a></span>



</li>
</ul>





</dd>
</dl>
<h2><a name="Methods"></a>Methods</h2>
<dl class="function">
<dt>
<a name = "juce.FillType:setOpacity"></a>
<strong><span class="proto_prefix">juce.FillType</span>:setOpacity (newOpacity)</strong>
</dt>
<dd>
Set Overall Opacity.

</ul>

<h3>Parameters:</h3>
<ul>
<li><span class="parameter">newOpacity</span>



</li>
</ul>





</dd>
</dl>
<h2><a name="Predefined_values"></a>Predefined values</h2>
<dl class="function">
<dt>
<a name = "juce.FillType.black"></a>
<strong><span class="proto_prefix">juce.FillType</span>.black</strong>
</dt>
<dd>


</ul>






</dd>
<dt>
<a name = "juce.FillType.white"></a>
<strong><span class="proto_prefix">juce.FillType</span>.white</strong>
</dt>
<dd>


</ul>






</dd>
<dt>
<a name = "juce.FillType.red"></a>
<strong><span class="proto_prefix">juce.FillType</span>.red</strong>
</dt>
<dd>


</ul>






</dd>
<dt>
<a name = "juce.FillType.green"></a>
<strong><span class="proto_prefix">juce.FillType</span>.green</strong>
</dt>
<dd>


</ul>






</dd>
<dt>
<a name = "juce.FillType.blue"></a>
<strong><span class="proto_prefix">juce.FillType</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>
203 changes: 203 additions & 0 deletions ports/protoplug/ProtoplugFiles/doc/classes/juce.Font.html
View file
@@ -0,0 +1,203 @@
<!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.Font</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="#Tables">Tables</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><a href="../classes/juce.FillType.html">juce.FillType</a></li>
<li><strong>juce.Font</strong></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.Font</code></h1>
<p>Font.</p>
<p> Is a pointer to a <a href="http://www.juce.com/api/classFont.html">JUCE Font</a>.
Can be used by <a href="../classes/juce.Graphics.html#">juce.Graphics</a> for text operations.</p>


<h2><a href="#Constructors">Constructors</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#juce.Font.Font"><span class="proto_prefix">juce</span>.Font (typefaceName, fontHeight[, styleFlags=0[, hinted=false]])</a></td>
<td class="summary">Constuctor.</td>
</tr>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#juce.Font.styles"><span class="proto_prefix">juce.Font</span>.styles</a></td>
<td class="summary">Font styles.</td>
</tr>
</table>

<br/>
<br/>


<h2><a name="Constructors"></a>Constructors</h2>
<dl class="function">
<dt>
<a name = "juce.Font.Font"></a>
<strong><span class="proto_prefix">juce</span>.Font (typefaceName, fontHeight[, styleFlags=0[, hinted=false]])</strong>
</dt>
<dd>
Constuctor.
Caveat : on OSX and Linux, hinting only works for protoplug's
built-in hinted fonts (<code>DejaVu Sans Mono</code> and <code>Source Code Pro</code>). On
Windows it's available for every font. Cross-platform hinting is on the be
todo list.

</ul>

<h3>Parameters:</h3>
<ul>
<li><span class="parameter">typefaceName</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>



</li>
<li><span class="parameter">fontHeight</span>
<span class="types"><span class="type">number</span></span>



</li>
<li><span class="parameter">styleFlags</span>
any combination of <a href="../classes/juce.Font.html#juce.Font.styles">styles</a>
(<em>default</em> 0)
</li>
<li><span class="parameter">hinted</span>
<span class="types"><span class="type">bool</span></span>



(<em>default</em> false)
</li>
</ul>





</dd>
</dl>
<h2><a name="Tables"></a>Tables</h2>
<dl class="function">
<dt>
<a name = "juce.Font.styles"></a>
<strong><span class="proto_prefix">juce.Font</span>.styles</strong>
</dt>
<dd>
Font styles.

</ul>

<h3>Fields:</h3>
<ul>
<li><span class="parameter">plain</span>
<code>0</code>
</li>
<li><span class="parameter">bold</span>
<code>1</code>
</li>
<li><span class="parameter">italic</span>
<code>2</code>
</li>
<li><span class="parameter">underlined</span>
<code>4</code>
</li>
</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>
2,220 changes: 2,220 additions & 0 deletions ports/protoplug/ProtoplugFiles/doc/classes/juce.Graphics.html
View file

Large diffs are not rendered by default.

260 changes: 260 additions & 0 deletions ports/protoplug/ProtoplugFiles/doc/classes/juce.Image.html
View file
@@ -0,0 +1,260 @@
<!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.Image</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="#Tables">Tables</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><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><strong>juce.Image</strong></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.Image</code></h1>
<p>Image.</p>
<p> Images can be loaded from a file, or created as temporary graphics targets.</p>

<p> Is a pointer to a <a href="http://www.juce.com/api/classImage.html">JUCE Image</a>,
and wraps some <a href="http://www.juce.com/api/classImageFileFormat.html">JUCE ImageFileFormat</a>
functionality.</p>


<h2><a href="#Constructors">Constructors</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#juce.Image.Image"><span class="proto_prefix">juce</span>.Image (filename)</a></td>
<td class="summary">Load an image from a file.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#juce.Image.Image"><span class="proto_prefix">juce</span>.Image (pixelFormat, imageWidth, imageHeight, clearImage)</a></td>
<td class="summary">Create a temporary in-memory image.</td>
</tr>
</table>
<h2><a href="#Methods">Methods</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#juce.Image:isValid"><span class="proto_prefix">juce.Image</span>:isValid ()</a></td>
<td class="summary">Check Image validity.</td>
</tr>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#juce.Image.PixelFormat"><span class="proto_prefix">juce.Image</span>.PixelFormat</a></td>
<td class="summary">Pixel formats.</td>
</tr>
</table>

<br/>
<br/>


<h2><a name="Constructors"></a>Constructors</h2>
<dl class="function">
<dt>
<a name = "juce.Image.Image"></a>
<strong><span class="proto_prefix">juce</span>.Image (filename)</strong>
</dt>
<dd>
Load an image from a file.
The path can be absolute or relative to the protoplug directory.
To check if the file was loaded successfully, use <a href="../classes/juce.Image.html#juce.Image:isValid">isValid</a>.

</ul>

<h3>Parameters:</h3>
<ul>
<li><span class="parameter">filename</span>



</li>
</ul>





</dd>
<dt>
<a name = "juce.Image.Image"></a>
<strong><span class="proto_prefix">juce</span>.Image (pixelFormat, imageWidth, imageHeight, clearImage)</strong>
</dt>
<dd>
Create a temporary in-memory image.

</ul>

<h3>Parameters:</h3>
<ul>
<li><span class="parameter">pixelFormat</span>
<span class="types"><a class="type" href="../classes/juce.Image.html#juce.Image.PixelFormat">juce.Image.PixelFormat</a></span>



</li>
<li><span class="parameter">imageWidth</span>



</li>
<li><span class="parameter">imageHeight</span>



</li>
<li><span class="parameter">clearImage</span>
<span class="types"><span class="type">boolean</span></span>
fill the image with black
</li>
</ul>





</dd>
</dl>
<h2><a name="Methods"></a>Methods</h2>
<dl class="function">
<dt>
<a name = "juce.Image:isValid"></a>
<strong><span class="proto_prefix">juce.Image</span>:isValid ()</strong>
</dt>
<dd>
Check Image validity.

</ul>


<h3>Returns:</h3>
<ol>

<span class="types"><span class="type">boolean</span></span>
whether the image is valid and can be used.
</ol>




</dd>
</dl>
<h2><a name="Tables"></a>Tables</h2>
<dl class="function">
<dt>
<a name = "juce.Image.PixelFormat"></a>
<strong><span class="proto_prefix">juce.Image</span>.PixelFormat</strong>
</dt>
<dd>
Pixel formats.

</ul>

<h3>Fields:</h3>
<ul>
<li><span class="parameter">UnknownFormat</span>
0
</li>
<li><span class="parameter">RGB</span>
1
</li>
<li><span class="parameter">ARGB</span>
2
</li>
<li><span class="parameter">SingleChannel</span>
3
</li>
</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>
214 changes: 214 additions & 0 deletions ports/protoplug/ProtoplugFiles/doc/classes/juce.Justification.html
View file
@@ -0,0 +1,214 @@
<!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.Justification</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="#Tables">Tables</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><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><strong>juce.Justification</strong></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.Justification</code></h1>
<p>Justification.</p>
<p> Is converted to a <a href="http://www.juce.com/api/Justification.html">JUCE Justification</a></p>


<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#juce.Justification"><span class="proto_prefix">juce</span>.Justification</a></td>
<td class="summary">Justification Constants.</td>
</tr>
</table>

<br/>
<br/>


<h2><a name="Tables"></a>Tables</h2>
<dl class="function">
<dt>
<a name = "juce.Justification"></a>
<strong><span class="proto_prefix">juce</span>.Justification</strong>
</dt>
<dd>
Justification Constants.

</ul>

<h3>Fields:</h3>
<ul>
<li><span class="parameter">left</span>



</li>
<li><span class="parameter">right</span>



</li>
<li><span class="parameter">horizontallyCentred</span>



</li>
<li><span class="parameter">top</span>



</li>
<li><span class="parameter">bottom</span>



</li>
<li><span class="parameter">verticallyCentred</span>



</li>
<li><span class="parameter">horizontallyJustified</span>



</li>
<li><span class="parameter">centred</span>



</li>
<li><span class="parameter">centredLeft</span>



</li>
<li><span class="parameter">centredRight</span>



</li>
<li><span class="parameter">centredTop</span>



</li>
<li><span class="parameter">centredBottom</span>



</li>
<li><span class="parameter">topLeft</span>



</li>
<li><span class="parameter">topRight</span>



</li>
<li><span class="parameter">bottomLeft</span>



</li>
<li><span class="parameter">bottomRight</span>



</li>
</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>
180 changes: 180 additions & 0 deletions ports/protoplug/ProtoplugFiles/doc/classes/juce.LagrangeInterpolator.html
View file
@@ -0,0 +1,180 @@
<!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.LagrangeInterpolator</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><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><strong>juce.LagrangeInterpolator</strong></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.LagrangeInterpolator</code></h1>
<p>Lagrange Interpolator.</p>
<p> Is converted to a <a href="http://www.juce.com/api/classLagrangeInterpolator.html">JUCE LagrangeInterpolator</a></p>


<h2><a href="#Constructors">Constructors</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#juce.LagrangeInterpolator.LagrangeInterpolator"><span class="proto_prefix">juce</span>.LagrangeInterpolator ()</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.LagrangeInterpolator:process"><span class="wrapman"><span class="proto_prefix">juce.LagrangeInterpolator</span>:process<br> (speedRatio, inputSamples, outputSamples, numOutputSamplesToProduce)</span></a></td>
<td class="summary">Interpolate.</td>
</tr>
</table>

<br/>
<br/>


<h2><a name="Constructors"></a>Constructors</h2>
<dl class="function">
<dt>
<a name = "juce.LagrangeInterpolator.LagrangeInterpolator"></a>
<strong><span class="proto_prefix">juce</span>.LagrangeInterpolator ()</strong>
</dt>
<dd>
Constuctor.

</ul>






</dd>
</dl>
<h2><a name="Methods"></a>Methods</h2>
<dl class="function">
<dt>
<a name = "juce.LagrangeInterpolator:process"></a>
<strong><span class="wrapman"><span class="proto_prefix">juce.LagrangeInterpolator</span>:process<br> (speedRatio, inputSamples, outputSamples, numOutputSamplesToProduce)</span></strong>
</dt>
<dd>
Interpolate.

</ul>

<h3>Parameters:</h3>
<ul>
<li><span class="parameter">speedRatio</span>
number of input samples per output sample (input/output)
</li>
<li><span class="parameter">inputSamples</span>
pointer to a cdata <code>float</code> array
</li>
<li><span class="parameter">outputSamples</span>
pointer to a cdata <code>float</code> array
</li>
<li><span class="parameter">numOutputSamplesToProduce</span>



</li>
</ul>

<h3>Returns:</h3>
<ol>

<span class="types"><span class="type">number</span></span>
number of input samples that were processed
</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>
284 changes: 284 additions & 0 deletions ports/protoplug/ProtoplugFiles/doc/classes/juce.Line.html
View file
@@ -0,0 +1,284 @@
<!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.Line</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>
</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><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><strong>juce.Line</strong></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.Line</code></h1>
<p>Line.</p>
<p> Is converted to a <a href="http://www.juce.com/api/classLine.html">JUCE Line</a></p>


<h2><a href="#Constructors">Constructors</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#juce.Line.Line"><span class="proto_prefix">juce</span>.Line (x1, y1, x2, y2)</a></td>
<td class="summary">Constuctor</td>
</tr>
<tr>
<td class="name" nowrap><a href="#juce.Line.Line"><span class="proto_prefix">juce</span>.Line (args)</a></td>
<td class="summary">Constuctor</td>
</tr>
</table>
<h2><a href="#Fields">Fields</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#juce.Line.x1"><span class="proto_prefix">juce.Line</span>.x1</a></td>
<td class="summary">Point 1 X position</td>
</tr>
<tr>
<td class="name" nowrap><a href="#juce.Line.y1"><span class="proto_prefix">juce.Line</span>.y1</a></td>
<td class="summary">Point 1 Y position</td>
</tr>
<tr>
<td class="name" nowrap><a href="#juce.Line.x2"><span class="proto_prefix">juce.Line</span>.x2</a></td>
<td class="summary">Point 2 X position</td>
</tr>
<tr>
<td class="name" nowrap><a href="#juce.Line.y2"><span class="proto_prefix">juce.Line</span>.y2</a></td>
<td class="summary">Point 2 Y position</td>
</tr>
</table>

<br/>
<br/>


<h2><a name="Constructors"></a>Constructors</h2>
<dl class="function">
<dt>
<a name = "juce.Line.Line"></a>
<strong><span class="proto_prefix">juce</span>.Line (x1, y1, x2, y2)</strong>
</dt>
<dd>
Constuctor

</ul>

<h3>Parameters:</h3>
<ul>
<li><span class="parameter">x1</span>



</li>
<li><span class="parameter">y1</span>



</li>
<li><span class="parameter">x2</span>



</li>
<li><span class="parameter">y2</span>



</li>
</ul>





</dd>
<dt>
<a name = "juce.Line.Line"></a>
<strong><span class="proto_prefix">juce</span>.Line (args)</strong>
</dt>
<dd>
Constuctor

</ul>

<h3>Parameters:</h3>
<ul>
<li><span class="parameter">args</span>


<ul>
<li><span class="parameter">x1</span>



</li>
<li><span class="parameter">y1</span>



</li>
<li><span class="parameter">x2</span>



</li>
<li><span class="parameter">y2</span>



</li>
</li></ul>
</ul>





</dd>
</dl>
<h2><a name="Fields"></a>Fields</h2>
<dl class="function">
<dt>
<a name = "juce.Line.x1"></a>
<strong><span class="proto_prefix">juce.Line</span>.x1</strong>
</dt>
<dd>
Point 1 X position

</ul>






</dd>
<dt>
<a name = "juce.Line.y1"></a>
<strong><span class="proto_prefix">juce.Line</span>.y1</strong>
</dt>
<dd>
Point 1 Y position

</ul>






</dd>
<dt>
<a name = "juce.Line.x2"></a>
<strong><span class="proto_prefix">juce.Line</span>.x2</strong>
</dt>
<dd>
Point 2 X position

</ul>






</dd>
<dt>
<a name = "juce.Line.y2"></a>
<strong><span class="proto_prefix">juce.Line</span>.y2</strong>
</dt>
<dd>
Point 2 Y position

</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>