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.
417 Commits
7 Branches
91MB
Branch: gh-pages
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'gh-pages'
${ noResults }
DPF/structColor.html

759 lines
34KB
Raw Permalink 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.9.1"/>

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

  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','.html');

  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:a3f163d59e5a313f742acdd2bbd47441f"><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#a3f163d59e5a313f742acdd2bbd47441f">withAlpha</a> (float alpha) const noexcept</td></tr>

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

  93. <tr class="memitem:a9649cf7255a6241a7b08fda056875853"><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#a9649cf7255a6241a7b08fda056875853">minus</a> (int value) const noexcept</td></tr>

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

  95. <tr class="memitem:abbd3f5d38f0b344179c7fd1aa6561fa3"><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#abbd3f5d38f0b344179c7fd1aa6561fa3">minus</a> (float value) const noexcept</td></tr>

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

  97. <tr class="memitem:ad3c9595604828b97c3cf1bfeb323cfbe"><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#ad3c9595604828b97c3cf1bfeb323cfbe">plus</a> (int value) const noexcept</td></tr>

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

  99. <tr class="memitem:a919d9746e01fa6ca7083e17242b371d2"><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#a919d9746e01fa6ca7083e17242b371d2">plus</a> (float value) const noexcept</td></tr>

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

  101. <tr class="memitem:a1cc575ce361080042b5072f91ca52893"><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#a1cc575ce361080042b5072f91ca52893">invert</a> () const noexcept</td></tr>

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

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

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

  105. <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#a3f163d59e5a313f742acdd2bbd47441f">withAlpha</a>=true) noexcept</td></tr>

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

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

  108. 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#a3f163d59e5a313f742acdd2bbd47441f">withAlpha</a>=true) noexcept</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  158. </table>

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

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

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

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

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

  164. 

  165. <div class="memitem">

  166. <div class="memproto">

  167. <table class="mlabels">

  168.   <tr>

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

  170.       <table class="memname">

  171.         <tr>

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

  173.           <td>(</td>

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

  175.           <td></td>

  176.         </tr>

  177.       </table>

  178.   </td>

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

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

  181.   </tr>

  182. </table>

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

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

  185. 

  186. </div>

  187. </div>

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

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

  190. 

  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">float&#160;</td>

  219.           <td class="paramname"><em>alpha</em> = <code>1.0f</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. All values except alpha must be in [0..255] range, with alpha in [0..1] range. </p>

  234. 

  235. </div>

  236. </div>

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

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

  239. 

  240. <div class="memitem">

  241. <div class="memproto">

  242. <table class="mlabels">

  243.   <tr>

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

  245.       <table class="memname">

  246.         <tr>

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

  248.           <td>(</td>

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

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

  251.         </tr>

  252.         <tr>

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

  254.           <td></td>

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

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

  257.         </tr>

  258.         <tr>

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

  260.           <td></td>

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

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

  263.         </tr>

  264.         <tr>

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

  266.           <td></td>

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

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

  269.         </tr>

  270.         <tr>

  271.           <td></td>

  272.           <td>)</td>

  273.           <td></td><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 from red, green, blue and alpha floating-point values. All values must in [0..1] range. </p>

  283. 

  284. </div>

  285. </div>

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

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

  288. 

  289. <div class="memitem">

  290. <div class="memproto">

  291. <table class="mlabels">

  292.   <tr>

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

  294.       <table class="memname">

  295.         <tr>

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

  297.           <td>(</td>

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

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

  300.           <td></td>

  301.         </tr>

  302.       </table>

  303.   </td>

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

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

  306.   </tr>

  307. </table>

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

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

  310. 

  311. </div>

  312. </div>

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

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

  315. 

  316. <div class="memitem">

  317. <div class="memproto">

  318. <table class="mlabels">

  319.   <tr>

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

  321.       <table class="memname">

  322.         <tr>

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

  324.           <td>(</td>

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

  326.           <td class="paramname"><em>color1</em>, </td>

  327.         </tr>

  328.         <tr>

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

  330.           <td></td>

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

  332.           <td class="paramname"><em>color2</em>, </td>

  333.         </tr>

  334.         <tr>

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

  336.           <td></td>

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

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

  339.         </tr>

  340.         <tr>

  341.           <td></td>

  342.           <td>)</td>

  343.           <td></td><td></td>

  344.         </tr>

  345.       </table>

  346.   </td>

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

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

  349.   </tr>

  350. </table>

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

  352. <p>Create a color by linearly interpolating two other colors. </p>

  353. 

  354. </div>

  355. </div>

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

  357. <a id="a3f163d59e5a313f742acdd2bbd47441f"></a>

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

  359. 

  360. <div class="memitem">

  361. <div class="memproto">

  362. <table class="mlabels">

  363.   <tr>

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

  365.       <table class="memname">

  366.         <tr>

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

  368.           <td>(</td>

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

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

  371.           <td> const</td>

  372.         </tr>

  373.       </table>

  374.   </td>

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

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

  377.   </tr>

  378. </table>

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

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

  381. 

  382. </div>

  383. </div>

  384. <a id="a9649cf7255a6241a7b08fda056875853"></a>

  385. <h2 class="memtitle"><span class="permalink"><a href="#a9649cf7255a6241a7b08fda056875853">&#9670;&nbsp;</a></span>minus() <span class="overload">[1/2]</span></h2>

  386. 

  387. <div class="memitem">

  388. <div class="memproto">

  389. <table class="mlabels">

  390.   <tr>

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

  392.       <table class="memname">

  393.         <tr>

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

  395.           <td>(</td>

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

  397.           <td class="paramname"><em>value</em></td><td>)</td>

  398.           <td> const</td>

  399.         </tr>

  400.       </table>

  401.   </td>

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

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

  404.   </tr>

  405. </table>

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

  407. <p>Create a new color based on this one but with subtracted numeric value on all elements. Value must be in [0..255] range. </p>

  408. 

  409. </div>

  410. </div>

  411. <a id="abbd3f5d38f0b344179c7fd1aa6561fa3"></a>

  412. <h2 class="memtitle"><span class="permalink"><a href="#abbd3f5d38f0b344179c7fd1aa6561fa3">&#9670;&nbsp;</a></span>minus() <span class="overload">[2/2]</span></h2>

  413. 

  414. <div class="memitem">

  415. <div class="memproto">

  416. <table class="mlabels">

  417.   <tr>

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

  419.       <table class="memname">

  420.         <tr>

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

  422.           <td>(</td>

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

  424.           <td class="paramname"><em>value</em></td><td>)</td>

  425.           <td> const</td>

  426.         </tr>

  427.       </table>

  428.   </td>

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

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

  431.   </tr>

  432. </table>

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

  434. <p>Create a new color based on this one but with subtracted floating-point value on all elements. Value must be in [0..1] range. </p>

  435. 

  436. </div>

  437. </div>

  438. <a id="ad3c9595604828b97c3cf1bfeb323cfbe"></a>

  439. <h2 class="memtitle"><span class="permalink"><a href="#ad3c9595604828b97c3cf1bfeb323cfbe">&#9670;&nbsp;</a></span>plus() <span class="overload">[1/2]</span></h2>

  440. 

  441. <div class="memitem">

  442. <div class="memproto">

  443. <table class="mlabels">

  444.   <tr>

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

  446.       <table class="memname">

  447.         <tr>

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

  449.           <td>(</td>

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

  451.           <td class="paramname"><em>value</em></td><td>)</td>

  452.           <td> const</td>

  453.         </tr>

  454.       </table>

  455.   </td>

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

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

  458.   </tr>

  459. </table>

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

  461. <p>Create a new color based on this one but with added numeric value on all elements. Value must be in [0..255] range. </p>

  462. 

  463. </div>

  464. </div>

  465. <a id="a919d9746e01fa6ca7083e17242b371d2"></a>

  466. <h2 class="memtitle"><span class="permalink"><a href="#a919d9746e01fa6ca7083e17242b371d2">&#9670;&nbsp;</a></span>plus() <span class="overload">[2/2]</span></h2>

  467. 

  468. <div class="memitem">

  469. <div class="memproto">

  470. <table class="mlabels">

  471.   <tr>

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

  473.       <table class="memname">

  474.         <tr>

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

  476.           <td>(</td>

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

  478.           <td class="paramname"><em>value</em></td><td>)</td>

  479.           <td> const</td>

  480.         </tr>

  481.       </table>

  482.   </td>

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

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

  485.   </tr>

  486. </table>

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

  488. <p>Create a new color based on this one but with added floating-point value on all elements. Value must be in [0..1] range. </p>

  489. 

  490. </div>

  491. </div>

  492. <a id="a1cc575ce361080042b5072f91ca52893"></a>

  493. <h2 class="memtitle"><span class="permalink"><a href="#a1cc575ce361080042b5072f91ca52893">&#9670;&nbsp;</a></span>invert()</h2>

  494. 

  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"><a class="el" href="structColor.html">Color</a> Color::invert </td>

  503.           <td>(</td>

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

  505.           <td> const</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>Create a new color based on this one but colors inverted. </p>

  515. 

  516. </div>

  517. </div>

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

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

  520. 

  521. <div class="memitem">

  522. <div class="memproto">

  523. <table class="mlabels">

  524.   <tr>

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

  526.       <table class="memname">

  527.         <tr>

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

  529.           <td>(</td>

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

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

  532.         </tr>

  533.         <tr>

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

  535.           <td></td>

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

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

  538.         </tr>

  539.         <tr>

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

  541.           <td></td>

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

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

  544.         </tr>

  545.         <tr>

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

  547.           <td></td>

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

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

  550.         </tr>

  551.         <tr>

  552.           <td></td>

  553.           <td>)</td>

  554.           <td></td><td></td>

  555.         </tr>

  556.       </table>

  557.   </td>

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

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

  560.   </tr>

  561. </table>

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

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

  564. 

  565. </div>

  566. </div>

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

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

  569. 

  570. <div class="memitem">

  571. <div class="memproto">

  572. <table class="mlabels">

  573.   <tr>

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

  575.       <table class="memname">

  576.         <tr>

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

  578.           <td>(</td>

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

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

  581.         </tr>

  582.         <tr>

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

  584.           <td></td>

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

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

  587.         </tr>

  588.         <tr>

  589.           <td></td>

  590.           <td>)</td>

  591.           <td></td><td></td>

  592.         </tr>

  593.       </table>

  594.   </td>

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

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

  597.   </tr>

  598. </table>

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

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

  601. 

  602. </div>

  603. </div>

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

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

  606. 

  607. <div class="memitem">

  608. <div class="memproto">

  609. <table class="mlabels">

  610.   <tr>

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

  612.       <table class="memname">

  613.         <tr>

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

  615.           <td>(</td>

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

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

  618.         </tr>

  619.         <tr>

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

  621.           <td></td>

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

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

  624.         </tr>

  625.         <tr>

  626.           <td></td>

  627.           <td>)</td>

  628.           <td></td><td></td>

  629.         </tr>

  630.       </table>

  631.   </td>

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

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

  634.   </tr>

  635. </table>

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

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

  638. 

  639. </div>

  640. </div>

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

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

  643. 

  644. <div class="memitem">

  645. <div class="memproto">

  646. <table class="mlabels">

  647.   <tr>

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

  649.       <table class="memname">

  650.         <tr>

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

  652.           <td>(</td>

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

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

  655.         </tr>

  656.         <tr>

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

  658.           <td></td>

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

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

  661.         </tr>

  662.         <tr>

  663.           <td></td>

  664.           <td>)</td>

  665.           <td></td><td></td>

  666.         </tr>

  667.       </table>

  668.   </td>

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

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

  671.   </tr>

  672. </table>

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

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

  675. 

  676. </div>

  677. </div>

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

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

  680. 

  681. <div class="memitem">

  682. <div class="memproto">

  683. <table class="mlabels">

  684.   <tr>

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

  686.       <table class="memname">

  687.         <tr>

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

  689.           <td>(</td>

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

  691.           <td></td>

  692.         </tr>

  693.       </table>

  694.   </td>

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

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

  697.   </tr>

  698. </table>

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

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

  701. 

  702. </div>

  703. </div>

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

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

  706. 

  707. <div class="memitem">

  708. <div class="memproto">

  709.       <table class="memname">

  710.         <tr>

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

  712.           <td>(</td>

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

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

  715.         </tr>

  716.         <tr>

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

  718.           <td></td>

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

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

  721.         </tr>

  722.         <tr>

  723.           <td></td>

  724.           <td>)</td>

  725.           <td></td><td></td>

  726.         </tr>

  727.       </table>

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

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

  730. 

  731. </div>

  732. </div>

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

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

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

  736. 

  737. <div class="memitem">

  738. <div class="memproto">

  739.       <table class="memname">

  740.         <tr>

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

  742.         </tr>

  743.       </table>

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

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

  746. 

  747. </div>

  748. </div>

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

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

  751. </ul>

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

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

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

  755. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1

  756. </small></address>

  757. </body>

  758. </html>