DISTRHO
/
DISTRHO-Ports-Extra
mirror of https://github.com/DISTRHO/DISTRHO-Ports-Extra
1
0
Fork 0
Code Releases 0 Activity
Extra "ports" of juce-based plugins using the distrho build system
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
10 Commits
1 Branch
28MB
Tree: aed02c1b70
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'aed02c1b70'
${ noResults }
DISTRHO-Ports-Extra/ports/protoplug/ProtoplugFiles/doc/classes/juce.ColourGradient.html

372 lines
10KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"

  2.    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

  3. <html>

  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>

  5. <head>

  6.     <title>protoplug: Class juce.ColourGradient</title>

  7.     <link rel="stylesheet" href="../ldoc.css" type="text/css" />

  8. </head>

  9. <body>

  10. 

  11. <div id="container">

  12. 

  13. <div id="product">

  14. 	<div id="product_logo"></div>

  15. 	<div id="product_name"><big><b></b></big></div>

  16. 	<div id="product_description"></div>

  17. </div> <!-- id="product" -->

  18. 

  19. 

  20. <div id="main">

  21. 

  22. 

  23. <!-- Menu -->

  24. 

  25. <div id="navigation">

  26. <a href="http://osar.fr">

  27. <div class=osarlogo> </div>

  28. </a>

  29. <br/>

  30. <a href="http://osar.fr/protoplug">

  31. <h1>protoplug</h1>

  32. </a>

  33. 	<span class="proto_subtitle">Lua API reference</span>

  34. 

  35. <ul>

  36.   <li><a href="../index.html">Index</a></li>

  37. </ul>

  38. 

  39. <h2>Contents</h2>

  40. <ul>

  41. <li><a href="#Constructors">Constructors</a></li>

  42. <li><a href="#Methods">Methods</a></li>

  43. </ul>

  44. 

  45. 

  46. <h2>Classes</h2>

  47. <ul class="$(kind=='Topics' and '' or 'nowrap'">

  48.   <li><a href="../classes/juce.AffineTransform.html">juce.AffineTransform</a></li>

  49.   <li><a href="../classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></li>

  50.   <li><a href="../classes/juce.Colour.html">juce.Colour</a></li>

  51.   <li><strong>juce.ColourGradient</strong></li>

  52.   <li><a href="../classes/juce.Component.html">juce.Component</a></li>

  53.   <li><a href="../classes/juce.FillType.html">juce.FillType</a></li>

  54.   <li><a href="../classes/juce.Font.html">juce.Font</a></li>

  55.   <li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li>

  56.   <li><a href="../classes/juce.Image.html">juce.Image</a></li>

  57.   <li><a href="../classes/juce.Justification.html">juce.Justification</a></li>

  58.   <li><a href="../classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></li>

  59.   <li><a href="../classes/juce.Line.html">juce.Line</a></li>

  60.   <li><a href="../classes/juce.Path.html">juce.Path</a></li>

  61.   <li><a href="../classes/juce.Point.html">juce.Point</a></li>

  62.   <li><a href="../classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></li>

  63.   <li><a href="../classes/juce.Rectangle_float.html">juce.Rectangle_float</a></li>

  64.   <li><a href="../classes/juce.Rectangle_int.html">juce.Rectangle_int</a></li>

  65. </ul>

  66. <h2>Modules</h2>

  67. <ul class="$(kind=='Topics' and '' or 'nowrap'">

  68.   <li><a href="../modules/plugin.html">plugin</a></li>

  69.   <li><a href="../modules/script.html">script</a></li>

  70.   <li><a href="../modules/midi.html">midi</a></li>

  71.   <li><a href="../modules/gui.html">gui</a></li>

  72.   <li><a href="../modules/polyGen.html">polyGen</a></li>

  73.   <li><a href="../modules/stereoFx.html">stereoFx</a></li>

  74. </ul>

  75. <h2>Examples</h2>

  76. <ul class="$(kind=='Topics' and '' or 'nowrap'">

  77.   <li><a href="../examples/classic-filter.lua.html">classic-filter.lua</a></li>

  78.   <li><a href="../examples/sine-organ.lua.html">sine-organ.lua</a></li>

  79.   <li><a href="../examples/midi-chordify.lua.html">midi-chordify.lua</a></li>

  80.   <li><a href="../examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></li>

  81.   <li><a href="../examples/soundfile-test.lua.html">soundfile-test.lua</a></li>

  82. </ul>

  83. 

  84. </div>

  85. 

  86. <div id="content">

  87. 

  88. <h1>Class <code>juce.ColourGradient</code></h1>

  89. <p>Colour Gradient.</p>

  90. <p> Is a pointer to a <a href="http://www.juce.com/api/classColourGradient.html">JUCE ColourGradient</a></p>

  91. 

  92. 

  93. <h2><a href="#Constructors">Constructors</a></h2>

  94. <table class="function_list">

  95. 	<tr>

  96. 	<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>

  97. 	<td class="summary">Constuctor.</td>

  98. 	</tr>

  99. </table>

  100. <h2><a href="#Methods">Methods</a></h2>

  101. <table class="function_list">

  102. 	<tr>

  103. 	<td class="name" nowrap><a href="#juce.ColourGradient:addColour"><span class="proto_prefix">juce.ColourGradient</span>:addColour<br> (proportionAlongGradient, colour)</a></td>

  104. 	<td class="summary">Add colour.</td>

  105. 	</tr>

  106. 	<tr>

  107. 	<td class="name" nowrap><a href="#juce.ColourGradient:removeColour"><span class="proto_prefix">juce.ColourGradient</span>:removeColour (index)</a></td>

  108. 	<td class="summary">Remove colour.</td>

  109. 	</tr>

  110. 	<tr>

  111. 	<td class="name" nowrap><a href="#juce.ColourGradient:multiplyOpacity"><span class="proto_prefix">juce.ColourGradient</span>:multiplyOpacity (multiplier)</a></td>

  112. 	<td class="summary">Multiply opacity.</td>

  113. 	</tr>

  114. 	<tr>

  115. 	<td class="name" nowrap><a href="#juce.ColourGradient:getNumColours"><span class="proto_prefix">juce.ColourGradient</span>:getNumColours ()</a></td>

  116. 	<td class="summary">Get number colour.</td>

  117. 	</tr>

  118. 	<tr>

  119. 	<td class="name" nowrap><a href="#juce.ColourGradient:getColour"><span class="proto_prefix">juce.ColourGradient</span>:getColour (index)</a></td>

  120. 	<td class="summary">Get colour.</td>

  121. 	</tr>

  122. 	<tr>

  123. 	<td class="name" nowrap><a href="#juce.ColourGradient:setColour"><span class="proto_prefix">juce.ColourGradient</span>:setColour (index, newColour)</a></td>

  124. 	<td class="summary">Get colour.</td>

  125. 	</tr>

  126. 	<tr>

  127. 	<td class="name" nowrap><a href="#juce.ColourGradient:getColourAtPosition"><span class="proto_prefix">juce.ColourGradient</span>:getColourAtPosition (position)</a></td>

  128. 	<td class="summary">Get interpolated colour</td>

  129. 	</tr>

  130. </table>

  131. 

  132. <br/>

  133. <br/>

  134. 

  135. 

  136.     <h2><a name="Constructors"></a>Constructors</h2>

  137.     <dl class="function">

  138.     <dt>

  139.     <a name = "juce.ColourGradient.Colour"></a>

  140.     <strong><span class="proto_prefix">juce</span>.ColourGradient (colour1, x1, y1, colour2, x2, y2, isRadial)</strong>

  141.     </dt>

  142.     <dd>

  143.     Constuctor.

  144. 

  145.     </ul>

  146. 

  147.     <h3>Parameters:</h3>

  148.     <ul>

  149.         <li><span class="parameter">colour1</span>

  150.             <span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span>

  151.          colour at the beginning of the gradient

  152.         </li>

  153.         <li><span class="parameter">x1</span>

  154.          coordinates of colour1

  155.         </li>

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

  157.          coordinates of colour1

  158.         </li>

  159.         <li><span class="parameter">colour2</span>

  160.             <span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span>

  161.          colour at the end of the gradient

  162.         </li>

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

  164.          coordinates of colour2

  165.         </li>

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

  167.          coordinates of colour2

  168.         </li>

  169.         <li><span class="parameter">isRadial</span>

  170.             <span class="types"><span class="type">boolean</span></span>

  171.          whether the gradient should be linear or radial

  172.         </li>

  173.     </ul>

  174. 

  175. 

  176. 

  177. 

  178. 

  179. </dd>

  180. </dl>

  181.     <h2><a name="Methods"></a>Methods</h2>

  182.     <dl class="function">

  183.     <dt>

  184.     <a name = "juce.ColourGradient:addColour"></a>

  185.     <strong><span class="proto_prefix">juce.ColourGradient</span>:addColour<br> (proportionAlongGradient, colour)</strong>

  186.     </dt>

  187.     <dd>

  188.     Add colour.

  189.  Any number of colours can be added between the start and end of the gradient.

  190. 

  191.     </ul>

  192. 

  193.     <h3>Parameters:</h3>

  194.     <ul>

  195.         <li><span class="parameter">proportionAlongGradient</span>

  196. 

  197. 

  198. 

  199.         </li>

  200.         <li><span class="parameter">colour</span>

  201.             <span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span>

  202. 

  203. 

  204. 

  205.         </li>

  206.     </ul>

  207. 

  208.     <h3>Returns:</h3>

  209.     <ol>

  210. 

  211.         the new colour's index

  212.     </ol>

  213. 

  214. 

  215. 

  216. 

  217. </dd>

  218.     <dt>

  219.     <a name = "juce.ColourGradient:removeColour"></a>

  220.     <strong><span class="proto_prefix">juce.ColourGradient</span>:removeColour (index)</strong>

  221.     </dt>

  222.     <dd>

  223.     Remove colour.

  224. 

  225.     </ul>

  226. 

  227.     <h3>Parameters:</h3>

  228.     <ul>

  229.         <li><span class="parameter">index</span>

  230.          colour index between 0 and getNumColours() - 1

  231.         </li>

  232.     </ul>

  233. 

  234. 

  235. 

  236. 

  237. 

  238. </dd>

  239.     <dt>

  240.     <a name = "juce.ColourGradient:multiplyOpacity"></a>

  241.     <strong><span class="proto_prefix">juce.ColourGradient</span>:multiplyOpacity (multiplier)</strong>

  242.     </dt>

  243.     <dd>

  244.     Multiply opacity.

  245. 

  246.     </ul>

  247. 

  248.     <h3>Parameters:</h3>

  249.     <ul>

  250.         <li><span class="parameter">multiplier</span>

  251.          factor to multiply the alpha values by

  252.         </li>

  253.     </ul>

  254. 

  255. 

  256. 

  257. 

  258. 

  259. </dd>

  260.     <dt>

  261.     <a name = "juce.ColourGradient:getNumColours"></a>

  262.     <strong><span class="proto_prefix">juce.ColourGradient</span>:getNumColours ()</strong>

  263.     </dt>

  264.     <dd>

  265.     Get number colour.

  266. 

  267.     </ul>

  268. 

  269. 

  270.     <h3>Returns:</h3>

  271.     <ol>

  272. 

  273.         the number of colours

  274.     </ol>

  275. 

  276. 

  277. 

  278. 

  279. </dd>

  280.     <dt>

  281.     <a name = "juce.ColourGradient:getColour"></a>

  282.     <strong><span class="proto_prefix">juce.ColourGradient</span>:getColour (index)</strong>

  283.     </dt>

  284.     <dd>

  285.     Get colour.

  286. 

  287.     </ul>

  288. 

  289.     <h3>Parameters:</h3>

  290.     <ul>

  291.         <li><span class="parameter">index</span>

  292.          colour index between 0 and getNumColours() - 1

  293.         </li>

  294.     </ul>

  295. 

  296.     <h3>Returns:</h3>

  297.     <ol>

  298. 

  299.            <span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span>

  300.         the coulour at the specified index

  301.     </ol>

  302. 

  303. 

  304. 

  305. 

  306. </dd>

  307.     <dt>

  308.     <a name = "juce.ColourGradient:setColour"></a>

  309.     <strong><span class="proto_prefix">juce.ColourGradient</span>:setColour (index, newColour)</strong>

  310.     </dt>

  311.     <dd>

  312.     Get colour.

  313. 

  314.     </ul>

  315. 

  316.     <h3>Parameters:</h3>

  317.     <ul>

  318.         <li><span class="parameter">index</span>

  319.          colour index between 0 and getNumColours() - 1

  320.         </li>

  321.         <li><span class="parameter">newColour</span>

  322.             <span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span>

  323. 

  324. 

  325. 

  326.         </li>

  327.     </ul>

  328. 

  329. 

  330. 

  331. 

  332. 

  333. </dd>

  334.     <dt>

  335.     <a name = "juce.ColourGradient:getColourAtPosition"></a>

  336.     <strong><span class="proto_prefix">juce.ColourGradient</span>:getColourAtPosition (position)</strong>

  337.     </dt>

  338.     <dd>

  339.     Get interpolated colour

  340. 

  341.     </ul>

  342. 

  343.     <h3>Parameters:</h3>

  344.     <ul>

  345.         <li><span class="parameter">position</span>

  346.          the position between 0 and 1

  347.         </li>

  348.     </ul>

  349. 

  350.     <h3>Returns:</h3>

  351.     <ol>

  352. 

  353.            <span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span>

  354.         the interpolated colour at the specified position

  355.     </ol>

  356. 

  357. 

  358. 

  359. 

  360. </dd>

  361. </dl>

  362. 

  363. 

  364. </div> <!-- id="content" -->

  365. </div> <!-- id="main" -->

  366. <div id="about">

  367. <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>

  368. </div> <!-- id="about" -->

  369. </div> <!-- id="container" -->

  370. </body>

  371. </html>