|
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.17"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>DISTRHO Plugin Framework: dgl/Color.hpp Source File</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">DISTRHO Plugin Framework
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.17 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
-
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
-
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="dir_99893ac99dd47c2a73745483a12a725f.html">dgl</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="headertitle">
- <div class="title">Color.hpp</div> </div>
- </div><!--header-->
- <div class="contents">
- <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
- <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>
- <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com></span></div>
- <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
- <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>
- <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>
- <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * permission notice appear in all copies.</span></div>
- <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
- <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>
- <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>
- <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>
- <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>
- <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>
- <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
- <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
- <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef DGL_COLOR_HPP_INCLUDED</span></div>
- <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define DGL_COLOR_HPP_INCLUDED</span></div>
- <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
- <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "Base.hpp"</span></div>
- <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
- <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">struct </span>NVGcolor;</div>
- <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
- <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> START_NAMESPACE_DGL</div>
- <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
- <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> A color made from red, green, blue and alpha floating-point values in [0..1] range.</span></div>
- <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">*/</span></div>
- <div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structColor.html"> 31</a></span> <span class="keyword">struct </span><a class="code" href="structColor.html">Color</a> {<span class="comment"></span></div>
- <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> Direct access to the color values.</span></div>
- <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">union </span>{</div>
- <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">float</span> rgba[4];</div>
- <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">struct </span>{ <span class="keywordtype">float</span> red, green, blue, alpha; };</div>
- <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  };</div>
- <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> Create solid black color.</span></div>
- <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="structColor.html#acbbdba6661c2bbd987ef27de59813b47">Color</a>() noexcept;</div>
- <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> Create a color from red, green, blue and alpha numeric values.</span></div>
- <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> All values except alpha must be in [0..255] range, with alpha in [0..1] range.</span></div>
- <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="structColor.html#acbbdba6661c2bbd987ef27de59813b47">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>
- <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> Create a color from red, green, blue and alpha floating-point values.</span></div>
- <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> All values must in [0..1] range.</span></div>
- <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="structColor.html#acbbdba6661c2bbd987ef27de59813b47">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>
- <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> Create a color by copying another color.</span></div>
- <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="structColor.html#acbbdba6661c2bbd987ef27de59813b47">Color</a>(<span class="keyword">const</span> <a class="code" href="structColor.html">Color</a>& color) noexcept;</div>
- <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="structColor.html">Color</a>& operator=(<span class="keyword">const</span> <a class="code" href="structColor.html">Color</a>& color) noexcept;</div>
- <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> Create a color by linearly interpolating two other colors.</span></div>
- <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="structColor.html#acbbdba6661c2bbd987ef27de59813b47">Color</a>(<span class="keyword">const</span> <a class="code" href="structColor.html">Color</a>& color1, <span class="keyword">const</span> <a class="code" href="structColor.html">Color</a>& color2, <span class="keywordtype">float</span> u) noexcept;</div>
- <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> Create a color specified by hue, saturation and lightness.</span></div>
- <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> Values must in [0..1] range.</span></div>
- <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">static</span> <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>
- <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> Create a color from a HTML string like "#333" or "#112233".</span></div>
- <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">static</span> <a class="code" href="structColor.html">Color</a> <a class="code" href="structColor.html#abdc66d9b8c6422a721f8d576e871f646">fromHTML</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* rgb, <span class="keywordtype">float</span> alpha = 1.0f) noexcept;</div>
- <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> Linearly interpolate this color against another.</span></div>
- <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">void</span> <a class="code" href="structColor.html#a96283f5b9ad6f6465e40f69012aca00f">interpolate</a>(<span class="keyword">const</span> <a class="code" href="structColor.html">Color</a>& other, <span class="keywordtype">float</span> u) noexcept;</div>
- <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> Check if this color matches another.</span></div>
- <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> @note Comparison is done within 8-bit color space.</span></div>
- <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">bool</span> <a class="code" href="structColor.html#a16880d42b2d52ed23eb307ed2980a9a3">isEqual</a>(<span class="keyword">const</span> <a class="code" href="structColor.html">Color</a>& color, <span class="keywordtype">bool</span> withAlpha = <span class="keyword">true</span>) noexcept;</div>
- <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">bool</span> isNotEqual(<span class="keyword">const</span> <a class="code" href="structColor.html">Color</a>& color, <span class="keywordtype">bool</span> withAlpha = <span class="keyword">true</span>) noexcept;</div>
- <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code" href="structColor.html">Color</a>& color) noexcept;</div>
- <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> <a class="code" href="structColor.html">Color</a>& color) noexcept;</div>
- <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> Fix color bounds if needed.</span></div>
- <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> <a class="code" href="structColor.html#aad01f46af4cdb18b2bcbddd3f63d14d5">fixBounds</a>() noexcept;</div>
- <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> Set this color for use in the next drawing operation for the provided context.</span></div>
- <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">void</span> <a class="code" href="structColor.html#a9bd4efab0718f412babc62398875a80f">setFor</a>(<span class="keyword">const</span> <a class="code" href="structGraphicsContext.html">GraphicsContext</a>& context, <span class="keywordtype">bool</span> includeAlpha = <span class="keyword">false</span>);</div>
- <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> @internal</span></div>
- <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> Needed for NanoVG compatibility.</span></div>
- <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="structColor.html#acbbdba6661c2bbd987ef27de59813b47">Color</a>(<span class="keyword">const</span> NVGcolor&) noexcept;</div>
- <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">operator</span> NVGcolor() <span class="keyword">const</span> noexcept;</div>
- <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> };</div>
- <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div>
- <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div>
- <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> END_NAMESPACE_DGL</div>
- <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  </div>
- <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor">#endif // DGL_COLOR_HPP_INCLUDED</span></div>
- </div><!-- fragment --></div><!-- contents -->
- <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>
- <div class="ttc" id="astructGraphicsContext_html"><div class="ttname"><a href="structGraphicsContext.html">GraphicsContext</a></div><div class="ttdef"><b>Definition:</b> Base.hpp:154</div></div>
- <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 &other, float u) noexcept</div></div>
- <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 &context, bool includeAlpha=false)</div></div>
- <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>
- <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>
- <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 &color, bool withAlpha=true) noexcept</div></div>
- <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>
- <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>
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Tue Jun 15 2021 12:29:15 for DISTRHO Plugin Framework by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.17
- </small></address>
- </body>
- </html>
|