_color_units_8h.html 17.9 KB

Edit Raw Blame History Permalink

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>hueplusplus: include/hueplusplus/ColorUnits.h File Reference</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">hueplusplus
   &#160;<span id="projectnumber">1.0.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e05b4b7707bd5f9fd045e8be02b17d0a.html">hueplusplus</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">ColorUnits.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;cstdint&gt;</code><br />
</div><div class="textblock"><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Include dependency graph for ColorUnits.h:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="_color_units_8h__incl.png" border="0" usemap="#include_2hueplusplus_2_color_units_8h" alt=""/></div>
<map name="include_2hueplusplus_2_color_units_8h" id="include_2hueplusplus_2_color_units_8h">
</map>
</div>
</div><div class="textblock"><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png" alt="+"/> This graph shows which files directly or indirectly include this file:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="_color_units_8h__dep__incl.png" border="0" usemap="#include_2hueplusplus_2_color_units_8hdep" alt=""/></div>
<map name="include_2hueplusplus_2_color_units_8hdep" id="include_2hueplusplus_2_color_units_8hdep">
<area shape="rect" id="node2" href="_color_hue_strategy_8h.html" title="include/hueplusplus\l/ColorHueStrategy.h" alt="" coords="1436,95,1587,136"/>
<area shape="rect" id="node25" href="_state_transaction_8h.html" title="include/hueplusplus\l/StateTransaction.h" alt="" coords="1823,95,1973,136"/>
<area shape="rect" id="node29" href="_scene_8h.html" title="include/hueplusplus\l/Scene.h" alt="" coords="1648,95,1799,136"/>
<area shape="rect" id="node31" href="_color_units_8cpp.html" title="src/ColorUnits.cpp" alt="" coords="1997,102,2137,129"/>
<area shape="rect" id="node3" href="_bridge_8h.html" title="include/hueplusplus\l/Bridge.h" alt="" coords="1615,363,1765,404"/>
<area shape="rect" id="node11" href="_light_8h.html" title="include/hueplusplus\l/Light.h" alt="" coords="1252,184,1403,225"/>
<area shape="rect" id="node16" href="_simple_color_hue_strategy_8h.html" title="include/hueplusplus\l/SimpleColorHueStrategy.h" alt="" coords="319,273,515,315"/>
<area shape="rect" id="node4" href="_entertainment_mode_8h.html" title="include/hueplusplus\l/EntertainmentMode.h" alt="" coords="2191,452,2357,493"/>
<area shape="rect" id="node6" href="_bridge_8cpp.html" title="src/Bridge.cpp" alt="" coords="1633,459,1747,486"/>
<area shape="rect" id="node7" href="_bridge_setup_8cpp.html" title="examples/BridgeSetup.cpp" alt="" coords="1772,459,1968,486"/>
<area shape="rect" id="node8" href="_lights_off_8cpp.html" title="examples/LightsOff.cpp" alt="" coords="1992,459,2167,486"/>
<area shape="rect" id="node9" href="_snippets_8cpp.html" title="Contains code snippets used in the documentation, performs no useful functions. " alt="" coords="1185,459,1358,486"/>
<area shape="rect" id="node10" href="_username_config_8cpp.html" title="examples/UsernameConfig.cpp" alt="" coords="1383,459,1608,486"/>
<area shape="rect" id="node5" href="_entertainment_mode_8cpp.html" title="src/EntertainmentMode.cpp" alt="" coords="2174,541,2374,568"/>
<area shape="rect" id="node12" href="_hue_device_types_8h.html" title="include/hueplusplus\l/HueDeviceTypes.h" alt="" coords="1308,273,1459,315"/>
<area shape="rect" id="node14" href="_extended_color_hue_strategy_8h.html" title="include/hueplusplus\l/ExtendedColorHueStrategy.h" alt="" coords="311,363,523,404"/>
<area shape="rect" id="node18" href="_extended_color_temperature_strategy_8h.html" title="include/hueplusplus\l/ExtendedColorTemperatureStrategy.h" alt="" coords="1144,363,1412,404"/>
<area shape="rect" id="node20" href="_simple_color_temperature_strategy_8h.html" title="include/hueplusplus\l/SimpleColorTemperatureStrategy.h" alt="" coords="980,273,1232,315"/>
<area shape="rect" id="node22" href="_simple_brightness_strategy_8h.html" title="include/hueplusplus\l/SimpleBrightnessStrategy.h" alt="" coords="721,273,926,315"/>
<area shape="rect" id="node24" href="_light_8cpp.html" title="src/Light.cpp" alt="" coords="1483,281,1587,307"/>
<area shape="rect" id="node13" href="_hue_device_types_8cpp.html" title="src/HueDeviceTypes.cpp" alt="" coords="733,459,913,486"/>
<area shape="rect" id="node15" href="_extended_color_hue_strategy_8cpp.html" title="src/ExtendedColorHueStrategy.cpp" alt="" coords="293,459,540,486"/>
<area shape="rect" id="node17" href="_simple_color_hue_strategy_8cpp.html" title="src/SimpleColorHueStrategy.cpp" alt="" coords="5,370,236,397"/>
<area shape="rect" id="node19" href="_extended_color_temperature_strategy_8cpp.html" title="src/ExtendedColorTemperature\lStrategy.cpp" alt="" coords="937,452,1160,493"/>
<area shape="rect" id="node21" href="_simple_color_temperature_strategy_8cpp.html" title="src/SimpleColorTemperature\lStrategy.cpp" alt="" coords="861,363,1068,404"/>
<area shape="rect" id="node23" href="_simple_brightness_strategy_8cpp.html" title="src/SimpleBrightnessStrategy.cpp" alt="" coords="547,370,785,397"/>
<area shape="rect" id="node26" href="_group_8h.html" title="include/hueplusplus\l/Group.h" alt="" coords="1975,273,2125,315"/>
<area shape="rect" id="node28" href="_state_transaction_8cpp.html" title="src/StateTransaction.cpp" alt="" coords="1832,191,2012,218"/>
<area shape="rect" id="node27" href="_group_8cpp.html" title="src/Group.cpp" alt="" coords="2088,370,2199,397"/>
<area shape="rect" id="node30" href="_scene_8cpp.html" title="src/Scene.cpp" alt="" coords="1645,191,1756,218"/>
</map>
</div>
</div>
<p><a href="_color_units_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhueplusplus_1_1_hue_saturation.html">hueplusplus::HueSaturation</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Color in hue and saturation.  <a href="structhueplusplus_1_1_hue_saturation.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhueplusplus_1_1_x_y.html">hueplusplus::XY</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Color in CIE x and y coordinates.  <a href="structhueplusplus_1_1_x_y.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhueplusplus_1_1_x_y_brightness.html">hueplusplus::XYBrightness</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Color and brightness in CIE.  <a href="structhueplusplus_1_1_x_y_brightness.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhueplusplus_1_1_color_gamut.html">hueplusplus::ColorGamut</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Triangle of representable colors in CIE.  <a href="structhueplusplus_1_1_color_gamut.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhueplusplus_1_1_r_g_b.html">hueplusplus::RGB</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Color in <a class="el" href="structhueplusplus_1_1_r_g_b.html" title="Color in RGB. ">RGB</a>.  <a href="structhueplusplus_1_1_r_g_b.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacehueplusplus"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus.html">hueplusplus</a></td></tr>
<tr class="memdesc:namespacehueplusplus"><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespace for the hueplusplus library. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacehueplusplus_1_1gamut"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1gamut.html">hueplusplus::gamut</a></td></tr>
<tr class="memdesc:namespacehueplusplus_1_1gamut"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predefined <a class="el" href="structhueplusplus_1_1_color_gamut.html" title="Triangle of representable colors in CIE. ">ColorGamut</a>s for Hue API. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0e4f335c82751862f0f39a9e8a11820b"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus.html#a0e4f335c82751862f0f39a9e8a11820b">hueplusplus::kelvinToMired</a> (unsigned int kelvin)</td></tr>
<tr class="memdesc:a0e4f335c82751862f0f39a9e8a11820b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Const function that converts Kelvin to Mired.  <a href="namespacehueplusplus.html#a0e4f335c82751862f0f39a9e8a11820b">More...</a><br /></td></tr>
<tr class="separator:a0e4f335c82751862f0f39a9e8a11820b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6228dfc645d2b2f4280959b462117244"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus.html#a6228dfc645d2b2f4280959b462117244">hueplusplus::miredToKelvin</a> (unsigned int mired)</td></tr>
<tr class="memdesc:a6228dfc645d2b2f4280959b462117244"><td class="mdescLeft">&#160;</td><td class="mdescRight">Const function that converts Mired to Kelvin.  <a href="namespacehueplusplus.html#a6228dfc645d2b2f4280959b462117244">More...</a><br /></td></tr>
<tr class="separator:a6228dfc645d2b2f4280959b462117244"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:abd61ca546ae6e3d3bd168c1a42fc4f2f"><td class="memItemLeft" align="right" valign="top">constexpr ColorGamut&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1gamut.html#abd61ca546ae6e3d3bd168c1a42fc4f2f">hueplusplus::gamut::gamutA</a> {{0.704f, 0.296f}, {0.2151f, 0.7106f}, {0.138f, 0.08f}}</td></tr>
<tr class="memdesc:abd61ca546ae6e3d3bd168c1a42fc4f2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gamut A, used by most Color Lights.  <a href="namespacehueplusplus_1_1gamut.html#abd61ca546ae6e3d3bd168c1a42fc4f2f">More...</a><br /></td></tr>
<tr class="separator:abd61ca546ae6e3d3bd168c1a42fc4f2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6da695fd06906173a05d15e77c84b821"><td class="memItemLeft" align="right" valign="top">constexpr ColorGamut&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1gamut.html#a6da695fd06906173a05d15e77c84b821">hueplusplus::gamut::gamutB</a> {{0.675f, 0.322f}, {0.409f, 0.518f}, {0.167f, 0.04f}}</td></tr>
<tr class="memdesc:a6da695fd06906173a05d15e77c84b821"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gamut B, used by older Extended Color Lights.  <a href="namespacehueplusplus_1_1gamut.html#a6da695fd06906173a05d15e77c84b821">More...</a><br /></td></tr>
<tr class="separator:a6da695fd06906173a05d15e77c84b821"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f60620a263cb256bd4c89b958d4e342"><td class="memItemLeft" align="right" valign="top">constexpr ColorGamut&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1gamut.html#a3f60620a263cb256bd4c89b958d4e342">hueplusplus::gamut::gamutC</a> {{0.692f, 0.308f}, {0.17f, 0.7f}, {0.153f, 0.048f}}</td></tr>
<tr class="memdesc:a3f60620a263cb256bd4c89b958d4e342"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gamut C, used by newer Extended Color Lights.  <a href="namespacehueplusplus_1_1gamut.html#a3f60620a263cb256bd4c89b958d4e342">More...</a><br /></td></tr>
<tr class="separator:a3f60620a263cb256bd4c89b958d4e342"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67fc106cc7ec76c28ccb357404594693"><td class="memItemLeft" align="right" valign="top">constexpr ColorGamut&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1gamut.html#a67fc106cc7ec76c28ccb357404594693">hueplusplus::gamut::maxGamut</a> {{1.f, 0.f}, {0.f, 1.f}, {0.f, 0.f}}</td></tr>
<tr class="memdesc:a67fc106cc7ec76c28ccb357404594693"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximal gamut to be used when unknown.  <a href="namespacehueplusplus_1_1gamut.html#a67fc106cc7ec76c28ccb357404594693">More...</a><br /></td></tr>
<tr class="separator:a67fc106cc7ec76c28ccb357404594693"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Copyright Notice<br />
Copyright (C) 2017 Jan Rogall - developer<br />
Copyright (C) 2017 Moritz Wirger - developer<br />
 This file is part of hueplusplus.</p>
<p>hueplusplus is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
<p>hueplusplus is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</p>
<p>You should have received a copy of the GNU Lesser General Public License along with hueplusplus. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>