DISTRHO Plugin Framework
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.

557 lines
25KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.11"/>
  7. <title>DISTRHO Plugin Framework: Color Struct Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">DISTRHO Plugin Framework
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.11 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  65. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. </div><!-- top -->
  83. <div class="header">
  84. <div class="summary">
  85. <a href="#pub-methods">Public Member Functions</a> &#124;
  86. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  87. <a href="#pub-attribs">Public Attributes</a> &#124;
  88. <a href="structColor-members.html">List of all members</a> </div>
  89. <div class="headertitle">
  90. <div class="title">Color Struct Reference</div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <p><code>#include &lt;<a class="el" href="Color_8hpp_source.html">Color.hpp</a>&gt;</code></p>
  94. <table class="memberdecls">
  95. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  96. Public Member Functions</h2></td></tr>
  97. <tr class="memitem:acbbdba6661c2bbd987ef27de59813b47"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structColor.html#acbbdba6661c2bbd987ef27de59813b47">Color</a> () noexcept</td></tr>
  98. <tr class="separator:acbbdba6661c2bbd987ef27de59813b47"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a6539e54d79570ad579207289d087af70"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structColor.html#a6539e54d79570ad579207289d087af70">Color</a> (int red, int green, int blue, int alpha=255) noexcept</td></tr>
  100. <tr class="separator:a6539e54d79570ad579207289d087af70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a77dd2b8f997aaf034c790ffd4ffe64bc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structColor.html#a77dd2b8f997aaf034c790ffd4ffe64bc">Color</a> (float red, float green, float blue, float alpha=1.0f) noexcept</td></tr>
  102. <tr class="separator:a77dd2b8f997aaf034c790ffd4ffe64bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a7ac8018890423379bf8cdce2c6bc9d7e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structColor.html#a7ac8018890423379bf8cdce2c6bc9d7e">Color</a> (const <a class="el" href="structColor.html">Color</a> &amp;color) noexcept</td></tr>
  104. <tr class="separator:a7ac8018890423379bf8cdce2c6bc9d7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a11aeda6f8f3b11c66e3df226c61b3473"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11aeda6f8f3b11c66e3df226c61b3473"></a>
  106. <a class="el" href="structColor.html">Color</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="structColor.html">Color</a> &amp;color) noexcept</td></tr>
  107. <tr class="separator:a11aeda6f8f3b11c66e3df226c61b3473"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a8d51b3f9457c1d9524ad67c94152b99a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structColor.html#a8d51b3f9457c1d9524ad67c94152b99a">Color</a> (const <a class="el" href="structColor.html">Color</a> &amp;color1, const <a class="el" href="structColor.html">Color</a> &amp;color2, float u) noexcept</td></tr>
  109. <tr class="separator:a8d51b3f9457c1d9524ad67c94152b99a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a96283f5b9ad6f6465e40f69012aca00f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structColor.html#a96283f5b9ad6f6465e40f69012aca00f">interpolate</a> (const <a class="el" href="structColor.html">Color</a> &amp;other, float u) noexcept</td></tr>
  111. <tr class="separator:a96283f5b9ad6f6465e40f69012aca00f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a16880d42b2d52ed23eb307ed2980a9a3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structColor.html#a16880d42b2d52ed23eb307ed2980a9a3">isEqual</a> (const <a class="el" href="structColor.html">Color</a> &amp;color, bool withAlpha=true) noexcept</td></tr>
  113. <tr class="separator:a16880d42b2d52ed23eb307ed2980a9a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:aa0e84f05c440907e331590430da2e2e6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0e84f05c440907e331590430da2e2e6"></a>
  115. bool&#160;</td><td class="memItemRight" valign="bottom"><b>isNotEqual</b> (const <a class="el" href="structColor.html">Color</a> &amp;color, bool withAlpha=true) noexcept</td></tr>
  116. <tr class="separator:aa0e84f05c440907e331590430da2e2e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a3aa26bd1c31ea638f6fc1c06d4ee168e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3aa26bd1c31ea638f6fc1c06d4ee168e"></a>
  118. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="structColor.html">Color</a> &amp;color) noexcept</td></tr>
  119. <tr class="separator:a3aa26bd1c31ea638f6fc1c06d4ee168e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a9f9d6c0912a68159c13620660c460213"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f9d6c0912a68159c13620660c460213"></a>
  121. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="structColor.html">Color</a> &amp;color) noexcept</td></tr>
  122. <tr class="separator:a9f9d6c0912a68159c13620660c460213"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:aad01f46af4cdb18b2bcbddd3f63d14d5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structColor.html#aad01f46af4cdb18b2bcbddd3f63d14d5">fixBounds</a> () noexcept</td></tr>
  124. <tr class="separator:aad01f46af4cdb18b2bcbddd3f63d14d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a8a4a6f40d5264bdec2e47a0d2e31a7aa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a4a6f40d5264bdec2e47a0d2e31a7aa"></a>
  126. &#160;</td><td class="memItemRight" valign="bottom"><b>Color</b> (const NVGcolor &amp;) noexcept</td></tr>
  127. <tr class="separator:a8a4a6f40d5264bdec2e47a0d2e31a7aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a1ac9f71d30423f0abca0ada60a42fe62"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ac9f71d30423f0abca0ada60a42fe62"></a>
  129. &#160;</td><td class="memItemRight" valign="bottom"><b>operator NVGcolor</b> () const noexcept</td></tr>
  130. <tr class="separator:a1ac9f71d30423f0abca0ada60a42fe62"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table><table class="memberdecls">
  132. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  133. Static Public Member Functions</h2></td></tr>
  134. <tr class="memitem:a41820f7349e997489d53f98036e76a0c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structColor.html">Color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structColor.html#a41820f7349e997489d53f98036e76a0c">fromHSL</a> (float hue, float saturation, float lightness, float alpha=1.0f)</td></tr>
  135. <tr class="separator:a41820f7349e997489d53f98036e76a0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a57a79f611e15fb0abd288838a85990cb"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structColor.html">Color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structColor.html#a57a79f611e15fb0abd288838a85990cb">fromHTML</a> (const char *rgb, float alpha=1.0f)</td></tr>
  137. <tr class="separator:a57a79f611e15fb0abd288838a85990cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. </table><table class="memberdecls">
  139. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  140. Public Attributes</h2></td></tr>
  141. <tr class="memitem:ab2a2a5c22934a5f160d83906251d9204"><td class="memItemLeft" >union {</td></tr>
  142. <tr class="memitem:a25d3f3a59c6b77100e900166dbe6491f"><td class="memItemLeft" >
  143. &#160;&#160;&#160;float&#160;&#160;&#160;<b>rgba</b> [4]</td></tr>
  144. <tr class="separator:a25d3f3a59c6b77100e900166dbe6491f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:ac12da2a67fafc0ae792e11437dc6f81a"><td class="memItemLeft" ><a class="anchor" id="ac12da2a67fafc0ae792e11437dc6f81a"></a>
  146. &#160;&#160;&#160;struct {</td></tr>
  147. <tr class="memitem:ac2c4ab37d3f5ef4f29fc9b07e9f4f8cb"><td class="memItemLeft" >
  148. &#160;&#160;&#160;&#160;&#160;&#160;float&#160;&#160;&#160;<b>red</b></td></tr>
  149. <tr class="separator:ac2c4ab37d3f5ef4f29fc9b07e9f4f8cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a070efb64cbe536a9dd8b7190875bde7c"><td class="memItemLeft" >
  151. &#160;&#160;&#160;&#160;&#160;&#160;float&#160;&#160;&#160;<b>green</b></td></tr>
  152. <tr class="separator:a070efb64cbe536a9dd8b7190875bde7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a34cf6fa60ec69927b716964ab265db3f"><td class="memItemLeft" >
  154. &#160;&#160;&#160;&#160;&#160;&#160;float&#160;&#160;&#160;<b>blue</b></td></tr>
  155. <tr class="separator:a34cf6fa60ec69927b716964ab265db3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a0b228911b99285d8bde30aa656de8b26"><td class="memItemLeft" >
  157. &#160;&#160;&#160;&#160;&#160;&#160;float&#160;&#160;&#160;<b>alpha</b></td></tr>
  158. <tr class="separator:a0b228911b99285d8bde30aa656de8b26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:ac12da2a67fafc0ae792e11437dc6f81a"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
  160. <tr class="separator:ac12da2a67fafc0ae792e11437dc6f81a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:ab2a2a5c22934a5f160d83906251d9204"><td class="memItemLeft" valign="top">};&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
  162. <tr class="separator:ab2a2a5c22934a5f160d83906251d9204"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. </table>
  164. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  165. <div class="textblock"><p>A color made from red, green, blue and alpha floating-point values in [0..1] range. </p>
  166. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  167. <a class="anchor" id="acbbdba6661c2bbd987ef27de59813b47"></a>
  168. <div class="memitem">
  169. <div class="memproto">
  170. <table class="mlabels">
  171. <tr>
  172. <td class="mlabels-left">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">Color::Color </td>
  176. <td>(</td>
  177. <td class="paramname"></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </td>
  182. <td class="mlabels-right">
  183. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <p>Create solid black color. </p>
  188. </div>
  189. </div>
  190. <a class="anchor" id="a6539e54d79570ad579207289d087af70"></a>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <table class="mlabels">
  194. <tr>
  195. <td class="mlabels-left">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname">Color::Color </td>
  199. <td>(</td>
  200. <td class="paramtype">int&#160;</td>
  201. <td class="paramname"><em>red</em>, </td>
  202. </tr>
  203. <tr>
  204. <td class="paramkey"></td>
  205. <td></td>
  206. <td class="paramtype">int&#160;</td>
  207. <td class="paramname"><em>green</em>, </td>
  208. </tr>
  209. <tr>
  210. <td class="paramkey"></td>
  211. <td></td>
  212. <td class="paramtype">int&#160;</td>
  213. <td class="paramname"><em>blue</em>, </td>
  214. </tr>
  215. <tr>
  216. <td class="paramkey"></td>
  217. <td></td>
  218. <td class="paramtype">int&#160;</td>
  219. <td class="paramname"><em>alpha</em> = <code>255</code>&#160;</td>
  220. </tr>
  221. <tr>
  222. <td></td>
  223. <td>)</td>
  224. <td></td><td></td>
  225. </tr>
  226. </table>
  227. </td>
  228. <td class="mlabels-right">
  229. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. <p>Create a color from red, green, blue and alpha numeric values. Values must be in [0..255] range. </p>
  234. </div>
  235. </div>
  236. <a class="anchor" id="a77dd2b8f997aaf034c790ffd4ffe64bc"></a>
  237. <div class="memitem">
  238. <div class="memproto">
  239. <table class="mlabels">
  240. <tr>
  241. <td class="mlabels-left">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">Color::Color </td>
  245. <td>(</td>
  246. <td class="paramtype">float&#160;</td>
  247. <td class="paramname"><em>red</em>, </td>
  248. </tr>
  249. <tr>
  250. <td class="paramkey"></td>
  251. <td></td>
  252. <td class="paramtype">float&#160;</td>
  253. <td class="paramname"><em>green</em>, </td>
  254. </tr>
  255. <tr>
  256. <td class="paramkey"></td>
  257. <td></td>
  258. <td class="paramtype">float&#160;</td>
  259. <td class="paramname"><em>blue</em>, </td>
  260. </tr>
  261. <tr>
  262. <td class="paramkey"></td>
  263. <td></td>
  264. <td class="paramtype">float&#160;</td>
  265. <td class="paramname"><em>alpha</em> = <code>1.0f</code>&#160;</td>
  266. </tr>
  267. <tr>
  268. <td></td>
  269. <td>)</td>
  270. <td></td><td></td>
  271. </tr>
  272. </table>
  273. </td>
  274. <td class="mlabels-right">
  275. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  276. </tr>
  277. </table>
  278. </div><div class="memdoc">
  279. <p>Create a color from red, green, blue and alpha floating-point values. Values must in [0..1] range. </p>
  280. </div>
  281. </div>
  282. <a class="anchor" id="a7ac8018890423379bf8cdce2c6bc9d7e"></a>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="mlabels">
  286. <tr>
  287. <td class="mlabels-left">
  288. <table class="memname">
  289. <tr>
  290. <td class="memname">Color::Color </td>
  291. <td>(</td>
  292. <td class="paramtype">const <a class="el" href="structColor.html">Color</a> &amp;&#160;</td>
  293. <td class="paramname"><em>color</em></td><td>)</td>
  294. <td></td>
  295. </tr>
  296. </table>
  297. </td>
  298. <td class="mlabels-right">
  299. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  300. </tr>
  301. </table>
  302. </div><div class="memdoc">
  303. <p>Create a color by copying another color. </p>
  304. </div>
  305. </div>
  306. <a class="anchor" id="a8d51b3f9457c1d9524ad67c94152b99a"></a>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="mlabels">
  310. <tr>
  311. <td class="mlabels-left">
  312. <table class="memname">
  313. <tr>
  314. <td class="memname">Color::Color </td>
  315. <td>(</td>
  316. <td class="paramtype">const <a class="el" href="structColor.html">Color</a> &amp;&#160;</td>
  317. <td class="paramname"><em>color1</em>, </td>
  318. </tr>
  319. <tr>
  320. <td class="paramkey"></td>
  321. <td></td>
  322. <td class="paramtype">const <a class="el" href="structColor.html">Color</a> &amp;&#160;</td>
  323. <td class="paramname"><em>color2</em>, </td>
  324. </tr>
  325. <tr>
  326. <td class="paramkey"></td>
  327. <td></td>
  328. <td class="paramtype">float&#160;</td>
  329. <td class="paramname"><em>u</em>&#160;</td>
  330. </tr>
  331. <tr>
  332. <td></td>
  333. <td>)</td>
  334. <td></td><td></td>
  335. </tr>
  336. </table>
  337. </td>
  338. <td class="mlabels-right">
  339. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  340. </tr>
  341. </table>
  342. </div><div class="memdoc">
  343. <p>Create a color by linearly interpolating two other colors. </p>
  344. </div>
  345. </div>
  346. <h2 class="groupheader">Member Function Documentation</h2>
  347. <a class="anchor" id="a41820f7349e997489d53f98036e76a0c"></a>
  348. <div class="memitem">
  349. <div class="memproto">
  350. <table class="mlabels">
  351. <tr>
  352. <td class="mlabels-left">
  353. <table class="memname">
  354. <tr>
  355. <td class="memname">static <a class="el" href="structColor.html">Color</a> Color::fromHSL </td>
  356. <td>(</td>
  357. <td class="paramtype">float&#160;</td>
  358. <td class="paramname"><em>hue</em>, </td>
  359. </tr>
  360. <tr>
  361. <td class="paramkey"></td>
  362. <td></td>
  363. <td class="paramtype">float&#160;</td>
  364. <td class="paramname"><em>saturation</em>, </td>
  365. </tr>
  366. <tr>
  367. <td class="paramkey"></td>
  368. <td></td>
  369. <td class="paramtype">float&#160;</td>
  370. <td class="paramname"><em>lightness</em>, </td>
  371. </tr>
  372. <tr>
  373. <td class="paramkey"></td>
  374. <td></td>
  375. <td class="paramtype">float&#160;</td>
  376. <td class="paramname"><em>alpha</em> = <code>1.0f</code>&#160;</td>
  377. </tr>
  378. <tr>
  379. <td></td>
  380. <td>)</td>
  381. <td></td><td></td>
  382. </tr>
  383. </table>
  384. </td>
  385. <td class="mlabels-right">
  386. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  387. </tr>
  388. </table>
  389. </div><div class="memdoc">
  390. <p>Create a color specified by hue, saturation and lightness. Values must in [0..1] range. </p>
  391. </div>
  392. </div>
  393. <a class="anchor" id="a57a79f611e15fb0abd288838a85990cb"></a>
  394. <div class="memitem">
  395. <div class="memproto">
  396. <table class="mlabels">
  397. <tr>
  398. <td class="mlabels-left">
  399. <table class="memname">
  400. <tr>
  401. <td class="memname">static <a class="el" href="structColor.html">Color</a> Color::fromHTML </td>
  402. <td>(</td>
  403. <td class="paramtype">const char *&#160;</td>
  404. <td class="paramname"><em>rgb</em>, </td>
  405. </tr>
  406. <tr>
  407. <td class="paramkey"></td>
  408. <td></td>
  409. <td class="paramtype">float&#160;</td>
  410. <td class="paramname"><em>alpha</em> = <code>1.0f</code>&#160;</td>
  411. </tr>
  412. <tr>
  413. <td></td>
  414. <td>)</td>
  415. <td></td><td></td>
  416. </tr>
  417. </table>
  418. </td>
  419. <td class="mlabels-right">
  420. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  421. </tr>
  422. </table>
  423. </div><div class="memdoc">
  424. <p>Create a color from a HTML string like "#333" or "#112233". </p>
  425. </div>
  426. </div>
  427. <a class="anchor" id="a96283f5b9ad6f6465e40f69012aca00f"></a>
  428. <div class="memitem">
  429. <div class="memproto">
  430. <table class="mlabels">
  431. <tr>
  432. <td class="mlabels-left">
  433. <table class="memname">
  434. <tr>
  435. <td class="memname">void Color::interpolate </td>
  436. <td>(</td>
  437. <td class="paramtype">const <a class="el" href="structColor.html">Color</a> &amp;&#160;</td>
  438. <td class="paramname"><em>other</em>, </td>
  439. </tr>
  440. <tr>
  441. <td class="paramkey"></td>
  442. <td></td>
  443. <td class="paramtype">float&#160;</td>
  444. <td class="paramname"><em>u</em>&#160;</td>
  445. </tr>
  446. <tr>
  447. <td></td>
  448. <td>)</td>
  449. <td></td><td></td>
  450. </tr>
  451. </table>
  452. </td>
  453. <td class="mlabels-right">
  454. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  455. </tr>
  456. </table>
  457. </div><div class="memdoc">
  458. <p>Linearly interpolate this color against another. </p>
  459. </div>
  460. </div>
  461. <a class="anchor" id="a16880d42b2d52ed23eb307ed2980a9a3"></a>
  462. <div class="memitem">
  463. <div class="memproto">
  464. <table class="mlabels">
  465. <tr>
  466. <td class="mlabels-left">
  467. <table class="memname">
  468. <tr>
  469. <td class="memname">bool Color::isEqual </td>
  470. <td>(</td>
  471. <td class="paramtype">const <a class="el" href="structColor.html">Color</a> &amp;&#160;</td>
  472. <td class="paramname"><em>color</em>, </td>
  473. </tr>
  474. <tr>
  475. <td class="paramkey"></td>
  476. <td></td>
  477. <td class="paramtype">bool&#160;</td>
  478. <td class="paramname"><em>withAlpha</em> = <code>true</code>&#160;</td>
  479. </tr>
  480. <tr>
  481. <td></td>
  482. <td>)</td>
  483. <td></td><td></td>
  484. </tr>
  485. </table>
  486. </td>
  487. <td class="mlabels-right">
  488. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  489. </tr>
  490. </table>
  491. </div><div class="memdoc">
  492. <p>Check if this color matches another. </p><dl class="section note"><dt>Note</dt><dd>Comparison is forced within 8-bit color values. </dd></dl>
  493. </div>
  494. </div>
  495. <a class="anchor" id="aad01f46af4cdb18b2bcbddd3f63d14d5"></a>
  496. <div class="memitem">
  497. <div class="memproto">
  498. <table class="mlabels">
  499. <tr>
  500. <td class="mlabels-left">
  501. <table class="memname">
  502. <tr>
  503. <td class="memname">void Color::fixBounds </td>
  504. <td>(</td>
  505. <td class="paramname"></td><td>)</td>
  506. <td></td>
  507. </tr>
  508. </table>
  509. </td>
  510. <td class="mlabels-right">
  511. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  512. </tr>
  513. </table>
  514. </div><div class="memdoc">
  515. <p>Fix color bounds if needed. </p>
  516. </div>
  517. </div>
  518. <h2 class="groupheader">Member Data Documentation</h2>
  519. <a class="anchor" id="ab2a2a5c22934a5f160d83906251d9204"></a>
  520. <div class="memitem">
  521. <div class="memproto">
  522. <table class="memname">
  523. <tr>
  524. <td class="memname">union { ... } </td>
  525. </tr>
  526. </table>
  527. </div><div class="memdoc">
  528. <p>Direct access to the color values. </p>
  529. </div>
  530. </div>
  531. <hr/>The documentation for this struct was generated from the following file:<ul>
  532. <li>dgl/<a class="el" href="Color_8hpp_source.html">Color.hpp</a></li>
  533. </ul>
  534. </div><!-- contents -->
  535. <!-- start footer part -->
  536. <hr class="footer"/><address class="footer"><small>
  537. Generated on Tue Jun 7 2016 14:04:29 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  538. <img class="footer" src="doxygen.png" alt="doxygen"/>
  539. </a> 1.8.11
  540. </small></address>
  541. </body>
  542. </html>