DISTRHO
/
DISTRHO-Ports-Extra
mirror of https://github.com/DISTRHO/DISTRHO-Ports-Extra


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