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.

382 lines
8.4KB

  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.Colour</title>
  7. <link rel="stylesheet" href="../ldoc.css" type="text/css" />
  8. </head>
  9. <body>
  10. <div id="container">
  11. <div id="product">
  12. <div id="product_logo"></div>
  13. <div id="product_name"><big><b></b></big></div>
  14. <div id="product_description"></div>
  15. </div> <!-- id="product" -->
  16. <div id="main">
  17. <!-- Menu -->
  18. <div id="navigation">
  19. <a href="http://osar.fr">
  20. <div class=osarlogo> </div>
  21. </a>
  22. <br/>
  23. <a href="http://osar.fr/protoplug">
  24. <h1>protoplug</h1>
  25. </a>
  26. <span class="proto_subtitle">Lua API reference</span>
  27. <ul>
  28. <li><a href="../index.html">Index</a></li>
  29. </ul>
  30. <h2>Contents</h2>
  31. <ul>
  32. <li><a href="#Constructors">Constructors</a></li>
  33. <li><a href="#Fields">Fields</a></li>
  34. <li><a href="#Predefined_values">Predefined values</a></li>
  35. </ul>
  36. <h2>Classes</h2>
  37. <ul class="$(kind=='Topics' and '' or 'nowrap'">
  38. <li><a href="../classes/juce.AffineTransform.html">juce.AffineTransform</a></li>
  39. <li><a href="../classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></li>
  40. <li><strong>juce.Colour</strong></li>
  41. <li><a href="../classes/juce.ColourGradient.html">juce.ColourGradient</a></li>
  42. <li><a href="../classes/juce.Component.html">juce.Component</a></li>
  43. <li><a href="../classes/juce.FillType.html">juce.FillType</a></li>
  44. <li><a href="../classes/juce.Font.html">juce.Font</a></li>
  45. <li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li>
  46. <li><a href="../classes/juce.Image.html">juce.Image</a></li>
  47. <li><a href="../classes/juce.Justification.html">juce.Justification</a></li>
  48. <li><a href="../classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></li>
  49. <li><a href="../classes/juce.Line.html">juce.Line</a></li>
  50. <li><a href="../classes/juce.Path.html">juce.Path</a></li>
  51. <li><a href="../classes/juce.Point.html">juce.Point</a></li>
  52. <li><a href="../classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></li>
  53. <li><a href="../classes/juce.Rectangle_float.html">juce.Rectangle_float</a></li>
  54. <li><a href="../classes/juce.Rectangle_int.html">juce.Rectangle_int</a></li>
  55. </ul>
  56. <h2>Modules</h2>
  57. <ul class="$(kind=='Topics' and '' or 'nowrap'">
  58. <li><a href="../modules/plugin.html">plugin</a></li>
  59. <li><a href="../modules/script.html">script</a></li>
  60. <li><a href="../modules/midi.html">midi</a></li>
  61. <li><a href="../modules/gui.html">gui</a></li>
  62. <li><a href="../modules/polyGen.html">polyGen</a></li>
  63. <li><a href="../modules/stereoFx.html">stereoFx</a></li>
  64. </ul>
  65. <h2>Examples</h2>
  66. <ul class="$(kind=='Topics' and '' or 'nowrap'">
  67. <li><a href="../examples/classic-filter.lua.html">classic-filter.lua</a></li>
  68. <li><a href="../examples/sine-organ.lua.html">sine-organ.lua</a></li>
  69. <li><a href="../examples/midi-chordify.lua.html">midi-chordify.lua</a></li>
  70. <li><a href="../examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></li>
  71. <li><a href="../examples/soundfile-test.lua.html">soundfile-test.lua</a></li>
  72. </ul>
  73. </div>
  74. <div id="content">
  75. <h1>Class <code>juce.Colour</code></h1>
  76. <p>A simple colour class.</p>
  77. <p> Is converted to a <a href="http://www.juce.com/api/classColour.html">JUCE Colour</a></p>
  78. <h2><a href="#Constructors">Constructors</a></h2>
  79. <table class="function_list">
  80. <tr>
  81. <td class="name" nowrap><a href="#juce.Colour.Colour"><span class="proto_prefix">juce</span>.Colour (r, g, b[, a])</a></td>
  82. <td class="summary">Constuctor with classical arguments.</td>
  83. </tr>
  84. <tr>
  85. <td class="name" nowrap><a href="#juce.Colour.Colour"><span class="proto_prefix">juce</span>.Colour (args)</a></td>
  86. <td class="summary">Constuctor with named arguments.</td>
  87. </tr>
  88. </table>
  89. <h2><a href="#Fields">Fields</a></h2>
  90. <table class="function_list">
  91. <tr>
  92. <td class="name" nowrap><a href="#juce.Colour.r"><span class="proto_prefix">juce.Colour</span>.r</a></td>
  93. <td class="summary">Red (0-255)</td>
  94. </tr>
  95. <tr>
  96. <td class="name" nowrap><a href="#juce.Colour.g"><span class="proto_prefix">juce.Colour</span>.g</a></td>
  97. <td class="summary">Green (0-255)</td>
  98. </tr>
  99. <tr>
  100. <td class="name" nowrap><a href="#juce.Colour.b"><span class="proto_prefix">juce.Colour</span>.b</a></td>
  101. <td class="summary">Blue (0-255)</td>
  102. </tr>
  103. <tr>
  104. <td class="name" nowrap><a href="#juce.Colour.a"><span class="proto_prefix">juce.Colour</span>.a</a></td>
  105. <td class="summary">Alpha (0-255)</td>
  106. </tr>
  107. </table>
  108. <h2><a href="#Predefined_values">Predefined values</a></h2>
  109. <table class="function_list">
  110. <tr>
  111. <td class="name" nowrap><a href="#juce.Colour.black"><span class="proto_prefix">juce.Colour</span>.black</a></td>
  112. <td class="summary">
  113. </td>
  114. </tr>
  115. <tr>
  116. <td class="name" nowrap><a href="#juce.Colour.white"><span class="proto_prefix">juce.Colour</span>.white</a></td>
  117. <td class="summary">
  118. </td>
  119. </tr>
  120. <tr>
  121. <td class="name" nowrap><a href="#juce.Colour.red"><span class="proto_prefix">juce.Colour</span>.red</a></td>
  122. <td class="summary">
  123. </td>
  124. </tr>
  125. <tr>
  126. <td class="name" nowrap><a href="#juce.Colour.green"><span class="proto_prefix">juce.Colour</span>.green</a></td>
  127. <td class="summary">
  128. </td>
  129. </tr>
  130. <tr>
  131. <td class="name" nowrap><a href="#juce.Colour.blue"><span class="proto_prefix">juce.Colour</span>.blue</a></td>
  132. <td class="summary">
  133. </td>
  134. </tr>
  135. </table>
  136. <br/>
  137. <br/>
  138. <h2><a name="Constructors"></a>Constructors</h2>
  139. <dl class="function">
  140. <dt>
  141. <a name = "juce.Colour.Colour"></a>
  142. <strong><span class="proto_prefix">juce</span>.Colour (r, g, b[, a])</strong>
  143. </dt>
  144. <dd>
  145. Constuctor with classical arguments.
  146. </ul>
  147. <h3>Parameters:</h3>
  148. <ul>
  149. <li><span class="parameter">r</span>
  150. red
  151. </li>
  152. <li><span class="parameter">g</span>
  153. green
  154. </li>
  155. <li><span class="parameter">b</span>
  156. blue
  157. </li>
  158. <li><span class="parameter">a</span>
  159. alpha
  160. </li>
  161. </ul>
  162. </dd>
  163. <dt>
  164. <a name = "juce.Colour.Colour"></a>
  165. <strong><span class="proto_prefix">juce</span>.Colour (args)</strong>
  166. </dt>
  167. <dd>
  168. Constuctor with named arguments.
  169. Every field is optional.
  170. </ul>
  171. <h3>Parameters:</h3>
  172. <ul>
  173. <li><span class="parameter">args</span>
  174. <ul>
  175. <li><span class="parameter">r</span>
  176. red
  177. </li>
  178. <li><span class="parameter">g</span>
  179. green
  180. </li>
  181. <li><span class="parameter">b</span>
  182. blue,
  183. </li>
  184. <li><span class="parameter">a</span>
  185. alpha
  186. </li>
  187. </li></ul>
  188. </ul>
  189. </dd>
  190. </dl>
  191. <h2><a name="Fields"></a>Fields</h2>
  192. <dl class="function">
  193. <dt>
  194. <a name = "juce.Colour.r"></a>
  195. <strong><span class="proto_prefix">juce.Colour</span>.r</strong>
  196. </dt>
  197. <dd>
  198. Red (0-255)
  199. </ul>
  200. </dd>
  201. <dt>
  202. <a name = "juce.Colour.g"></a>
  203. <strong><span class="proto_prefix">juce.Colour</span>.g</strong>
  204. </dt>
  205. <dd>
  206. Green (0-255)
  207. </ul>
  208. </dd>
  209. <dt>
  210. <a name = "juce.Colour.b"></a>
  211. <strong><span class="proto_prefix">juce.Colour</span>.b</strong>
  212. </dt>
  213. <dd>
  214. Blue (0-255)
  215. </ul>
  216. </dd>
  217. <dt>
  218. <a name = "juce.Colour.a"></a>
  219. <strong><span class="proto_prefix">juce.Colour</span>.a</strong>
  220. </dt>
  221. <dd>
  222. Alpha (0-255)
  223. </ul>
  224. </dd>
  225. </dl>
  226. <h2><a name="Predefined_values"></a>Predefined values</h2>
  227. <dl class="function">
  228. <dt>
  229. <a name = "juce.Colour.black"></a>
  230. <strong><span class="proto_prefix">juce.Colour</span>.black</strong>
  231. </dt>
  232. <dd>
  233. </ul>
  234. </dd>
  235. <dt>
  236. <a name = "juce.Colour.white"></a>
  237. <strong><span class="proto_prefix">juce.Colour</span>.white</strong>
  238. </dt>
  239. <dd>
  240. </ul>
  241. </dd>
  242. <dt>
  243. <a name = "juce.Colour.red"></a>
  244. <strong><span class="proto_prefix">juce.Colour</span>.red</strong>
  245. </dt>
  246. <dd>
  247. </ul>
  248. </dd>
  249. <dt>
  250. <a name = "juce.Colour.green"></a>
  251. <strong><span class="proto_prefix">juce.Colour</span>.green</strong>
  252. </dt>
  253. <dd>
  254. </ul>
  255. </dd>
  256. <dt>
  257. <a name = "juce.Colour.blue"></a>
  258. <strong><span class="proto_prefix">juce.Colour</span>.blue</strong>
  259. </dt>
  260. <dd>
  261. </ul>
  262. </dd>
  263. </dl>
  264. </div> <!-- id="content" -->
  265. </div> <!-- id="main" -->
  266. <div id="about">
  267. <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>
  268. </div> <!-- id="about" -->
  269. </div> <!-- id="container" -->
  270. </body>
  271. </html>