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.

2221 lines
51KB

  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.Graphics</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="#Methods">Methods</a></li>
  34. <li><a href="#Tables">Tables</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><a href="../classes/juce.Colour.html">juce.Colour</a></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><strong>juce.Graphics</strong></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.Graphics</code></h1>
  76. <p>Graphics drawing target.</p>
  77. <p> Is a pointer to a <a href="http://www.juce.com/api/classGraphics.html">JUCE Graphics</a> object.
  78. Received in <a href="../modules/gui.html#paint">gui.paint</a> as an argument.</p>
  79. <h2><a href="#Constructors">Constructors</a></h2>
  80. <table class="function_list">
  81. <tr>
  82. <td class="name" nowrap><a href="#juce.Graphics.Graphics"><span class="proto_prefix">juce</span>.Graphics (imageToDrawOnto)</a></td>
  83. <td class="summary">Constuct from a <a href="../classes/juce.Image.html#">juce.Image</a>.</td>
  84. </tr>
  85. </table>
  86. <h2><a href="#Methods">Methods</a></h2>
  87. <table class="function_list">
  88. <tr>
  89. <td class="name" nowrap><a href="#juce.Graphics:setColour"><span class="proto_prefix">juce.Graphics</span>:setColour (newColour)</a></td>
  90. <td class="summary">Set working colour.</td>
  91. </tr>
  92. <tr>
  93. <td class="name" nowrap><a href="#juce.Graphics:setOpacity"><span class="proto_prefix">juce.Graphics</span>:setOpacity (newOpacity)</a></td>
  94. <td class="summary">Set working opacity.</td>
  95. </tr>
  96. <tr>
  97. <td class="name" nowrap><a href="#juce.Graphics:setGradientFill"><span class="proto_prefix">juce.Graphics</span>:setGradientFill (gradient)</a></td>
  98. <td class="summary">Set working Gradient.</td>
  99. </tr>
  100. <tr>
  101. <td class="name" nowrap><a href="#juce.Graphics:setTiledImageFill"><span class="proto_prefix">juce.Graphics</span>:setTiledImageFill<br> (imageToUse, anchorX, anchorY, opacity)</a></td>
  102. <td class="summary">Set Tiled Image Fill.</td>
  103. </tr>
  104. <tr>
  105. <td class="name" nowrap><a href="#juce.Graphics:setFillType"><span class="proto_prefix">juce.Graphics</span>:setFillType (newFill)</a></td>
  106. <td class="summary">Set Fill.</td>
  107. </tr>
  108. <tr>
  109. <td class="name" nowrap><a href="#juce.Graphics:setFont"><span class="proto_prefix">juce.Graphics</span>:setFont (newFont)</a></td>
  110. <td class="summary">Set Font.</td>
  111. </tr>
  112. <tr>
  113. <td class="name" nowrap><a href="#juce.Graphics:setFont"><span class="proto_prefix">juce.Graphics</span>:setFont (newFontHeight)</a></td>
  114. <td class="summary">Set Font.</td>
  115. </tr>
  116. <tr>
  117. <td class="name" nowrap><a href="#juce.Graphics:getCurrentFont"><span class="proto_prefix">juce.Graphics</span>:getCurrentFont ()</a></td>
  118. <td class="summary">Get Current Font.</td>
  119. </tr>
  120. <tr>
  121. <td class="name" nowrap><a href="#juce.Graphics:drawSingleLineText"><span class="proto_prefix">juce.Graphics</span>:drawSingleLineText<br> (text, startX, baselineY[, justification=Justification.left])</a></td>
  122. <td class="summary">Draw single line of text.</td>
  123. </tr>
  124. <tr>
  125. <td class="name" nowrap><a href="#juce.Graphics:drawMultiLineText"><span class="proto_prefix">juce.Graphics</span>:drawMultiLineText<br> (text, startX, baselineY, maximumLineWidth)</a></td>
  126. <td class="summary">Draw multiline text.</td>
  127. </tr>
  128. <tr>
  129. <td class="name" nowrap><a href="#juce.Graphics:drawText"><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawText<br> (x, y, width, height[, justification=Justification.left[, useEllipsesIfTooBig=false]])</span></a></td>
  130. <td class="summary">Draw text.</td>
  131. </tr>
  132. <tr>
  133. <td class="name" nowrap><a href="#juce.Graphics:drawText"><span class="proto_prefix">juce.Graphics</span>:drawText<br> (area[, justification=Justification.left[, useEllipsesIfTooBig=false]])</a></td>
  134. <td class="summary">Draw text.</td>
  135. </tr>
  136. <tr>
  137. <td class="name" nowrap><a href="#juce.Graphics:drawFittedText"><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawFittedText<br> (x, y, width, height, justification, maximumNumberOfLines[, minimumHorizontalScale=0.7])</span></a></td>
  138. <td class="summary">Draw fitted text.</td>
  139. </tr>
  140. <tr>
  141. <td class="name" nowrap><a href="#juce.Graphics:drawFittedText"><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawFittedText<br> (area, justification, maximumNumberOfLines[, minimumHorizontalScale=0.7])</span></a></td>
  142. <td class="summary">Draw fitted text.</td>
  143. </tr>
  144. <tr>
  145. <td class="name" nowrap><a href="#juce.Graphics:fillAll"><span class="proto_prefix">juce.Graphics</span>:fillAll ([colourToUse])</a></td>
  146. <td class="summary">Fill the entire graphics target.</td>
  147. </tr>
  148. <tr>
  149. <td class="name" nowrap><a href="#juce.Graphics:fillRect"><span class="proto_prefix">juce.Graphics</span>:fillRect (x, y, width, height)</a></td>
  150. <td class="summary">Fill rectangle with current fill type.</td>
  151. </tr>
  152. <tr>
  153. <td class="name" nowrap><a href="#juce.Graphics:fillRect"><span class="proto_prefix">juce.Graphics</span>:fillRect (area)</a></td>
  154. <td class="summary">Fill rectangle with current fill type.</td>
  155. </tr>
  156. <tr>
  157. <td class="name" nowrap><a href="#juce.Graphics:fillRect_float"><span class="proto_prefix">juce.Graphics</span>:fillRect_float (x, y, width, height)</a></td>
  158. <td class="summary">Fill rectangle (sub-pixel accuracy).</td>
  159. </tr>
  160. <tr>
  161. <td class="name" nowrap><a href="#juce.Graphics:fillRoundedRectangle"><span class="proto_prefix">juce.Graphics</span>:fillRoundedRectangle<br> (x, y, width, height, cornerSize)</a></td>
  162. <td class="summary">Fill rounded rectangle.</td>
  163. </tr>
  164. <tr>
  165. <td class="name" nowrap><a href="#juce.Graphics:fillRoundedRectangle"><span class="proto_prefix">juce.Graphics</span>:fillRoundedRectangle (area, cornerSize)</a></td>
  166. <td class="summary">Fill rounded rectangle.</td>
  167. </tr>
  168. <tr>
  169. <td class="name" nowrap><a href="#juce.Graphics:fillCheckerBoard"><span class="proto_prefix">juce.Graphics</span>:fillCheckerBoard<br> (area, checkWidth, checkHeight, colour1, colour2)</a></td>
  170. <td class="summary">Fill <em>chequerboard</em>.</td>
  171. </tr>
  172. <tr>
  173. <td class="name" nowrap><a href="#juce.Graphics:drawRect"><span class="proto_prefix">juce.Graphics</span>:drawRect<br> (x, y, width, height[, lineThickness=1])</a></td>
  174. <td class="summary">Draw rectangle.</td>
  175. </tr>
  176. <tr>
  177. <td class="name" nowrap><a href="#juce.Graphics:drawRect"><span class="proto_prefix">juce.Graphics</span>:drawRect (area[, lineThickness=1])</a></td>
  178. <td class="summary">Draw rectangle.</td>
  179. </tr>
  180. <tr>
  181. <td class="name" nowrap><a href="#juce.Graphics:drawRect_float"><span class="proto_prefix">juce.Graphics</span>:drawRect_float<br> (x, y, width, height[, lineThickness=1])</a></td>
  182. <td class="summary">Draw rect (sub-pixel accuracy).</td>
  183. </tr>
  184. <tr>
  185. <td class="name" nowrap><a href="#juce.Graphics:drawRect_float"><span class="proto_prefix">juce.Graphics</span>:drawRect_float (area[, lineThickness=1])</a></td>
  186. <td class="summary">Draw rect (sub-pixel accuracy).</td>
  187. </tr>
  188. <tr>
  189. <td class="name" nowrap><a href="#juce.Graphics:drawRoundedRectangle"><span class="proto_prefix">juce.Graphics</span>:drawRoundedRectangle<br> (x, y, width, height, cornerSize[, lineThickness=1])</a></td>
  190. <td class="summary">Draw rounded rectangle.</td>
  191. </tr>
  192. <tr>
  193. <td class="name" nowrap><a href="#juce.Graphics:drawRoundedRectangle"><span class="proto_prefix">juce.Graphics</span>:drawRoundedRectangle<br> (area, cornerSize[, lineThickness=1])</a></td>
  194. <td class="summary">Draw rounded rectangle.</td>
  195. </tr>
  196. <tr>
  197. <td class="name" nowrap><a href="#juce.Graphics:setPixel"><span class="proto_prefix">juce.Graphics</span>:setPixel (x, y)</a></td>
  198. <td class="summary">Set pixel with current colour.</td>
  199. </tr>
  200. <tr>
  201. <td class="name" nowrap><a href="#juce.Graphics:fillEllipse"><span class="proto_prefix">juce.Graphics</span>:fillEllipse (x, y, width, height)</a></td>
  202. <td class="summary">Fill ellipse with current fill.</td>
  203. </tr>
  204. <tr>
  205. <td class="name" nowrap><a href="#juce.Graphics:drawEllipse"><span class="proto_prefix">juce.Graphics</span>:drawEllipse<br> (x, y, width, height[, lineThickness=1])</a></td>
  206. <td class="summary">Draw ellipse with current colour.</td>
  207. </tr>
  208. <tr>
  209. <td class="name" nowrap><a href="#juce.Graphics:drawLine"><span class="proto_prefix">juce.Graphics</span>:drawLine<br> (startX, startY, endX, endY[, lineThickness=1])</a></td>
  210. <td class="summary">Draw line.</td>
  211. </tr>
  212. <tr>
  213. <td class="name" nowrap><a href="#juce.Graphics:drawLine"><span class="proto_prefix">juce.Graphics</span>:drawLine (line[, lineThickness=1])</a></td>
  214. <td class="summary">Draw line.</td>
  215. </tr>
  216. <tr>
  217. <td class="name" nowrap><a href="#juce.Graphics:drawDashedLine"><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawDashedLine<br> (line, dashLengths, numDashLengths[, lineThickness=1[, dashIndexToStartFrom=0]])</span></a></td>
  218. <td class="summary">Draw dashed line.</td>
  219. </tr>
  220. <tr>
  221. <td class="name" nowrap><a href="#juce.Graphics:drawVerticalLine"><span class="proto_prefix">juce.Graphics</span>:drawVerticalLine (x, top, bottom)</a></td>
  222. <td class="summary">Draw vertical line.</td>
  223. </tr>
  224. <tr>
  225. <td class="name" nowrap><a href="#juce.Graphics:drawHorizontalLine"><span class="proto_prefix">juce.Graphics</span>:drawHorizontalLine (y, left, right)</a></td>
  226. <td class="summary">Draw horizontal line.</td>
  227. </tr>
  228. <tr>
  229. <td class="name" nowrap><a href="#juce.Graphics:fillPath"><span class="proto_prefix">juce.Graphics</span>:fillPath<br> (path[, transform=juce.AffineTransform.identity])</a></td>
  230. <td class="summary">Fill path.</td>
  231. </tr>
  232. <tr>
  233. <td class="name" nowrap><a href="#juce.Graphics:strokePath"><span class="proto_prefix">juce.Graphics</span>:strokePath (path[, args])</a></td>
  234. <td class="summary">Stroke path.</td>
  235. </tr>
  236. <tr>
  237. <td class="name" nowrap><a href="#juce.Graphics:drawArrow"><span class="proto_prefix">juce.Graphics</span>:drawArrow<br> (line, lineThickness, arrowheadWidth, arrowheadLength)</a></td>
  238. <td class="summary">Draw arrow.</td>
  239. </tr>
  240. <tr>
  241. <td class="name" nowrap><a href="#juce.Graphics:setImageResamplingQuality"><span class="proto_prefix">juce.Graphics</span>:setImageResamplingQuality (newQuality)</a></td>
  242. <td class="summary">Set image resampling quality.</td>
  243. </tr>
  244. <tr>
  245. <td class="name" nowrap><a href="#juce.Graphics:drawImageAt"><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawImageAt<br> (imageToDraw, topLeftX, topLeftY[, fillAlphaChannelWithCurrentBrush=false])</span></a></td>
  246. <td class="summary">Draw unscaled image at location.</td>
  247. </tr>
  248. <tr>
  249. <td class="name" nowrap><a href="#juce.Graphics:drawImage"><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawImage<br> (imageToDraw, destX, destY, destWidth, destHeight, sourceX, sourceY, sourceWidth, sourceHeight[, fillAlphaChannelWithCurrentBrush=false])</span></a></td>
  250. <td class="summary">Draw a portion of an image, stretched into a target rectangle.</td>
  251. </tr>
  252. <tr>
  253. <td class="name" nowrap><a href="#juce.Graphics:drawImageTransformed"><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawImageTransformed<br> (imageToDraw, transform[, fillAlphaChannelWithCurrentBrush=false])</span></a></td>
  254. <td class="summary">Draw transformed image.</td>
  255. </tr>
  256. <tr>
  257. <td class="name" nowrap><a href="#juce.Graphics:drawImageWithin"><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawImageWithin<br> (imageToDraw, destX, destY, destWidth, destHeight[, placementWithinTarget=juce.RectanglePlacement.centred[, fillAlphaChannelWithCurrentBrush=false]])</span></a></td>
  258. <td class="summary">Draw image within.</td>
  259. </tr>
  260. <tr>
  261. <td class="name" nowrap><a href="#juce.Graphics:getClipBounds"><span class="proto_prefix">juce.Graphics</span>:getClipBounds ()</a></td>
  262. <td class="summary">Get clip bounds.</td>
  263. </tr>
  264. <tr>
  265. <td class="name" nowrap><a href="#juce.Graphics:clipRegionIntersects"><span class="proto_prefix">juce.Graphics</span>:clipRegionIntersects ()</a></td>
  266. <td class="summary">Clip region intersects.</td>
  267. </tr>
  268. <tr>
  269. <td class="name" nowrap><a href="#juce.Graphics:isClipEmpty"><span class="proto_prefix">juce.Graphics</span>:isClipEmpty ()</a></td>
  270. <td class="summary">Is clipping region empty.</td>
  271. </tr>
  272. <tr>
  273. <td class="name" nowrap><a href="#juce.Graphics:saveState"><span class="proto_prefix">juce.Graphics</span>:saveState ()</a></td>
  274. <td class="summary">Save state.</td>
  275. </tr>
  276. <tr>
  277. <td class="name" nowrap><a href="#juce.Graphics:restoreState"><span class="proto_prefix">juce.Graphics</span>:restoreState ()</a></td>
  278. <td class="summary">Restore state.</td>
  279. </tr>
  280. <tr>
  281. <td class="name" nowrap><a href="#juce.Graphics:beginTransparencyLayer"><span class="proto_prefix">juce.Graphics</span>:beginTransparencyLayer ()</a></td>
  282. <td class="summary">Begin transparency layer.</td>
  283. </tr>
  284. <tr>
  285. <td class="name" nowrap><a href="#juce.Graphics:endTransparencyLayer"><span class="proto_prefix">juce.Graphics</span>:endTransparencyLayer ()</a></td>
  286. <td class="summary">End transparency layer.</td>
  287. </tr>
  288. <tr>
  289. <td class="name" nowrap><a href="#juce.Graphics:setOrigin"><span class="proto_prefix">juce.Graphics</span>:setOrigin (newOriginX, newOriginY)</a></td>
  290. <td class="summary">Set origin.</td>
  291. </tr>
  292. <tr>
  293. <td class="name" nowrap><a href="#juce.Graphics:addTransform"><span class="proto_prefix">juce.Graphics</span>:addTransform (transform)</a></td>
  294. <td class="summary">Add a transformation matrix.</td>
  295. </tr>
  296. <tr>
  297. <td class="name" nowrap><a href="#juce.Graphics:resetToDefaultState"><span class="proto_prefix">juce.Graphics</span>:resetToDefaultState ()</a></td>
  298. <td class="summary">Reset to default state.</td>
  299. </tr>
  300. <tr>
  301. <td class="name" nowrap><a href="#juce.Graphics:isVectorDevice"><span class="proto_prefix">juce.Graphics</span>:isVectorDevice ()</a></td>
  302. <td class="summary">Is vector device.</td>
  303. </tr>
  304. </table>
  305. <h2><a href="#Tables">Tables</a></h2>
  306. <table class="function_list">
  307. <tr>
  308. <td class="name" nowrap><a href="#juce.Graphics.ResamplingQuality"><span class="proto_prefix">juce.Graphics</span>.ResamplingQuality</a></td>
  309. <td class="summary">Resampling qualities.</td>
  310. </tr>
  311. </table>
  312. <br/>
  313. <br/>
  314. <h2><a name="Constructors"></a>Constructors</h2>
  315. <dl class="function">
  316. <dt>
  317. <a name = "juce.Graphics.Graphics"></a>
  318. <strong><span class="proto_prefix">juce</span>.Graphics (imageToDrawOnto)</strong>
  319. </dt>
  320. <dd>
  321. Constuct from a <a href="../classes/juce.Image.html#">juce.Image</a>.
  322. Use this constructor to draw directly onto an <a href="../classes/juce.Image.html#">juce.Image</a> in memory.</p>
  323. <p> A typical use is to can create a <a href="../classes/juce.Image.html#">juce.Image</a> object and use it as a
  324. backbuffer for pre-rendering graphics.
  325. </ul>
  326. <h3>Parameters:</h3>
  327. <ul>
  328. <li><span class="parameter">imageToDrawOnto</span>
  329. <span class="types"><a class="type" href="../classes/juce.Image.html#">juce.Image</a></span>
  330. </li>
  331. </ul>
  332. </dd>
  333. </dl>
  334. <h2><a name="Methods"></a>Methods</h2>
  335. <dl class="function">
  336. <dt>
  337. <a name = "juce.Graphics:setColour"></a>
  338. <strong><span class="proto_prefix">juce.Graphics</span>:setColour (newColour)</strong>
  339. </dt>
  340. <dd>
  341. Set working colour.
  342. Set the colour to be used for subsequent calls such as <a href="../classes/juce.Graphics.html#juce.Graphics:drawRect">drawRect</a> and <a href="../classes/juce.Graphics.html#juce.Graphics:drawText">drawText</a>.
  343. </ul>
  344. <h3>Parameters:</h3>
  345. <ul>
  346. <li><span class="parameter">newColour</span>
  347. <span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span>
  348. </li>
  349. </ul>
  350. </dd>
  351. <dt>
  352. <a name = "juce.Graphics:setOpacity"></a>
  353. <strong><span class="proto_prefix">juce.Graphics</span>:setOpacity (newOpacity)</strong>
  354. </dt>
  355. <dd>
  356. Set working opacity.
  357. Set the opacity to be used for subsequent calls.
  358. </ul>
  359. <h3>Parameters:</h3>
  360. <ul>
  361. <li><span class="parameter">newOpacity</span>
  362. </li>
  363. </ul>
  364. </dd>
  365. <dt>
  366. <a name = "juce.Graphics:setGradientFill"></a>
  367. <strong><span class="proto_prefix">juce.Graphics</span>:setGradientFill (gradient)</strong>
  368. </dt>
  369. <dd>
  370. Set working Gradient.
  371. Use a gradient as fill for subsequent calls such as <a href="../classes/juce.Graphics.html#juce.Graphics:fillRect">fillRect</a>.
  372. </ul>
  373. <h3>Parameters:</h3>
  374. <ul>
  375. <li><span class="parameter">gradient</span>
  376. <span class="types"><a class="type" href="../classes/juce.ColourGradient.html#">juce.ColourGradient</a></span>
  377. </li>
  378. </ul>
  379. </dd>
  380. <dt>
  381. <a name = "juce.Graphics:setTiledImageFill"></a>
  382. <strong><span class="proto_prefix">juce.Graphics</span>:setTiledImageFill<br> (imageToUse, anchorX, anchorY, opacity)</strong>
  383. </dt>
  384. <dd>
  385. Set Tiled Image Fill.
  386. Use a tiled image as fill for subsequent calls such as <a href="../classes/juce.Graphics.html#juce.Graphics:fillRect">fillRect</a>.
  387. </ul>
  388. <h3>Parameters:</h3>
  389. <ul>
  390. <li><span class="parameter">imageToUse</span>
  391. <span class="types"><a class="type" href="../classes/juce.Image.html#">juce.Image</a></span>
  392. </li>
  393. <li><span class="parameter">anchorX</span>
  394. </li>
  395. <li><span class="parameter">anchorY</span>
  396. </li>
  397. <li><span class="parameter">opacity</span>
  398. </li>
  399. </ul>
  400. </dd>
  401. <dt>
  402. <a name = "juce.Graphics:setFillType"></a>
  403. <strong><span class="proto_prefix">juce.Graphics</span>:setFillType (newFill)</strong>
  404. </dt>
  405. <dd>
  406. Set Fill.
  407. </ul>
  408. <h3>Parameters:</h3>
  409. <ul>
  410. <li><span class="parameter">newFill</span>
  411. <span class="types"><a class="type" href="../classes/juce.FillType.html#">juce.FillType</a></span>
  412. </li>
  413. </ul>
  414. </dd>
  415. <dt>
  416. <a name = "juce.Graphics:setFont"></a>
  417. <strong><span class="proto_prefix">juce.Graphics</span>:setFont (newFont)</strong>
  418. </dt>
  419. <dd>
  420. Set Font.
  421. </ul>
  422. <h3>Parameters:</h3>
  423. <ul>
  424. <li><span class="parameter">newFont</span>
  425. <span class="types"><a class="type" href="../classes/juce.Font.html#">juce.Font</a></span>
  426. </li>
  427. </ul>
  428. </dd>
  429. <dt>
  430. <a name = "juce.Graphics:setFont"></a>
  431. <strong><span class="proto_prefix">juce.Graphics</span>:setFont (newFontHeight)</strong>
  432. </dt>
  433. <dd>
  434. Set Font.
  435. </ul>
  436. <h3>Parameters:</h3>
  437. <ul>
  438. <li><span class="parameter">newFontHeight</span>
  439. <span class="types"><span class="type">number</span></span>
  440. </li>
  441. </ul>
  442. </dd>
  443. <dt>
  444. <a name = "juce.Graphics:getCurrentFont"></a>
  445. <strong><span class="proto_prefix">juce.Graphics</span>:getCurrentFont ()</strong>
  446. </dt>
  447. <dd>
  448. Get Current Font.
  449. treturn juce.Font the current font
  450. </ul>
  451. </dd>
  452. <dt>
  453. <a name = "juce.Graphics:drawSingleLineText"></a>
  454. <strong><span class="proto_prefix">juce.Graphics</span>:drawSingleLineText<br> (text, startX, baselineY[, justification=Justification.left])</strong>
  455. </dt>
  456. <dd>
  457. Draw single line of text.
  458. </ul>
  459. <h3>Parameters:</h3>
  460. <ul>
  461. <li><span class="parameter">text</span>
  462. <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
  463. </li>
  464. <li><span class="parameter">startX</span>
  465. </li>
  466. <li><span class="parameter">baselineY</span>
  467. </li>
  468. <li><span class="parameter">justification</span>
  469. <span class="types"><a class="type" href="../classes/juce.Justification.html#">juce.Justification</a></span>
  470. (<em>default</em> Justification.left)
  471. </li>
  472. </ul>
  473. </dd>
  474. <dt>
  475. <a name = "juce.Graphics:drawMultiLineText"></a>
  476. <strong><span class="proto_prefix">juce.Graphics</span>:drawMultiLineText<br> (text, startX, baselineY, maximumLineWidth)</strong>
  477. </dt>
  478. <dd>
  479. Draw multiline text.
  480. </ul>
  481. <h3>Parameters:</h3>
  482. <ul>
  483. <li><span class="parameter">text</span>
  484. <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
  485. </li>
  486. <li><span class="parameter">startX</span>
  487. </li>
  488. <li><span class="parameter">baselineY</span>
  489. </li>
  490. <li><span class="parameter">maximumLineWidth</span>
  491. </li>
  492. </ul>
  493. </dd>
  494. <dt>
  495. <a name = "juce.Graphics:drawText"></a>
  496. <strong><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawText<br> (x, y, width, height[, justification=Justification.left[, useEllipsesIfTooBig=false]])</span></strong>
  497. </dt>
  498. <dd>
  499. Draw text.
  500. </ul>
  501. <h3>Parameters:</h3>
  502. <ul>
  503. <li><span class="parameter">x</span>
  504. </li>
  505. <li><span class="parameter">y</span>
  506. </li>
  507. <li><span class="parameter">width</span>
  508. </li>
  509. <li><span class="parameter">height</span>
  510. </li>
  511. <li><span class="parameter">justification</span>
  512. <span class="types"><a class="type" href="../classes/juce.Justification.html#">juce.Justification</a></span>
  513. (<em>default</em> Justification.left)
  514. </li>
  515. <li><span class="parameter">useEllipsesIfTooBig</span>
  516. (<em>default</em> false)
  517. </li>
  518. </ul>
  519. </dd>
  520. <dt>
  521. <a name = "juce.Graphics:drawText"></a>
  522. <strong><span class="proto_prefix">juce.Graphics</span>:drawText<br> (area[, justification=Justification.left[, useEllipsesIfTooBig=false]])</strong>
  523. </dt>
  524. <dd>
  525. Draw text.
  526. </ul>
  527. <h3>Parameters:</h3>
  528. <ul>
  529. <li><span class="parameter">area</span>
  530. <span class="types"><span class="type">juce.Rectangle_int</span></span>
  531. </li>
  532. <li><span class="parameter">justification</span>
  533. <span class="types"><a class="type" href="../classes/juce.Justification.html#">juce.Justification</a></span>
  534. (<em>default</em> Justification.left)
  535. </li>
  536. <li><span class="parameter">useEllipsesIfTooBig</span>
  537. (<em>default</em> false)
  538. </li>
  539. </ul>
  540. </dd>
  541. <dt>
  542. <a name = "juce.Graphics:drawFittedText"></a>
  543. <strong><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawFittedText<br> (x, y, width, height, justification, maximumNumberOfLines[, minimumHorizontalScale=0.7])</span></strong>
  544. </dt>
  545. <dd>
  546. Draw fitted text.
  547. Awkwardly squishes the font (up to minimumHorizontalScale) if necessary.
  548. </ul>
  549. <h3>Parameters:</h3>
  550. <ul>
  551. <li><span class="parameter">x</span>
  552. </li>
  553. <li><span class="parameter">y</span>
  554. </li>
  555. <li><span class="parameter">width</span>
  556. </li>
  557. <li><span class="parameter">height</span>
  558. </li>
  559. <li><span class="parameter">justification</span>
  560. <span class="types"><a class="type" href="../classes/juce.Justification.html#">juce.Justification</a></span>
  561. </li>
  562. <li><span class="parameter">maximumNumberOfLines</span>
  563. </li>
  564. <li><span class="parameter">minimumHorizontalScale</span>
  565. (<em>default</em> 0.7)
  566. </li>
  567. </ul>
  568. </dd>
  569. <dt>
  570. <a name = "juce.Graphics:drawFittedText"></a>
  571. <strong><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawFittedText<br> (area, justification, maximumNumberOfLines[, minimumHorizontalScale=0.7])</span></strong>
  572. </dt>
  573. <dd>
  574. Draw fitted text.
  575. Awkwardly squishes the font (up to minimumHorizontalScale) if necessary.
  576. </ul>
  577. <h3>Parameters:</h3>
  578. <ul>
  579. <li><span class="parameter">area</span>
  580. <span class="types"><span class="type">juce.Rectangle_int</span></span>
  581. </li>
  582. <li><span class="parameter">justification</span>
  583. <span class="types"><a class="type" href="../classes/juce.Justification.html#">juce.Justification</a></span>
  584. </li>
  585. <li><span class="parameter">maximumNumberOfLines</span>
  586. </li>
  587. <li><span class="parameter">minimumHorizontalScale</span>
  588. (<em>default</em> 0.7)
  589. </li>
  590. </ul>
  591. </dd>
  592. <dt>
  593. <a name = "juce.Graphics:fillAll"></a>
  594. <strong><span class="proto_prefix">juce.Graphics</span>:fillAll ([colourToUse])</strong>
  595. </dt>
  596. <dd>
  597. Fill the entire graphics target.
  598. </ul>
  599. <h3>Parameters:</h3>
  600. <ul>
  601. <li><span class="parameter">colourToUse</span>
  602. <span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span>
  603. </li>
  604. </ul>
  605. </dd>
  606. <dt>
  607. <a name = "juce.Graphics:fillRect"></a>
  608. <strong><span class="proto_prefix">juce.Graphics</span>:fillRect (x, y, width, height)</strong>
  609. </dt>
  610. <dd>
  611. Fill rectangle with current fill type.
  612. </ul>
  613. <h3>Parameters:</h3>
  614. <ul>
  615. <li><span class="parameter">x</span>
  616. </li>
  617. <li><span class="parameter">y</span>
  618. </li>
  619. <li><span class="parameter">width</span>
  620. </li>
  621. <li><span class="parameter">height</span>
  622. </li>
  623. </ul>
  624. </dd>
  625. <dt>
  626. <a name = "juce.Graphics:fillRect"></a>
  627. <strong><span class="proto_prefix">juce.Graphics</span>:fillRect (area)</strong>
  628. </dt>
  629. <dd>
  630. Fill rectangle with current fill type.
  631. </ul>
  632. <h3>Parameters:</h3>
  633. <ul>
  634. <li><span class="parameter">area</span>
  635. <span class="types"><span class="type">juce.Rectangle_int</span></span>
  636. </li>
  637. </ul>
  638. </dd>
  639. <dt>
  640. <a name = "juce.Graphics:fillRect_float"></a>
  641. <strong><span class="proto_prefix">juce.Graphics</span>:fillRect_float (x, y, width, height)</strong>
  642. </dt>
  643. <dd>
  644. Fill rectangle (sub-pixel accuracy).
  645. </ul>
  646. <h3>Parameters:</h3>
  647. <ul>
  648. <li><span class="parameter">x</span>
  649. </li>
  650. <li><span class="parameter">y</span>
  651. </li>
  652. <li><span class="parameter">width</span>
  653. </li>
  654. <li><span class="parameter">height</span>
  655. </li>
  656. </ul>
  657. </dd>
  658. <dt>
  659. <a name = "juce.Graphics:fillRoundedRectangle"></a>
  660. <strong><span class="proto_prefix">juce.Graphics</span>:fillRoundedRectangle<br> (x, y, width, height, cornerSize)</strong>
  661. </dt>
  662. <dd>
  663. Fill rounded rectangle.
  664. </ul>
  665. <h3>Parameters:</h3>
  666. <ul>
  667. <li><span class="parameter">x</span>
  668. </li>
  669. <li><span class="parameter">y</span>
  670. </li>
  671. <li><span class="parameter">width</span>
  672. </li>
  673. <li><span class="parameter">height</span>
  674. </li>
  675. <li><span class="parameter">cornerSize</span>
  676. </li>
  677. </ul>
  678. </dd>
  679. <dt>
  680. <a name = "juce.Graphics:fillRoundedRectangle"></a>
  681. <strong><span class="proto_prefix">juce.Graphics</span>:fillRoundedRectangle (area, cornerSize)</strong>
  682. </dt>
  683. <dd>
  684. Fill rounded rectangle.
  685. </ul>
  686. <h3>Parameters:</h3>
  687. <ul>
  688. <li><span class="parameter">area</span>
  689. <span class="types"><span class="type">juce.Rectangle_int</span></span>
  690. </li>
  691. <li><span class="parameter">cornerSize</span>
  692. </li>
  693. </ul>
  694. </dd>
  695. <dt>
  696. <a name = "juce.Graphics:fillCheckerBoard"></a>
  697. <strong><span class="proto_prefix">juce.Graphics</span>:fillCheckerBoard<br> (area, checkWidth, checkHeight, colour1, colour2)</strong>
  698. </dt>
  699. <dd>
  700. Fill <em>chequerboard</em>.
  701. (and i thought juce used British spelling)
  702. </ul>
  703. <h3>Parameters:</h3>
  704. <ul>
  705. <li><span class="parameter">area</span>
  706. <span class="types"><span class="type">juce.Rectangle_int</span></span>
  707. </li>
  708. <li><span class="parameter">checkWidth</span>
  709. </li>
  710. <li><span class="parameter">checkHeight</span>
  711. </li>
  712. <li><span class="parameter">colour1</span>
  713. <span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span>
  714. </li>
  715. <li><span class="parameter">colour2</span>
  716. <span class="types"><a class="type" href="../classes/juce.Colour.html#">juce.Colour</a></span>
  717. </li>
  718. </ul>
  719. </dd>
  720. <dt>
  721. <a name = "juce.Graphics:drawRect"></a>
  722. <strong><span class="proto_prefix">juce.Graphics</span>:drawRect<br> (x, y, width, height[, lineThickness=1])</strong>
  723. </dt>
  724. <dd>
  725. Draw rectangle.
  726. </ul>
  727. <h3>Parameters:</h3>
  728. <ul>
  729. <li><span class="parameter">x</span>
  730. </li>
  731. <li><span class="parameter">y</span>
  732. </li>
  733. <li><span class="parameter">width</span>
  734. </li>
  735. <li><span class="parameter">height</span>
  736. </li>
  737. <li><span class="parameter">lineThickness</span>
  738. (<em>default</em> 1)
  739. </li>
  740. </ul>
  741. </dd>
  742. <dt>
  743. <a name = "juce.Graphics:drawRect"></a>
  744. <strong><span class="proto_prefix">juce.Graphics</span>:drawRect (area[, lineThickness=1])</strong>
  745. </dt>
  746. <dd>
  747. Draw rectangle.
  748. </ul>
  749. <h3>Parameters:</h3>
  750. <ul>
  751. <li><span class="parameter">area</span>
  752. <span class="types"><span class="type">juce.Rectangle_int</span></span>
  753. </li>
  754. <li><span class="parameter">lineThickness</span>
  755. (<em>default</em> 1)
  756. </li>
  757. </ul>
  758. </dd>
  759. <dt>
  760. <a name = "juce.Graphics:drawRect_float"></a>
  761. <strong><span class="proto_prefix">juce.Graphics</span>:drawRect_float<br> (x, y, width, height[, lineThickness=1])</strong>
  762. </dt>
  763. <dd>
  764. Draw rect (sub-pixel accuracy).
  765. </ul>
  766. <h3>Parameters:</h3>
  767. <ul>
  768. <li><span class="parameter">x</span>
  769. </li>
  770. <li><span class="parameter">y</span>
  771. </li>
  772. <li><span class="parameter">width</span>
  773. </li>
  774. <li><span class="parameter">height</span>
  775. </li>
  776. <li><span class="parameter">lineThickness</span>
  777. (<em>default</em> 1)
  778. </li>
  779. </ul>
  780. </dd>
  781. <dt>
  782. <a name = "juce.Graphics:drawRect_float"></a>
  783. <strong><span class="proto_prefix">juce.Graphics</span>:drawRect_float (area[, lineThickness=1])</strong>
  784. </dt>
  785. <dd>
  786. Draw rect (sub-pixel accuracy).
  787. </ul>
  788. <h3>Parameters:</h3>
  789. <ul>
  790. <li><span class="parameter">area</span>
  791. <span class="types"><span class="type">juce.Rectangle_int</span></span>
  792. </li>
  793. <li><span class="parameter">lineThickness</span>
  794. (<em>default</em> 1)
  795. </li>
  796. </ul>
  797. </dd>
  798. <dt>
  799. <a name = "juce.Graphics:drawRoundedRectangle"></a>
  800. <strong><span class="proto_prefix">juce.Graphics</span>:drawRoundedRectangle<br> (x, y, width, height, cornerSize[, lineThickness=1])</strong>
  801. </dt>
  802. <dd>
  803. Draw rounded rectangle.
  804. </ul>
  805. <h3>Parameters:</h3>
  806. <ul>
  807. <li><span class="parameter">x</span>
  808. </li>
  809. <li><span class="parameter">y</span>
  810. </li>
  811. <li><span class="parameter">width</span>
  812. </li>
  813. <li><span class="parameter">height</span>
  814. </li>
  815. <li><span class="parameter">cornerSize</span>
  816. </li>
  817. <li><span class="parameter">lineThickness</span>
  818. (<em>default</em> 1)
  819. </li>
  820. </ul>
  821. </dd>
  822. <dt>
  823. <a name = "juce.Graphics:drawRoundedRectangle"></a>
  824. <strong><span class="proto_prefix">juce.Graphics</span>:drawRoundedRectangle<br> (area, cornerSize[, lineThickness=1])</strong>
  825. </dt>
  826. <dd>
  827. Draw rounded rectangle.
  828. </ul>
  829. <h3>Parameters:</h3>
  830. <ul>
  831. <li><span class="parameter">area</span>
  832. <span class="types"><span class="type">juce.Rectangle_int</span></span>
  833. </li>
  834. <li><span class="parameter">cornerSize</span>
  835. </li>
  836. <li><span class="parameter">lineThickness</span>
  837. (<em>default</em> 1)
  838. </li>
  839. </ul>
  840. </dd>
  841. <dt>
  842. <a name = "juce.Graphics:setPixel"></a>
  843. <strong><span class="proto_prefix">juce.Graphics</span>:setPixel (x, y)</strong>
  844. </dt>
  845. <dd>
  846. Set pixel with current colour.
  847. </ul>
  848. <h3>Parameters:</h3>
  849. <ul>
  850. <li><span class="parameter">x</span>
  851. </li>
  852. <li><span class="parameter">y</span>
  853. </li>
  854. </ul>
  855. </dd>
  856. <dt>
  857. <a name = "juce.Graphics:fillEllipse"></a>
  858. <strong><span class="proto_prefix">juce.Graphics</span>:fillEllipse (x, y, width, height)</strong>
  859. </dt>
  860. <dd>
  861. Fill ellipse with current fill.
  862. </ul>
  863. <h3>Parameters:</h3>
  864. <ul>
  865. <li><span class="parameter">x</span>
  866. </li>
  867. <li><span class="parameter">y</span>
  868. </li>
  869. <li><span class="parameter">width</span>
  870. </li>
  871. <li><span class="parameter">height</span>
  872. </li>
  873. </ul>
  874. </dd>
  875. <dt>
  876. <a name = "juce.Graphics:drawEllipse"></a>
  877. <strong><span class="proto_prefix">juce.Graphics</span>:drawEllipse<br> (x, y, width, height[, lineThickness=1])</strong>
  878. </dt>
  879. <dd>
  880. Draw ellipse with current colour.
  881. </ul>
  882. <h3>Parameters:</h3>
  883. <ul>
  884. <li><span class="parameter">x</span>
  885. </li>
  886. <li><span class="parameter">y</span>
  887. </li>
  888. <li><span class="parameter">width</span>
  889. </li>
  890. <li><span class="parameter">height</span>
  891. </li>
  892. <li><span class="parameter">lineThickness</span>
  893. (<em>default</em> 1)
  894. </li>
  895. </ul>
  896. </dd>
  897. <dt>
  898. <a name = "juce.Graphics:drawLine"></a>
  899. <strong><span class="proto_prefix">juce.Graphics</span>:drawLine<br> (startX, startY, endX, endY[, lineThickness=1])</strong>
  900. </dt>
  901. <dd>
  902. Draw line.
  903. </ul>
  904. <h3>Parameters:</h3>
  905. <ul>
  906. <li><span class="parameter">startX</span>
  907. </li>
  908. <li><span class="parameter">startY</span>
  909. </li>
  910. <li><span class="parameter">endX</span>
  911. </li>
  912. <li><span class="parameter">endY</span>
  913. </li>
  914. <li><span class="parameter">lineThickness</span>
  915. (<em>default</em> 1)
  916. </li>
  917. </ul>
  918. </dd>
  919. <dt>
  920. <a name = "juce.Graphics:drawLine"></a>
  921. <strong><span class="proto_prefix">juce.Graphics</span>:drawLine (line[, lineThickness=1])</strong>
  922. </dt>
  923. <dd>
  924. Draw line.
  925. </ul>
  926. <h3>Parameters:</h3>
  927. <ul>
  928. <li><span class="parameter">line</span>
  929. <span class="types"><a class="type" href="../classes/juce.Line.html#">juce.Line</a></span>
  930. </li>
  931. <li><span class="parameter">lineThickness</span>
  932. (<em>default</em> 1)
  933. </li>
  934. </ul>
  935. </dd>
  936. <dt>
  937. <a name = "juce.Graphics:drawDashedLine"></a>
  938. <strong><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawDashedLine<br> (line, dashLengths, numDashLengths[, lineThickness=1[, dashIndexToStartFrom=0]])</span></strong>
  939. </dt>
  940. <dd>
  941. Draw dashed line.
  942. </ul>
  943. <h3>Parameters:</h3>
  944. <ul>
  945. <li><span class="parameter">line</span>
  946. <span class="types"><a class="type" href="../classes/juce.Line.html#">juce.Line</a></span>
  947. </li>
  948. <li><span class="parameter">dashLengths</span>
  949. (const float* ctype)
  950. </li>
  951. <li><span class="parameter">numDashLengths</span>
  952. </li>
  953. <li><span class="parameter">lineThickness</span>
  954. (<em>default</em> 1)
  955. </li>
  956. <li><span class="parameter">dashIndexToStartFrom</span>
  957. (<em>default</em> 0)
  958. </li>
  959. </ul>
  960. </dd>
  961. <dt>
  962. <a name = "juce.Graphics:drawVerticalLine"></a>
  963. <strong><span class="proto_prefix">juce.Graphics</span>:drawVerticalLine (x, top, bottom)</strong>
  964. </dt>
  965. <dd>
  966. Draw vertical line.
  967. </ul>
  968. <h3>Parameters:</h3>
  969. <ul>
  970. <li><span class="parameter">x</span>
  971. </li>
  972. <li><span class="parameter">top</span>
  973. </li>
  974. <li><span class="parameter">bottom</span>
  975. </li>
  976. </ul>
  977. </dd>
  978. <dt>
  979. <a name = "juce.Graphics:drawHorizontalLine"></a>
  980. <strong><span class="proto_prefix">juce.Graphics</span>:drawHorizontalLine (y, left, right)</strong>
  981. </dt>
  982. <dd>
  983. Draw horizontal line.
  984. </ul>
  985. <h3>Parameters:</h3>
  986. <ul>
  987. <li><span class="parameter">y</span>
  988. </li>
  989. <li><span class="parameter">left</span>
  990. </li>
  991. <li><span class="parameter">right</span>
  992. </li>
  993. </ul>
  994. </dd>
  995. <dt>
  996. <a name = "juce.Graphics:fillPath"></a>
  997. <strong><span class="proto_prefix">juce.Graphics</span>:fillPath<br> (path[, transform=juce.AffineTransform.identity])</strong>
  998. </dt>
  999. <dd>
  1000. Fill path.
  1001. </ul>
  1002. <h3>Parameters:</h3>
  1003. <ul>
  1004. <li><span class="parameter">path</span>
  1005. <span class="types"><a class="type" href="../classes/juce.Path.html#">juce.Path</a></span>
  1006. </li>
  1007. <li><span class="parameter">transform</span>
  1008. <span class="types"><a class="type" href="../classes/juce.AffineTransform.html#">juce.AffineTransform</a></span>
  1009. (<em>default</em> juce.AffineTransform.identity)
  1010. </li>
  1011. </ul>
  1012. </dd>
  1013. <dt>
  1014. <a name = "juce.Graphics:strokePath"></a>
  1015. <strong><span class="proto_prefix">juce.Graphics</span>:strokePath (path[, args])</strong>
  1016. </dt>
  1017. <dd>
  1018. Stroke path.
  1019. All named arguments are optional
  1020. </ul>
  1021. <h3>Parameters:</h3>
  1022. <ul>
  1023. <li><span class="parameter">path</span>
  1024. <span class="types"><a class="type" href="../classes/juce.Path.html#">juce.Path</a></span>
  1025. </li>
  1026. <li><span class="parameter">args</span>
  1027. <ul>
  1028. <li><span class="parameter">thickness</span>
  1029. </li>
  1030. <li><span class="parameter">jointStyle</span>
  1031. <span class="types"><a class="type" href="../classes/juce.Path.html#juce.Path.JointStyle">juce.Path.JointStyle</a></span>
  1032. <em>default</em> : juce.Path.JointStyle.mitered
  1033. </li>
  1034. <li><span class="parameter">endCapStyle</span>
  1035. <span class="types"><a class="type" href="../classes/juce.Path.html#juce.Path.EndCapStyle">juce.Path.EndCapStyle</a></span>
  1036. <em>default</em> : juce.Path.EndCapStyle.butt
  1037. </li>
  1038. <li><span class="parameter">transform</span>
  1039. <span class="types"><a class="type" href="../classes/juce.AffineTransform.html#">juce.AffineTransform</a></span>
  1040. <em>default</em> : juce.AffineTransform.identity
  1041. </li>
  1042. </li></ul>
  1043. </ul>
  1044. </dd>
  1045. <dt>
  1046. <a name = "juce.Graphics:drawArrow"></a>
  1047. <strong><span class="proto_prefix">juce.Graphics</span>:drawArrow<br> (line, lineThickness, arrowheadWidth, arrowheadLength)</strong>
  1048. </dt>
  1049. <dd>
  1050. Draw arrow.
  1051. </ul>
  1052. <h3>Parameters:</h3>
  1053. <ul>
  1054. <li><span class="parameter">line</span>
  1055. <span class="types"><a class="type" href="../classes/juce.Line.html#">juce.Line</a></span>
  1056. </li>
  1057. <li><span class="parameter">lineThickness</span>
  1058. </li>
  1059. <li><span class="parameter">arrowheadWidth</span>
  1060. </li>
  1061. <li><span class="parameter">arrowheadLength</span>
  1062. </li>
  1063. </ul>
  1064. </dd>
  1065. <dt>
  1066. <a name = "juce.Graphics:setImageResamplingQuality"></a>
  1067. <strong><span class="proto_prefix">juce.Graphics</span>:setImageResamplingQuality (newQuality)</strong>
  1068. </dt>
  1069. <dd>
  1070. Set image resampling quality.
  1071. </ul>
  1072. <h3>Parameters:</h3>
  1073. <ul>
  1074. <li><span class="parameter">newQuality</span>
  1075. <span class="types"><a class="type" href="../classes/juce.Graphics.html#juce.Graphics.ResamplingQuality">juce.Graphics.ResamplingQuality</a></span>
  1076. </li>
  1077. </ul>
  1078. </dd>
  1079. <dt>
  1080. <a name = "juce.Graphics:drawImageAt"></a>
  1081. <strong><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawImageAt<br> (imageToDraw, topLeftX, topLeftY[, fillAlphaChannelWithCurrentBrush=false])</span></strong>
  1082. </dt>
  1083. <dd>
  1084. Draw unscaled image at location.
  1085. </ul>
  1086. <h3>Parameters:</h3>
  1087. <ul>
  1088. <li><span class="parameter">imageToDraw</span>
  1089. <span class="types"><a class="type" href="../classes/juce.Image.html#">juce.Image</a></span>
  1090. </li>
  1091. <li><span class="parameter">topLeftX</span>
  1092. </li>
  1093. <li><span class="parameter">topLeftY</span>
  1094. </li>
  1095. <li><span class="parameter">fillAlphaChannelWithCurrentBrush</span>
  1096. (<em>default</em> false)
  1097. </li>
  1098. </ul>
  1099. </dd>
  1100. <dt>
  1101. <a name = "juce.Graphics:drawImage"></a>
  1102. <strong><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawImage<br> (imageToDraw, destX, destY, destWidth, destHeight, sourceX, sourceY, sourceWidth, sourceHeight[, fillAlphaChannelWithCurrentBrush=false])</span></strong>
  1103. </dt>
  1104. <dd>
  1105. Draw a portion of an image, stretched into a target rectangle.
  1106. </ul>
  1107. <h3>Parameters:</h3>
  1108. <ul>
  1109. <li><span class="parameter">imageToDraw</span>
  1110. <span class="types"><a class="type" href="../classes/juce.Image.html#">juce.Image</a></span>
  1111. </li>
  1112. <li><span class="parameter">destX</span>
  1113. </li>
  1114. <li><span class="parameter">destY</span>
  1115. </li>
  1116. <li><span class="parameter">destWidth</span>
  1117. </li>
  1118. <li><span class="parameter">destHeight</span>
  1119. </li>
  1120. <li><span class="parameter">sourceX</span>
  1121. </li>
  1122. <li><span class="parameter">sourceY</span>
  1123. </li>
  1124. <li><span class="parameter">sourceWidth</span>
  1125. </li>
  1126. <li><span class="parameter">sourceHeight</span>
  1127. </li>
  1128. <li><span class="parameter">fillAlphaChannelWithCurrentBrush</span>
  1129. (<em>default</em> false)
  1130. </li>
  1131. </ul>
  1132. </dd>
  1133. <dt>
  1134. <a name = "juce.Graphics:drawImageTransformed"></a>
  1135. <strong><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawImageTransformed<br> (imageToDraw, transform[, fillAlphaChannelWithCurrentBrush=false])</span></strong>
  1136. </dt>
  1137. <dd>
  1138. Draw transformed image.
  1139. </ul>
  1140. <h3>Parameters:</h3>
  1141. <ul>
  1142. <li><span class="parameter">imageToDraw</span>
  1143. <span class="types"><a class="type" href="../classes/juce.Image.html#">juce.Image</a></span>
  1144. </li>
  1145. <li><span class="parameter">transform</span>
  1146. <span class="types"><a class="type" href="../classes/juce.AffineTransform.html#">juce.AffineTransform</a></span>
  1147. </li>
  1148. <li><span class="parameter">fillAlphaChannelWithCurrentBrush</span>
  1149. (<em>default</em> false)
  1150. </li>
  1151. </ul>
  1152. </dd>
  1153. <dt>
  1154. <a name = "juce.Graphics:drawImageWithin"></a>
  1155. <strong><span class="wrapman"><span class="proto_prefix">juce.Graphics</span>:drawImageWithin<br> (imageToDraw, destX, destY, destWidth, destHeight[, placementWithinTarget=juce.RectanglePlacement.centred[, fillAlphaChannelWithCurrentBrush=false]])</span></strong>
  1156. </dt>
  1157. <dd>
  1158. Draw image within.
  1159. </ul>
  1160. <h3>Parameters:</h3>
  1161. <ul>
  1162. <li><span class="parameter">imageToDraw</span>
  1163. <span class="types"><a class="type" href="../classes/juce.Image.html#">juce.Image</a></span>
  1164. </li>
  1165. <li><span class="parameter">destX</span>
  1166. </li>
  1167. <li><span class="parameter">destY</span>
  1168. </li>
  1169. <li><span class="parameter">destWidth</span>
  1170. </li>
  1171. <li><span class="parameter">destHeight</span>
  1172. </li>
  1173. <li><span class="parameter">placementWithinTarget</span>
  1174. (<em>default</em> juce.RectanglePlacement.centred)
  1175. </li>
  1176. <li><span class="parameter">fillAlphaChannelWithCurrentBrush</span>
  1177. (<em>default</em> false)
  1178. </li>
  1179. </ul>
  1180. </dd>
  1181. <dt>
  1182. <a name = "juce.Graphics:getClipBounds"></a>
  1183. <strong><span class="proto_prefix">juce.Graphics</span>:getClipBounds ()</strong>
  1184. </dt>
  1185. <dd>
  1186. Get clip bounds.
  1187. Get the portion of the graphics target that needs to be redrawn.
  1188. </ul>
  1189. <h3>Returns:</h3>
  1190. <ol>
  1191. <span class="types"><span class="type">juce.Rectangle_int</span></span>
  1192. Clipping area
  1193. </ol>
  1194. </dd>
  1195. <dt>
  1196. <a name = "juce.Graphics:clipRegionIntersects"></a>
  1197. <strong><span class="proto_prefix">juce.Graphics</span>:clipRegionIntersects ()</strong>
  1198. </dt>
  1199. <dd>
  1200. Clip region intersects.
  1201. Check if a rectangle intersects with the redrawing region
  1202. </ul>
  1203. <h3>Returns:</h3>
  1204. <ol>
  1205. <li>
  1206. <span class="types"><span class="type">juce.Rectangle_int</span></span>
  1207. Clipping area</li>
  1208. <li>
  1209. <span class="types"><span class="type">boolean</span></span>
  1210. intersection check</li>
  1211. </ol>
  1212. </dd>
  1213. <dt>
  1214. <a name = "juce.Graphics:isClipEmpty"></a>
  1215. <strong><span class="proto_prefix">juce.Graphics</span>:isClipEmpty ()</strong>
  1216. </dt>
  1217. <dd>
  1218. Is clipping region empty.
  1219. </ul>
  1220. <h3>Returns:</h3>
  1221. <ol>
  1222. <span class="types"><span class="type">boolean</span></span>
  1223. whether the redrawing area is empty
  1224. </ol>
  1225. </dd>
  1226. <dt>
  1227. <a name = "juce.Graphics:saveState"></a>
  1228. <strong><span class="proto_prefix">juce.Graphics</span>:saveState ()</strong>
  1229. </dt>
  1230. <dd>
  1231. Save state.
  1232. Saves the current state of the graphics target on a stack.
  1233. This does not save the actual graphic's contents but its current
  1234. colour, transform, origin, etc.
  1235. </ul>
  1236. </dd>
  1237. <dt>
  1238. <a name = "juce.Graphics:restoreState"></a>
  1239. <strong><span class="proto_prefix">juce.Graphics</span>:restoreState ()</strong>
  1240. </dt>
  1241. <dd>
  1242. Restore state.
  1243. Restores a state of the graphics target from the stack.
  1244. Useful to cancel any previous uses
  1245. of <a href="../classes/juce.Graphics.html#juce.Graphics:addTransform">addTransform</a>, <a href="../classes/juce.Graphics.html#juce.Graphics:setColour">setColour</a>, etc.
  1246. </ul>
  1247. </dd>
  1248. <dt>
  1249. <a name = "juce.Graphics:beginTransparencyLayer"></a>
  1250. <strong><span class="proto_prefix">juce.Graphics</span>:beginTransparencyLayer ()</strong>
  1251. </dt>
  1252. <dd>
  1253. Begin transparency layer.
  1254. Saves the current state and begins drawing on a temporary layer,
  1255. to be applied with the specified final transparency.
  1256. </ul>
  1257. </dd>
  1258. <dt>
  1259. <a name = "juce.Graphics:endTransparencyLayer"></a>
  1260. <strong><span class="proto_prefix">juce.Graphics</span>:endTransparencyLayer ()</strong>
  1261. </dt>
  1262. <dd>
  1263. End transparency layer.
  1264. Applies the transparency layer that was started with <a href="../classes/juce.Graphics.html#juce.Graphics:beginTransparencyLayer">beginTransparencyLayer</a>.
  1265. </ul>
  1266. </dd>
  1267. <dt>
  1268. <a name = "juce.Graphics:setOrigin"></a>
  1269. <strong><span class="proto_prefix">juce.Graphics</span>:setOrigin (newOriginX, newOriginY)</strong>
  1270. </dt>
  1271. <dd>
  1272. Set origin.
  1273. </ul>
  1274. <h3>Parameters:</h3>
  1275. <ul>
  1276. <li><span class="parameter">newOriginX</span>
  1277. </li>
  1278. <li><span class="parameter">newOriginY</span>
  1279. </li>
  1280. </ul>
  1281. </dd>
  1282. <dt>
  1283. <a name = "juce.Graphics:addTransform"></a>
  1284. <strong><span class="proto_prefix">juce.Graphics</span>:addTransform (transform)</strong>
  1285. </dt>
  1286. <dd>
  1287. Add a transformation matrix.
  1288. The matrix will be chained onto the current one, and affect all
  1289. subsequent graphics operations. Use <a href="../classes/juce.Graphics.html#juce.Graphics:saveState">saveState</a> and <a href="../classes/juce.Graphics.html#juce.Graphics:restoreState">restoreState</a>
  1290. to apply a temporary transform.
  1291. </ul>
  1292. <h3>Parameters:</h3>
  1293. <ul>
  1294. <li><span class="parameter">transform</span>
  1295. <span class="types"><a class="type" href="../classes/juce.AffineTransform.html#">juce.AffineTransform</a></span>
  1296. </li>
  1297. </ul>
  1298. </dd>
  1299. <dt>
  1300. <a name = "juce.Graphics:resetToDefaultState"></a>
  1301. <strong><span class="proto_prefix">juce.Graphics</span>:resetToDefaultState ()</strong>
  1302. </dt>
  1303. <dd>
  1304. Reset to default state.
  1305. </ul>
  1306. </dd>
  1307. <dt>
  1308. <a name = "juce.Graphics:isVectorDevice"></a>
  1309. <strong><span class="proto_prefix">juce.Graphics</span>:isVectorDevice ()</strong>
  1310. </dt>
  1311. <dd>
  1312. Is vector device.
  1313. </ul>
  1314. <h3>Returns:</h3>
  1315. <ol>
  1316. <span class="types"><span class="type">boolean</span></span>
  1317. whether the target is a vector device.
  1318. </ol>
  1319. </dd>
  1320. </dl>
  1321. <h2><a name="Tables"></a>Tables</h2>
  1322. <dl class="function">
  1323. <dt>
  1324. <a name = "juce.Graphics.ResamplingQuality"></a>
  1325. <strong><span class="proto_prefix">juce.Graphics</span>.ResamplingQuality</strong>
  1326. </dt>
  1327. <dd>
  1328. Resampling qualities.
  1329. </ul>
  1330. <h3>Fields:</h3>
  1331. <ul>
  1332. <li><span class="parameter">low</span>
  1333. </li>
  1334. <li><span class="parameter">medium</span>
  1335. </li>
  1336. <li><span class="parameter">high</span>
  1337. </li>
  1338. </ul>
  1339. </dd>
  1340. </dl>
  1341. </div> <!-- id="content" -->
  1342. </div> <!-- id="main" -->
  1343. <div id="about">
  1344. <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>
  1345. </div> <!-- id="about" -->
  1346. </div> <!-- id="container" -->
  1347. </body>
  1348. </html>