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.

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