DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
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.
400 Commits
6 Branches
58MB
Tree: 262c01eee3
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '262c01eee3'
${ noResults }
DPF/structColor.html

617 lines
28KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>

  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.17 -->

  33. <script type="text/javascript">

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

  40. <script type="text/javascript">

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

  44.   $(document).ready(function() { init_search(); });

  45. });

  46. /* @license-end */</script>

  47. <div id="main-nav"></div>

  48. <!-- window showing the filter options -->

  49. <div id="MSearchSelectWindow"

  50.      onmouseover="return searchBox.OnSearchSelectShow()"

  51.      onmouseout="return searchBox.OnSearchSelectHide()"

  52.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  53. </div>

  54. 

  55. <!-- iframe showing the search results (closed by default) -->

  56. <div id="MSearchResultsWindow">

  57. <iframe src="javascript:void(0)" frameborder="0" 

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

  62. </div><!-- top -->

  63. <div class="header">

  64.   <div class="summary">

  65. <a href="#pub-methods">Public Member Functions</a> &#124;

  66. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;

  67. <a href="#pub-attribs">Public Attributes</a> &#124;

  68. <a href="structColor-members.html">List of all members</a>  </div>

  69.   <div class="headertitle">

  70. <div class="title">Color Struct Reference</div>  </div>

  71. </div><!--header-->

  72. <div class="contents">

  73. 

  74. <p><code>#include &lt;<a class="el" href="Color_8hpp_source.html">Color.hpp</a>&gt;</code></p>

  75. <table class="memberdecls">

  76. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  77. Public Member Functions</h2></td></tr>

  78. <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>

  79. <tr class="separator:acbbdba6661c2bbd987ef27de59813b47"><td class="memSeparator" colspan="2">&#160;</td></tr>

  80. <tr class="memitem:ab5f3b6caec37b3ba8f7a04c801c63847"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structColor.html#ab5f3b6caec37b3ba8f7a04c801c63847">Color</a> (int red, int green, int blue, float alpha=1.0f) noexcept</td></tr>

  81. <tr class="separator:ab5f3b6caec37b3ba8f7a04c801c63847"><td class="memSeparator" colspan="2">&#160;</td></tr>

  82. <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>

  83. <tr class="separator:a77dd2b8f997aaf034c790ffd4ffe64bc"><td class="memSeparator" colspan="2">&#160;</td></tr>

  84. <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>

  85. <tr class="separator:a7ac8018890423379bf8cdce2c6bc9d7e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  86. <tr class="memitem:a11aeda6f8f3b11c66e3df226c61b3473"><td class="memItemLeft" align="right" valign="top"><a id="a11aeda6f8f3b11c66e3df226c61b3473"></a>

  87. <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>

  88. <tr class="separator:a11aeda6f8f3b11c66e3df226c61b3473"><td class="memSeparator" colspan="2">&#160;</td></tr>

  89. <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>

  90. <tr class="separator:a8d51b3f9457c1d9524ad67c94152b99a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  91. <tr class="memitem:a664780dcd74f376837dc6c5a219ca566"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structColor.html">Color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structColor.html#a664780dcd74f376837dc6c5a219ca566">withAlpha</a> (float alpha) noexcept</td></tr>

  92. <tr class="separator:a664780dcd74f376837dc6c5a219ca566"><td class="memSeparator" colspan="2">&#160;</td></tr>

  93. <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>

  94. <tr class="separator:a96283f5b9ad6f6465e40f69012aca00f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  95. <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 <a class="el" href="structColor.html#a664780dcd74f376837dc6c5a219ca566">withAlpha</a>=true) noexcept</td></tr>

  96. <tr class="separator:a16880d42b2d52ed23eb307ed2980a9a3"><td class="memSeparator" colspan="2">&#160;</td></tr>

  97. <tr class="memitem:aa0e84f05c440907e331590430da2e2e6"><td class="memItemLeft" align="right" valign="top"><a id="aa0e84f05c440907e331590430da2e2e6"></a>

  98. bool&#160;</td><td class="memItemRight" valign="bottom"><b>isNotEqual</b> (const <a class="el" href="structColor.html">Color</a> &amp;color, bool <a class="el" href="structColor.html#a664780dcd74f376837dc6c5a219ca566">withAlpha</a>=true) noexcept</td></tr>

  99. <tr class="separator:aa0e84f05c440907e331590430da2e2e6"><td class="memSeparator" colspan="2">&#160;</td></tr>

  100. <tr class="memitem:a3aa26bd1c31ea638f6fc1c06d4ee168e"><td class="memItemLeft" align="right" valign="top"><a id="a3aa26bd1c31ea638f6fc1c06d4ee168e"></a>

  101. 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>

  102. <tr class="separator:a3aa26bd1c31ea638f6fc1c06d4ee168e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  103. <tr class="memitem:a9f9d6c0912a68159c13620660c460213"><td class="memItemLeft" align="right" valign="top"><a id="a9f9d6c0912a68159c13620660c460213"></a>

  104. 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>

  105. <tr class="separator:a9f9d6c0912a68159c13620660c460213"><td class="memSeparator" colspan="2">&#160;</td></tr>

  106. <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>

  107. <tr class="separator:aad01f46af4cdb18b2bcbddd3f63d14d5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  108. <tr class="memitem:a9bd4efab0718f412babc62398875a80f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structColor.html#a9bd4efab0718f412babc62398875a80f">setFor</a> (const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;context, bool includeAlpha=false)</td></tr>

  109. <tr class="separator:a9bd4efab0718f412babc62398875a80f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  110. <tr class="memitem:a8a4a6f40d5264bdec2e47a0d2e31a7aa"><td class="memItemLeft" align="right" valign="top"><a id="a8a4a6f40d5264bdec2e47a0d2e31a7aa"></a>

  111. &#160;</td><td class="memItemRight" valign="bottom"><b>Color</b> (const NVGcolor &amp;) noexcept</td></tr>

  112. <tr class="separator:a8a4a6f40d5264bdec2e47a0d2e31a7aa"><td class="memSeparator" colspan="2">&#160;</td></tr>

  113. <tr class="memitem:a1ac9f71d30423f0abca0ada60a42fe62"><td class="memItemLeft" align="right" valign="top"><a id="a1ac9f71d30423f0abca0ada60a42fe62"></a>

  114. &#160;</td><td class="memItemRight" valign="bottom"><b>operator NVGcolor</b> () const noexcept</td></tr>

  115. <tr class="separator:a1ac9f71d30423f0abca0ada60a42fe62"><td class="memSeparator" colspan="2">&#160;</td></tr>

  116. </table><table class="memberdecls">

  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>

  118. Static Public Member Functions</h2></td></tr>

  119. <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>

  120. <tr class="separator:a41820f7349e997489d53f98036e76a0c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  121. <tr class="memitem:abdc66d9b8c6422a721f8d576e871f646"><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#abdc66d9b8c6422a721f8d576e871f646">fromHTML</a> (const char *rgb, float alpha=1.0f) noexcept</td></tr>

  122. <tr class="separator:abdc66d9b8c6422a721f8d576e871f646"><td class="memSeparator" colspan="2">&#160;</td></tr>

  123. </table><table class="memberdecls">

  124. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>

  125. Public Attributes</h2></td></tr>

  126. <tr class="memitem:ab2a2a5c22934a5f160d83906251d9204"><td class="memItemLeft" >union {</td></tr>

  127. <tr class="memitem:a25d3f3a59c6b77100e900166dbe6491f"><td class="memItemLeft" >

  128. &#160;&#160;&#160;float&#160;&#160;&#160;<b>rgba</b> [4]</td></tr>

  129. <tr class="separator:a25d3f3a59c6b77100e900166dbe6491f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  130. <tr class="memitem:ac12da2a67fafc0ae792e11437dc6f81a"><td class="memItemLeft" ><a id="ac12da2a67fafc0ae792e11437dc6f81a"></a>

  131. &#160;&#160;&#160;struct {</td></tr>

  132. <tr class="memitem:ac2c4ab37d3f5ef4f29fc9b07e9f4f8cb"><td class="memItemLeft" >

  133. &#160;&#160;&#160;&#160;&#160;&#160;float&#160;&#160;&#160;<b>red</b></td></tr>

  134. <tr class="separator:ac2c4ab37d3f5ef4f29fc9b07e9f4f8cb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  135. <tr class="memitem:a070efb64cbe536a9dd8b7190875bde7c"><td class="memItemLeft" >

  136. &#160;&#160;&#160;&#160;&#160;&#160;float&#160;&#160;&#160;<b>green</b></td></tr>

  137. <tr class="separator:a070efb64cbe536a9dd8b7190875bde7c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  138. <tr class="memitem:a34cf6fa60ec69927b716964ab265db3f"><td class="memItemLeft" >

  139. &#160;&#160;&#160;&#160;&#160;&#160;float&#160;&#160;&#160;<b>blue</b></td></tr>

  140. <tr class="separator:a34cf6fa60ec69927b716964ab265db3f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  141. <tr class="memitem:a0b228911b99285d8bde30aa656de8b26"><td class="memItemLeft" >

  142. &#160;&#160;&#160;&#160;&#160;&#160;float&#160;&#160;&#160;<b>alpha</b></td></tr>

  143. <tr class="separator:a0b228911b99285d8bde30aa656de8b26"><td class="memSeparator" colspan="2">&#160;</td></tr>

  144. <tr class="memitem:ac12da2a67fafc0ae792e11437dc6f81a"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;</td><td class="memItemRight" valign="bottom"></td></tr>

  145. <tr class="separator:ac12da2a67fafc0ae792e11437dc6f81a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  146. <tr class="memitem:ab2a2a5c22934a5f160d83906251d9204"><td class="memItemLeft" valign="top">};&#160;</td><td class="memItemRight" valign="bottom"></td></tr>

  147. <tr class="separator:ab2a2a5c22934a5f160d83906251d9204"><td class="memSeparator" colspan="2">&#160;</td></tr>

  148. </table>

  149. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  150. <div class="textblock"><p>A color made from red, green, blue and alpha floating-point values in [0..1] range. </p>

  151. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  152. <a id="acbbdba6661c2bbd987ef27de59813b47"></a>

  153. <h2 class="memtitle"><span class="permalink"><a href="#acbbdba6661c2bbd987ef27de59813b47">&#9670;&nbsp;</a></span>Color() <span class="overload">[1/5]</span></h2>

  154. 

  155. <div class="memitem">

  156. <div class="memproto">

  157. <table class="mlabels">

  158.   <tr>

  159.   <td class="mlabels-left">

  160.       <table class="memname">

  161.         <tr>

  162.           <td class="memname">Color::Color </td>

  163.           <td>(</td>

  164.           <td class="paramname"></td><td>)</td>

  165.           <td></td>

  166.         </tr>

  167.       </table>

  168.   </td>

  169.   <td class="mlabels-right">

  170. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  171.   </tr>

  172. </table>

  173. </div><div class="memdoc">

  174. <p>Create solid black color. </p>

  175. 

  176. </div>

  177. </div>

  178. <a id="ab5f3b6caec37b3ba8f7a04c801c63847"></a>

  179. <h2 class="memtitle"><span class="permalink"><a href="#ab5f3b6caec37b3ba8f7a04c801c63847">&#9670;&nbsp;</a></span>Color() <span class="overload">[2/5]</span></h2>

  180. 

  181. <div class="memitem">

  182. <div class="memproto">

  183. <table class="mlabels">

  184.   <tr>

  185.   <td class="mlabels-left">

  186.       <table class="memname">

  187.         <tr>

  188.           <td class="memname">Color::Color </td>

  189.           <td>(</td>

  190.           <td class="paramtype">int&#160;</td>

  191.           <td class="paramname"><em>red</em>, </td>

  192.         </tr>

  193.         <tr>

  194.           <td class="paramkey"></td>

  195.           <td></td>

  196.           <td class="paramtype">int&#160;</td>

  197.           <td class="paramname"><em>green</em>, </td>

  198.         </tr>

  199.         <tr>

  200.           <td class="paramkey"></td>

  201.           <td></td>

  202.           <td class="paramtype">int&#160;</td>

  203.           <td class="paramname"><em>blue</em>, </td>

  204.         </tr>

  205.         <tr>

  206.           <td class="paramkey"></td>

  207.           <td></td>

  208.           <td class="paramtype">float&#160;</td>

  209.           <td class="paramname"><em>alpha</em> = <code>1.0f</code>&#160;</td>

  210.         </tr>

  211.         <tr>

  212.           <td></td>

  213.           <td>)</td>

  214.           <td></td><td></td>

  215.         </tr>

  216.       </table>

  217.   </td>

  218.   <td class="mlabels-right">

  219. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  220.   </tr>

  221. </table>

  222. </div><div class="memdoc">

  223. <p>Create a color from red, green, blue and alpha numeric values. All values except alpha must be in [0..255] range, with alpha in [0..1] range. </p>

  224. 

  225. </div>

  226. </div>

  227. <a id="a77dd2b8f997aaf034c790ffd4ffe64bc"></a>

  228. <h2 class="memtitle"><span class="permalink"><a href="#a77dd2b8f997aaf034c790ffd4ffe64bc">&#9670;&nbsp;</a></span>Color() <span class="overload">[3/5]</span></h2>

  229. 

  230. <div class="memitem">

  231. <div class="memproto">

  232. <table class="mlabels">

  233.   <tr>

  234.   <td class="mlabels-left">

  235.       <table class="memname">

  236.         <tr>

  237.           <td class="memname">Color::Color </td>

  238.           <td>(</td>

  239.           <td class="paramtype">float&#160;</td>

  240.           <td class="paramname"><em>red</em>, </td>

  241.         </tr>

  242.         <tr>

  243.           <td class="paramkey"></td>

  244.           <td></td>

  245.           <td class="paramtype">float&#160;</td>

  246.           <td class="paramname"><em>green</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>blue</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>alpha</em> = <code>1.0f</code>&#160;</td>

  259.         </tr>

  260.         <tr>

  261.           <td></td>

  262.           <td>)</td>

  263.           <td></td><td></td>

  264.         </tr>

  265.       </table>

  266.   </td>

  267.   <td class="mlabels-right">

  268. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  269.   </tr>

  270. </table>

  271. </div><div class="memdoc">

  272. <p>Create a color from red, green, blue and alpha floating-point values. All values must in [0..1] range. </p>

  273. 

  274. </div>

  275. </div>

  276. <a id="a7ac8018890423379bf8cdce2c6bc9d7e"></a>

  277. <h2 class="memtitle"><span class="permalink"><a href="#a7ac8018890423379bf8cdce2c6bc9d7e">&#9670;&nbsp;</a></span>Color() <span class="overload">[4/5]</span></h2>

  278. 

  279. <div class="memitem">

  280. <div class="memproto">

  281. <table class="mlabels">

  282.   <tr>

  283.   <td class="mlabels-left">

  284.       <table class="memname">

  285.         <tr>

  286.           <td class="memname">Color::Color </td>

  287.           <td>(</td>

  288.           <td class="paramtype">const <a class="el" href="structColor.html">Color</a> &amp;&#160;</td>

  289.           <td class="paramname"><em>color</em></td><td>)</td>

  290.           <td></td>

  291.         </tr>

  292.       </table>

  293.   </td>

  294.   <td class="mlabels-right">

  295. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  296.   </tr>

  297. </table>

  298. </div><div class="memdoc">

  299. <p>Create a color by copying another color. </p>

  300. 

  301. </div>

  302. </div>

  303. <a id="a8d51b3f9457c1d9524ad67c94152b99a"></a>

  304. <h2 class="memtitle"><span class="permalink"><a href="#a8d51b3f9457c1d9524ad67c94152b99a">&#9670;&nbsp;</a></span>Color() <span class="overload">[5/5]</span></h2>

  305. 

  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. 

  344. </div>

  345. </div>

  346. <h2 class="groupheader">Member Function Documentation</h2>

  347. <a id="a664780dcd74f376837dc6c5a219ca566"></a>

  348. <h2 class="memtitle"><span class="permalink"><a href="#a664780dcd74f376837dc6c5a219ca566">&#9670;&nbsp;</a></span>withAlpha()</h2>

  349. 

  350. <div class="memitem">

  351. <div class="memproto">

  352. <table class="mlabels">

  353.   <tr>

  354.   <td class="mlabels-left">

  355.       <table class="memname">

  356.         <tr>

  357.           <td class="memname"><a class="el" href="structColor.html">Color</a> Color::withAlpha </td>

  358.           <td>(</td>

  359.           <td class="paramtype">float&#160;</td>

  360.           <td class="paramname"><em>alpha</em></td><td>)</td>

  361.           <td></td>

  362.         </tr>

  363.       </table>

  364.   </td>

  365.   <td class="mlabels-right">

  366. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  367.   </tr>

  368. </table>

  369. </div><div class="memdoc">

  370. <p>Create a new color based on this one but with a different alpha value. </p>

  371. 

  372. </div>

  373. </div>

  374. <a id="a41820f7349e997489d53f98036e76a0c"></a>

  375. <h2 class="memtitle"><span class="permalink"><a href="#a41820f7349e997489d53f98036e76a0c">&#9670;&nbsp;</a></span>fromHSL()</h2>

  376. 

  377. <div class="memitem">

  378. <div class="memproto">

  379. <table class="mlabels">

  380.   <tr>

  381.   <td class="mlabels-left">

  382.       <table class="memname">

  383.         <tr>

  384.           <td class="memname">static <a class="el" href="structColor.html">Color</a> Color::fromHSL </td>

  385.           <td>(</td>

  386.           <td class="paramtype">float&#160;</td>

  387.           <td class="paramname"><em>hue</em>, </td>

  388.         </tr>

  389.         <tr>

  390.           <td class="paramkey"></td>

  391.           <td></td>

  392.           <td class="paramtype">float&#160;</td>

  393.           <td class="paramname"><em>saturation</em>, </td>

  394.         </tr>

  395.         <tr>

  396.           <td class="paramkey"></td>

  397.           <td></td>

  398.           <td class="paramtype">float&#160;</td>

  399.           <td class="paramname"><em>lightness</em>, </td>

  400.         </tr>

  401.         <tr>

  402.           <td class="paramkey"></td>

  403.           <td></td>

  404.           <td class="paramtype">float&#160;</td>

  405.           <td class="paramname"><em>alpha</em> = <code>1.0f</code>&#160;</td>

  406.         </tr>

  407.         <tr>

  408.           <td></td>

  409.           <td>)</td>

  410.           <td></td><td></td>

  411.         </tr>

  412.       </table>

  413.   </td>

  414.   <td class="mlabels-right">

  415. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  416.   </tr>

  417. </table>

  418. </div><div class="memdoc">

  419. <p>Create a color specified by hue, saturation and lightness. Values must in [0..1] range. </p>

  420. 

  421. </div>

  422. </div>

  423. <a id="abdc66d9b8c6422a721f8d576e871f646"></a>

  424. <h2 class="memtitle"><span class="permalink"><a href="#abdc66d9b8c6422a721f8d576e871f646">&#9670;&nbsp;</a></span>fromHTML()</h2>

  425. 

  426. <div class="memitem">

  427. <div class="memproto">

  428. <table class="mlabels">

  429.   <tr>

  430.   <td class="mlabels-left">

  431.       <table class="memname">

  432.         <tr>

  433.           <td class="memname">static <a class="el" href="structColor.html">Color</a> Color::fromHTML </td>

  434.           <td>(</td>

  435.           <td class="paramtype">const char *&#160;</td>

  436.           <td class="paramname"><em>rgb</em>, </td>

  437.         </tr>

  438.         <tr>

  439.           <td class="paramkey"></td>

  440.           <td></td>

  441.           <td class="paramtype">float&#160;</td>

  442.           <td class="paramname"><em>alpha</em> = <code>1.0f</code>&#160;</td>

  443.         </tr>

  444.         <tr>

  445.           <td></td>

  446.           <td>)</td>

  447.           <td></td><td></td>

  448.         </tr>

  449.       </table>

  450.   </td>

  451.   <td class="mlabels-right">

  452. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>

  453.   </tr>

  454. </table>

  455. </div><div class="memdoc">

  456. <p>Create a color from a HTML string like "#333" or "#112233". </p>

  457. 

  458. </div>

  459. </div>

  460. <a id="a96283f5b9ad6f6465e40f69012aca00f"></a>

  461. <h2 class="memtitle"><span class="permalink"><a href="#a96283f5b9ad6f6465e40f69012aca00f">&#9670;&nbsp;</a></span>interpolate()</h2>

  462. 

  463. <div class="memitem">

  464. <div class="memproto">

  465. <table class="mlabels">

  466.   <tr>

  467.   <td class="mlabels-left">

  468.       <table class="memname">

  469.         <tr>

  470.           <td class="memname">void Color::interpolate </td>

  471.           <td>(</td>

  472.           <td class="paramtype">const <a class="el" href="structColor.html">Color</a> &amp;&#160;</td>

  473.           <td class="paramname"><em>other</em>, </td>

  474.         </tr>

  475.         <tr>

  476.           <td class="paramkey"></td>

  477.           <td></td>

  478.           <td class="paramtype">float&#160;</td>

  479.           <td class="paramname"><em>u</em>&#160;</td>

  480.         </tr>

  481.         <tr>

  482.           <td></td>

  483.           <td>)</td>

  484.           <td></td><td></td>

  485.         </tr>

  486.       </table>

  487.   </td>

  488.   <td class="mlabels-right">

  489. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  490.   </tr>

  491. </table>

  492. </div><div class="memdoc">

  493. <p>Linearly interpolate this color against another. </p>

  494. 

  495. </div>

  496. </div>

  497. <a id="a16880d42b2d52ed23eb307ed2980a9a3"></a>

  498. <h2 class="memtitle"><span class="permalink"><a href="#a16880d42b2d52ed23eb307ed2980a9a3">&#9670;&nbsp;</a></span>isEqual()</h2>

  499. 

  500. <div class="memitem">

  501. <div class="memproto">

  502. <table class="mlabels">

  503.   <tr>

  504.   <td class="mlabels-left">

  505.       <table class="memname">

  506.         <tr>

  507.           <td class="memname">bool Color::isEqual </td>

  508.           <td>(</td>

  509.           <td class="paramtype">const <a class="el" href="structColor.html">Color</a> &amp;&#160;</td>

  510.           <td class="paramname"><em>color</em>, </td>

  511.         </tr>

  512.         <tr>

  513.           <td class="paramkey"></td>

  514.           <td></td>

  515.           <td class="paramtype">bool&#160;</td>

  516.           <td class="paramname"><em>withAlpha</em> = <code>true</code>&#160;</td>

  517.         </tr>

  518.         <tr>

  519.           <td></td>

  520.           <td>)</td>

  521.           <td></td><td></td>

  522.         </tr>

  523.       </table>

  524.   </td>

  525.   <td class="mlabels-right">

  526. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  527.   </tr>

  528. </table>

  529. </div><div class="memdoc">

  530. <p>Check if this color matches another. </p><dl class="section note"><dt>Note</dt><dd>Comparison is done within 8-bit color space. </dd></dl>

  531. 

  532. </div>

  533. </div>

  534. <a id="aad01f46af4cdb18b2bcbddd3f63d14d5"></a>

  535. <h2 class="memtitle"><span class="permalink"><a href="#aad01f46af4cdb18b2bcbddd3f63d14d5">&#9670;&nbsp;</a></span>fixBounds()</h2>

  536. 

  537. <div class="memitem">

  538. <div class="memproto">

  539. <table class="mlabels">

  540.   <tr>

  541.   <td class="mlabels-left">

  542.       <table class="memname">

  543.         <tr>

  544.           <td class="memname">void Color::fixBounds </td>

  545.           <td>(</td>

  546.           <td class="paramname"></td><td>)</td>

  547.           <td></td>

  548.         </tr>

  549.       </table>

  550.   </td>

  551.   <td class="mlabels-right">

  552. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  553.   </tr>

  554. </table>

  555. </div><div class="memdoc">

  556. <p>Fix color bounds if needed. </p>

  557. 

  558. </div>

  559. </div>

  560. <a id="a9bd4efab0718f412babc62398875a80f"></a>

  561. <h2 class="memtitle"><span class="permalink"><a href="#a9bd4efab0718f412babc62398875a80f">&#9670;&nbsp;</a></span>setFor()</h2>

  562. 

  563. <div class="memitem">

  564. <div class="memproto">

  565.       <table class="memname">

  566.         <tr>

  567.           <td class="memname">void Color::setFor </td>

  568.           <td>(</td>

  569.           <td class="paramtype">const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;&#160;</td>

  570.           <td class="paramname"><em>context</em>, </td>

  571.         </tr>

  572.         <tr>

  573.           <td class="paramkey"></td>

  574.           <td></td>

  575.           <td class="paramtype">bool&#160;</td>

  576.           <td class="paramname"><em>includeAlpha</em> = <code>false</code>&#160;</td>

  577.         </tr>

  578.         <tr>

  579.           <td></td>

  580.           <td>)</td>

  581.           <td></td><td></td>

  582.         </tr>

  583.       </table>

  584. </div><div class="memdoc">

  585. <p>Set this color for use in the next drawing operation for the provided context. </p>

  586. 

  587. </div>

  588. </div>

  589. <h2 class="groupheader">Member Data Documentation</h2>

  590. <a id="ab2a2a5c22934a5f160d83906251d9204"></a>

  591. <h2 class="memtitle"><span class="permalink"><a href="#ab2a2a5c22934a5f160d83906251d9204">&#9670;&nbsp;</a></span>@1</h2>

  592. 

  593. <div class="memitem">

  594. <div class="memproto">

  595.       <table class="memname">

  596.         <tr>

  597.           <td class="memname">union { ... } </td>

  598.         </tr>

  599.       </table>

  600. </div><div class="memdoc">

  601. <p>Direct access to the color values. </p>

  602. 

  603. </div>

  604. </div>

  605. <hr/>The documentation for this struct was generated from the following file:<ul>

  606. <li>dgl/<a class="el" href="Color_8hpp_source.html">Color.hpp</a></li>

  607. </ul>

  608. </div><!-- contents -->

  609. <!-- start footer part -->

  610. <hr class="footer"/><address class="footer"><small>

  611. Generated on Sat Jul 3 2021 23:07:06 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  612. <img class="footer" src="doxygen.png" alt="doxygen"/>

  613. </a> 1.8.17

  614. </small></address>

  615. </body>

  616. </html>