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.

241 lines
31KB

  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: dgl/Color.hpp Source File</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. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. <div id="nav-path" class="navpath">
  61. <ul>
  62. <li class="navelem"><a class="el" href="dir_99893ac99dd47c2a73745483a12a725f.html">dgl</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="headertitle">
  67. <div class="title">Color.hpp</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
  71. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>
  72. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright (C) 2012-2022 Filipe Coelho &lt;falktx@falktx.com&gt;</span></div>
  73. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
  74. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>
  75. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>
  76. <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * permission notice appear in all copies.</span></div>
  77. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
  78. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>
  79. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>
  80. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>
  81. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>
  82. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>
  83. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
  84. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> */</span></div>
  85. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
  86. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef DGL_COLOR_HPP_INCLUDED</span></div>
  87. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define DGL_COLOR_HPP_INCLUDED</span></div>
  88. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
  89. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;Base.hpp&quot;</span></div>
  90. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
  91. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">struct </span>NVGcolor;</div>
  92. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
  93. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;START_NAMESPACE_DGL</div>
  94. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
  95. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
  96. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"></span> </div>
  97. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment">/**</span></div>
  98. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> A color made from red, green, blue and alpha floating-point values in [0..1] range.</span></div>
  99. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment">*/</span></div>
  100. <div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structColor.html"> 31</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structColor.html">Color</a> {<span class="comment"></span></div>
  101. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> /**</span></div>
  102. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"> Direct access to the color values.</span></div>
  103. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> */</span></div>
  104. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">union </span>{</div>
  105. <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">float</span> rgba[4];</div>
  106. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">struct </span>{ <span class="keywordtype">float</span> red, green, blue, alpha; };</div>
  107. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; };</div>
  108. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"></span> </div>
  109. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> /**</span></div>
  110. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"> Create solid black color.</span></div>
  111. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"> */</span></div>
  112. <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structColor.html#acbbdba6661c2bbd987ef27de59813b47"> 43</a></span>&#160; <a class="code" href="structColor.html#acbbdba6661c2bbd987ef27de59813b47">Color</a>() noexcept;</div>
  113. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"></span> </div>
  114. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment"> /**</span></div>
  115. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> Create a color from red, green, blue and alpha numeric values.</span></div>
  116. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment"> All values except alpha must be in [0..255] range, with alpha in [0..1] range.</span></div>
  117. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"> */</span></div>
  118. <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structColor.html#ab5f3b6caec37b3ba8f7a04c801c63847"> 49</a></span>&#160; <a class="code" href="structColor.html">Color</a>(<span class="keywordtype">int</span> red, <span class="keywordtype">int</span> green, <span class="keywordtype">int</span> blue, <span class="keywordtype">float</span> alpha = 1.0f) noexcept;</div>
  119. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"></span> </div>
  120. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"> /**</span></div>
  121. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> Create a color from red, green, blue and alpha floating-point values.</span></div>
  122. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment"> All values must in [0..1] range.</span></div>
  123. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment"> */</span></div>
  124. <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structColor.html#a77dd2b8f997aaf034c790ffd4ffe64bc"> 55</a></span>&#160; <a class="code" href="structColor.html">Color</a>(<span class="keywordtype">float</span> red, <span class="keywordtype">float</span> green, <span class="keywordtype">float</span> blue, <span class="keywordtype">float</span> alpha = 1.0f) noexcept;</div>
  125. <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"></span> </div>
  126. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment"> /**</span></div>
  127. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment"> Create a color by copying another color.</span></div>
  128. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment"> */</span></div>
  129. <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structColor.html#a7ac8018890423379bf8cdce2c6bc9d7e"> 60</a></span>&#160; <a class="code" href="structColor.html">Color</a>(const <a class="code" href="structColor.html">Color</a>&amp; color) noexcept;</div>
  130. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <a class="code" href="structColor.html">Color</a>&amp; operator=(const <a class="code" href="structColor.html">Color</a>&amp; color) noexcept;</div>
  131. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="comment"></span> </div>
  132. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment"> /**</span></div>
  133. <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment"> Create a color by linearly interpolating two other colors.</span></div>
  134. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"> */</span></div>
  135. <div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="structColor.html#a8d51b3f9457c1d9524ad67c94152b99a"> 66</a></span>&#160; <a class="code" href="structColor.html">Color</a>(const <a class="code" href="structColor.html">Color</a>&amp; color1, const <a class="code" href="structColor.html">Color</a>&amp; color2, <span class="keywordtype">float</span> u) noexcept;</div>
  136. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="comment"></span> </div>
  137. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="comment"> /**</span></div>
  138. <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="comment"> Create a new color based on this one but with a different alpha value.</span></div>
  139. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment"> */</span></div>
  140. <div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="structColor.html#a3f163d59e5a313f742acdd2bbd47441f"> 71</a></span>&#160; <a class="code" href="structColor.html">Color</a> <a class="code" href="structColor.html#a3f163d59e5a313f742acdd2bbd47441f">withAlpha</a>(<span class="keywordtype">float</span> alpha) const noexcept;</div>
  141. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment"></span> </div>
  142. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment"> /**</span></div>
  143. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="comment"> Create a new color based on this one but with subtracted numeric value on all elements.</span></div>
  144. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="comment"> Value must be in [0..255] range.</span></div>
  145. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="comment"> */</span></div>
  146. <div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="structColor.html#a9649cf7255a6241a7b08fda056875853"> 77</a></span>&#160; <a class="code" href="structColor.html">Color</a> <a class="code" href="structColor.html#a9649cf7255a6241a7b08fda056875853">minus</a>(<span class="keywordtype">int</span> value) const noexcept;</div>
  147. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="comment"></span> </div>
  148. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="comment"> /**</span></div>
  149. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="comment"> Create a new color based on this one but with subtracted floating-point value on all elements.</span></div>
  150. <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="comment"> Value must be in [0..1] range.</span></div>
  151. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment"> */</span></div>
  152. <div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="structColor.html#abbd3f5d38f0b344179c7fd1aa6561fa3"> 83</a></span>&#160; <a class="code" href="structColor.html">Color</a> <a class="code" href="structColor.html#a9649cf7255a6241a7b08fda056875853">minus</a>(<span class="keywordtype">float</span> value) const noexcept;</div>
  153. <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment"></span> </div>
  154. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment"> /**</span></div>
  155. <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="comment"> Create a new color based on this one but with added numeric value on all elements.</span></div>
  156. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="comment"> Value must be in [0..255] range.</span></div>
  157. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="comment"> */</span></div>
  158. <div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="structColor.html#ad3c9595604828b97c3cf1bfeb323cfbe"> 89</a></span>&#160; <a class="code" href="structColor.html">Color</a> <a class="code" href="structColor.html#ad3c9595604828b97c3cf1bfeb323cfbe">plus</a>(<span class="keywordtype">int</span> value) const noexcept;</div>
  159. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="comment"></span> </div>
  160. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="comment"> /**</span></div>
  161. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="comment"> Create a new color based on this one but with added floating-point value on all elements.</span></div>
  162. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="comment"> Value must be in [0..1] range.</span></div>
  163. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="comment"> */</span></div>
  164. <div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="structColor.html#a919d9746e01fa6ca7083e17242b371d2"> 95</a></span>&#160; <a class="code" href="structColor.html">Color</a> <a class="code" href="structColor.html#ad3c9595604828b97c3cf1bfeb323cfbe">plus</a>(<span class="keywordtype">float</span> value) const noexcept;</div>
  165. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="comment"></span> </div>
  166. <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<span class="comment"> /**</span></div>
  167. <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="comment"> Create a new color based on this one but colors inverted.</span></div>
  168. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="comment"> */</span></div>
  169. <div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="structColor.html#a1cc575ce361080042b5072f91ca52893"> 100</a></span>&#160; <a class="code" href="structColor.html">Color</a> <a class="code" href="structColor.html#a1cc575ce361080042b5072f91ca52893">invert</a>() const noexcept;</div>
  170. <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="comment"></span> </div>
  171. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<span class="comment"> /**</span></div>
  172. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="comment"> Create a color specified by hue, saturation and lightness.</span></div>
  173. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="comment"> Values must in [0..1] range.</span></div>
  174. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="comment"> */</span></div>
  175. <div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="structColor.html#a41820f7349e997489d53f98036e76a0c"> 106</a></span>&#160; static <a class="code" href="structColor.html">Color</a> <a class="code" href="structColor.html#a41820f7349e997489d53f98036e76a0c">fromHSL</a>(<span class="keywordtype">float</span> hue, <span class="keywordtype">float</span> saturation, <span class="keywordtype">float</span> lightness, <span class="keywordtype">float</span> alpha = 1.0f);</div>
  176. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="comment"></span> </div>
  177. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="comment"> /**</span></div>
  178. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="comment"> Create a color from a HTML string like &quot;#333&quot; or &quot;#112233&quot;.</span></div>
  179. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment"> */</span></div>
  180. <div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="structColor.html#abdc66d9b8c6422a721f8d576e871f646"> 111</a></span>&#160; static <a class="code" href="structColor.html">Color</a> <a class="code" href="structColor.html#abdc66d9b8c6422a721f8d576e871f646">fromHTML</a>(const <span class="keywordtype">char</span>* rgb, <span class="keywordtype">float</span> alpha = 1.0f) noexcept;</div>
  181. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="comment"></span> </div>
  182. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="comment"> /**</span></div>
  183. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="comment"> Linearly interpolate this color against another.</span></div>
  184. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="comment"> */</span></div>
  185. <div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="structColor.html#a96283f5b9ad6f6465e40f69012aca00f"> 116</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="structColor.html#a96283f5b9ad6f6465e40f69012aca00f">interpolate</a>(const <a class="code" href="structColor.html">Color</a>&amp; other, <span class="keywordtype">float</span> u) noexcept;</div>
  186. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="comment"></span> </div>
  187. <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="comment"> /**</span></div>
  188. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="comment"> Check if this color matches another.</span></div>
  189. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;<span class="comment"> @note Comparison is done within 8-bit color space.</span></div>
  190. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="comment"> */</span></div>
  191. <div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="structColor.html#a16880d42b2d52ed23eb307ed2980a9a3"> 122</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structColor.html#a16880d42b2d52ed23eb307ed2980a9a3">isEqual</a>(const <a class="code" href="structColor.html">Color</a>&amp; color, <span class="keywordtype">bool</span> <a class="code" href="structColor.html#a3f163d59e5a313f742acdd2bbd47441f">withAlpha</a> = true) noexcept;</div>
  192. <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">bool</span> isNotEqual(const <a class="code" href="structColor.html">Color</a>&amp; color, <span class="keywordtype">bool</span> <a class="code" href="structColor.html#a3f163d59e5a313f742acdd2bbd47441f">withAlpha</a> = true) noexcept;</div>
  193. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordtype">bool</span> operator==(const <a class="code" href="structColor.html">Color</a>&amp; color) noexcept;</div>
  194. <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keywordtype">bool</span> operator!=(const <a class="code" href="structColor.html">Color</a>&amp; color) noexcept;</div>
  195. <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="comment"></span> </div>
  196. <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<span class="comment"> /**</span></div>
  197. <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="comment"> Fix color bounds if needed.</span></div>
  198. <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="comment"> */</span></div>
  199. <div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="structColor.html#aad01f46af4cdb18b2bcbddd3f63d14d5"> 130</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="structColor.html#aad01f46af4cdb18b2bcbddd3f63d14d5">fixBounds</a>() noexcept;</div>
  200. <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="comment"></span> </div>
  201. <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="comment"> /**</span></div>
  202. <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="comment"> Set this color for use in the next drawing operation for the provided context.</span></div>
  203. <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="comment"> */</span></div>
  204. <div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="structColor.html#a9bd4efab0718f412babc62398875a80f"> 135</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="structColor.html#a9bd4efab0718f412babc62398875a80f">setFor</a>(const <a class="code" href="structGraphicsContext.html">GraphicsContext</a>&amp; context, <span class="keywordtype">bool</span> includeAlpha = false);</div>
  205. <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="comment"></span> </div>
  206. <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="comment"> /**</span></div>
  207. <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="comment"> @internal</span></div>
  208. <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="comment"> Needed for NanoVG compatibility.</span></div>
  209. <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="comment"> */</span></div>
  210. <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <a class="code" href="structColor.html">Color</a>(const NVGcolor&amp;) noexcept;</div>
  211. <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; operator NVGcolor() const noexcept;</div>
  212. <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;};</div>
  213. <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; </div>
  214. <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
  215. <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; </div>
  216. <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;END_NAMESPACE_DGL</div>
  217. <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; </div>
  218. <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// DGL_COLOR_HPP_INCLUDED</span></div>
  219. <div class="ttc" id="astructColor_html"><div class="ttname"><a href="structColor.html">Color</a></div><div class="ttdef"><b>Definition:</b> Color.hpp:31</div></div>
  220. <div class="ttc" id="astructColor_html_a16880d42b2d52ed23eb307ed2980a9a3"><div class="ttname"><a href="structColor.html#a16880d42b2d52ed23eb307ed2980a9a3">Color::isEqual</a></div><div class="ttdeci">bool isEqual(const Color &amp;color, bool withAlpha=true) noexcept</div></div>
  221. <div class="ttc" id="astructColor_html_a1cc575ce361080042b5072f91ca52893"><div class="ttname"><a href="structColor.html#a1cc575ce361080042b5072f91ca52893">Color::invert</a></div><div class="ttdeci">Color invert() const noexcept</div></div>
  222. <div class="ttc" id="astructColor_html_a3f163d59e5a313f742acdd2bbd47441f"><div class="ttname"><a href="structColor.html#a3f163d59e5a313f742acdd2bbd47441f">Color::withAlpha</a></div><div class="ttdeci">Color withAlpha(float alpha) const noexcept</div></div>
  223. <div class="ttc" id="astructColor_html_a41820f7349e997489d53f98036e76a0c"><div class="ttname"><a href="structColor.html#a41820f7349e997489d53f98036e76a0c">Color::fromHSL</a></div><div class="ttdeci">static Color fromHSL(float hue, float saturation, float lightness, float alpha=1.0f)</div></div>
  224. <div class="ttc" id="astructColor_html_a96283f5b9ad6f6465e40f69012aca00f"><div class="ttname"><a href="structColor.html#a96283f5b9ad6f6465e40f69012aca00f">Color::interpolate</a></div><div class="ttdeci">void interpolate(const Color &amp;other, float u) noexcept</div></div>
  225. <div class="ttc" id="astructColor_html_a9649cf7255a6241a7b08fda056875853"><div class="ttname"><a href="structColor.html#a9649cf7255a6241a7b08fda056875853">Color::minus</a></div><div class="ttdeci">Color minus(int value) const noexcept</div></div>
  226. <div class="ttc" id="astructColor_html_a9bd4efab0718f412babc62398875a80f"><div class="ttname"><a href="structColor.html#a9bd4efab0718f412babc62398875a80f">Color::setFor</a></div><div class="ttdeci">void setFor(const GraphicsContext &amp;context, bool includeAlpha=false)</div></div>
  227. <div class="ttc" id="astructColor_html_aad01f46af4cdb18b2bcbddd3f63d14d5"><div class="ttname"><a href="structColor.html#aad01f46af4cdb18b2bcbddd3f63d14d5">Color::fixBounds</a></div><div class="ttdeci">void fixBounds() noexcept</div></div>
  228. <div class="ttc" id="astructColor_html_abdc66d9b8c6422a721f8d576e871f646"><div class="ttname"><a href="structColor.html#abdc66d9b8c6422a721f8d576e871f646">Color::fromHTML</a></div><div class="ttdeci">static Color fromHTML(const char *rgb, float alpha=1.0f) noexcept</div></div>
  229. <div class="ttc" id="astructColor_html_acbbdba6661c2bbd987ef27de59813b47"><div class="ttname"><a href="structColor.html#acbbdba6661c2bbd987ef27de59813b47">Color::Color</a></div><div class="ttdeci">Color() noexcept</div></div>
  230. <div class="ttc" id="astructColor_html_ad3c9595604828b97c3cf1bfeb323cfbe"><div class="ttname"><a href="structColor.html#ad3c9595604828b97c3cf1bfeb323cfbe">Color::plus</a></div><div class="ttdeci">Color plus(int value) const noexcept</div></div>
  231. <div class="ttc" id="astructGraphicsContext_html"><div class="ttname"><a href="structGraphicsContext.html">GraphicsContext</a></div><div class="ttdef"><b>Definition:</b> Base.hpp:253</div></div>
  232. </div><!-- fragment --></div><!-- contents -->
  233. <!-- start footer part -->
  234. <hr class="footer"/><address class="footer"><small>
  235. 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
  236. </small></address>
  237. </body>
  238. </html>