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.Rectangle_int.html

387 lines
9.2KB
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.Rectangle_int</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. <li><a href="#Fields">Fields</a></li>

  44. </ul>

  45. 

  46. 

  47. <h2>Classes</h2>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  65.   <li><strong>juce.Rectangle_int</strong></li>

  66. </ul>

  67. <h2>Modules</h2>

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

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

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

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

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

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

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

  75. </ul>

  76. <h2>Examples</h2>

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

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

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

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

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

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

  83. </ul>

  84. 

  85. </div>

  86. 

  87. <div id="content">

  88. 

  89. <h1>Class <code>juce.Rectangle_int</code></h1>

  90. <p>An integer (pixel-aligned) rectangle.</p>

  91. <p> Is converted to a <a href="http://www.juce.com/api/classRectangle.html">JUCE Rectangle</a></p>

  92. 

  93. 

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

  95. <table class="function_list">

  96. 	<tr>

  97. 	<td class="name" nowrap><a href="#juce.Rectangle_int.Rectangle_int"><span class="proto_prefix">juce</span>.Rectangle_int (x, y, w, h)</a></td>

  98. 	<td class="summary">Constuctor with classical arguments.</td>

  99. 	</tr>

  100. 	<tr>

  101. 	<td class="name" nowrap><a href="#juce.Rectangle_int.Rectangle_int"><span class="proto_prefix">juce</span>.Rectangle_int (args)</a></td>

  102. 	<td class="summary">Constuctor with named arguments.</td>

  103. 	</tr>

  104. </table>

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

  106. <table class="function_list">

  107. 	<tr>

  108. 	<td class="name" nowrap><a href="#juce.Rectangle_int:toFloat"><span class="proto_prefix">juce.Rectangle_int</span>:toFloat ()</a></td>

  109. 	<td class="summary">To float.</td>

  110. 	</tr>

  111. 	<tr>

  112. 	<td class="name" nowrap><a href="#juce.Rectangle_int:contains"><span class="proto_prefix">juce.Rectangle_int</span>:contains (point)</a></td>

  113. 	<td class="summary">Contains.</td>

  114. 	</tr>

  115. 	<tr>

  116. 	<td class="name" nowrap><a href="#juce.Rectangle_int:getR"><span class="proto_prefix">juce.Rectangle_int</span>:getR ()</a></td>

  117. 	<td class="summary">Get right.</td>

  118. 	</tr>

  119. 	<tr>

  120. 	<td class="name" nowrap><a href="#juce.Rectangle_int:getB"><span class="proto_prefix">juce.Rectangle_int</span>:getB ()</a></td>

  121. 	<td class="summary">Get bottom.</td>

  122. 	</tr>

  123. </table>

  124. <h2><a href="#Fields">Fields</a></h2>

  125. <table class="function_list">

  126. 	<tr>

  127. 	<td class="name" nowrap><a href="#juce.Rectangle_int.x"><span class="proto_prefix">juce.Rectangle_int</span>.x</a></td>

  128. 	<td class="summary">Left position</td>

  129. 	</tr>

  130. 	<tr>

  131. 	<td class="name" nowrap><a href="#juce.Rectangle_int.y"><span class="proto_prefix">juce.Rectangle_int</span>.y</a></td>

  132. 	<td class="summary">Top position</td>

  133. 	</tr>

  134. 	<tr>

  135. 	<td class="name" nowrap><a href="#juce.Rectangle_int.w"><span class="proto_prefix">juce.Rectangle_int</span>.w</a></td>

  136. 	<td class="summary">Width</td>

  137. 	</tr>

  138. 	<tr>

  139. 	<td class="name" nowrap><a href="#juce.Rectangle_int.h"><span class="proto_prefix">juce.Rectangle_int</span>.h</a></td>

  140. 	<td class="summary">Height</td>

  141. 	</tr>

  142. </table>

  143. 

  144. <br/>

  145. <br/>

  146. 

  147. 

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

  149.     <dl class="function">

  150.     <dt>

  151.     <a name = "juce.Rectangle_int.Rectangle_int"></a>

  152.     <strong><span class="proto_prefix">juce</span>.Rectangle_int (x, y, w, h)</strong>

  153.     </dt>

  154.     <dd>

  155.     Constuctor with classical arguments.

  156. 

  157.     </ul>

  158. 

  159.     <h3>Parameters:</h3>

  160.     <ul>

  161.         <li><span class="parameter">x</span>

  162.          left position

  163.         </li>

  164.         <li><span class="parameter">y</span>

  165.          top position

  166.         </li>

  167.         <li><span class="parameter">w</span>

  168.          width

  169.         </li>

  170.         <li><span class="parameter">h</span>

  171.          height

  172.         </li>

  173.     </ul>

  174. 

  175. 

  176. 

  177. 

  178. 

  179. </dd>

  180.     <dt>

  181.     <a name = "juce.Rectangle_int.Rectangle_int"></a>

  182.     <strong><span class="proto_prefix">juce</span>.Rectangle_int (args)</strong>

  183.     </dt>

  184.     <dd>

  185.     Constuctor with named arguments.

  186.  Every field is optional.

  187. 

  188.     </ul>

  189. 

  190.     <h3>Parameters:</h3>

  191.     <ul>

  192.         <li><span class="parameter">args</span>

  193. 

  194. 

  195.         <ul>

  196.         <li><span class="parameter">x</span>

  197.          left position

  198.         </li>

  199.         <li><span class="parameter">y</span>

  200.          top position

  201.         </li>

  202.         <li><span class="parameter">w</span>

  203.          width

  204.         </li>

  205.         <li><span class="parameter">h</span>

  206.          height

  207.         </li>

  208.         </li></ul>

  209.     </ul>

  210. 

  211. 

  212. 

  213. 

  214. 

  215. </dd>

  216. </dl>

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

  218.     <dl class="function">

  219.     <dt>

  220.     <a name = "juce.Rectangle_int:toFloat"></a>

  221.     <strong><span class="proto_prefix">juce.Rectangle_int</span>:toFloat ()</strong>

  222.     </dt>

  223.     <dd>

  224.     To float.

  225.  Convert to a sub-pixel rectangle

  226. 

  227.     </ul>

  228. 

  229. 

  230.     <h3>Returns:</h3>

  231.     <ol>

  232. 

  233.            <span class="types"><span class="type">juce.Rectangle_float</span></span>

  234. 

  235. 

  236. 

  237.     </ol>

  238. 

  239. 

  240. 

  241. 

  242. </dd>

  243.     <dt>

  244.     <a name = "juce.Rectangle_int:contains"></a>

  245.     <strong><span class="proto_prefix">juce.Rectangle_int</span>:contains (point)</strong>

  246.     </dt>

  247.     <dd>

  248.     Contains.

  249. 

  250.     </ul>

  251. 

  252.     <h3>Parameters:</h3>

  253.     <ul>

  254.         <li><span class="parameter">point</span>

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

  256. 

  257. 

  258. 

  259.         </li>

  260.     </ul>

  261. 

  262.     <h3>Returns:</h3>

  263.     <ol>

  264. 

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

  266.         whether the rectangle contains the point

  267.     </ol>

  268. 

  269. 

  270. 

  271. 

  272. </dd>

  273.     <dt>

  274.     <a name = "juce.Rectangle_int:getR"></a>

  275.     <strong><span class="proto_prefix">juce.Rectangle_int</span>:getR ()</strong>

  276.     </dt>

  277.     <dd>

  278.     Get right.

  279. 

  280.     </ul>

  281. 

  282. 

  283.     <h3>Returns:</h3>

  284.     <ol>

  285. 

  286.         the rectangle's right position on the X axis

  287.     </ol>

  288. 

  289. 

  290. 

  291. 

  292. </dd>

  293.     <dt>

  294.     <a name = "juce.Rectangle_int:getB"></a>

  295.     <strong><span class="proto_prefix">juce.Rectangle_int</span>:getB ()</strong>

  296.     </dt>

  297.     <dd>

  298.     Get bottom.

  299. 

  300.     </ul>

  301. 

  302. 

  303.     <h3>Returns:</h3>

  304.     <ol>

  305. 

  306.         the rectangle's bottom position on the Y axis

  307.     </ol>

  308. 

  309. 

  310. 

  311. 

  312. </dd>

  313. </dl>

  314.     <h2><a name="Fields"></a>Fields</h2>

  315.     <dl class="function">

  316.     <dt>

  317.     <a name = "juce.Rectangle_int.x"></a>

  318.     <strong><span class="proto_prefix">juce.Rectangle_int</span>.x</strong>

  319.     </dt>

  320.     <dd>

  321.     Left position

  322. 

  323.     </ul>

  324. 

  325. 

  326. 

  327. 

  328. 

  329. 

  330. </dd>

  331.     <dt>

  332.     <a name = "juce.Rectangle_int.y"></a>

  333.     <strong><span class="proto_prefix">juce.Rectangle_int</span>.y</strong>

  334.     </dt>

  335.     <dd>

  336.     Top position

  337. 

  338.     </ul>

  339. 

  340. 

  341. 

  342. 

  343. 

  344. 

  345. </dd>

  346.     <dt>

  347.     <a name = "juce.Rectangle_int.w"></a>

  348.     <strong><span class="proto_prefix">juce.Rectangle_int</span>.w</strong>

  349.     </dt>

  350.     <dd>

  351.     Width

  352. 

  353.     </ul>

  354. 

  355. 

  356. 

  357. 

  358. 

  359. 

  360. </dd>

  361.     <dt>

  362.     <a name = "juce.Rectangle_int.h"></a>

  363.     <strong><span class="proto_prefix">juce.Rectangle_int</span>.h</strong>

  364.     </dt>

  365.     <dd>

  366.     Height

  367. 

  368.     </ul>

  369. 

  370. 

  371. 

  372. 

  373. 

  374. 

  375. </dd>

  376. </dl>

  377. 

  378. 

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

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

  381. <div id="about">

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

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

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

  385. </body>

  386. </html>