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.

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