structhueplusplus_1_1_color_gamut.html 11.7 KB

Edit Raw Blame History

<!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: hueplusplus::ColorGamut Struct 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="namespacehueplusplus.html">hueplusplus</a></li><li class="navelem"><a class="el" href="structhueplusplus_1_1_color_gamut.html">ColorGamut</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structhueplusplus_1_1_color_gamut-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">hueplusplus::ColorGamut Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Triangle of representable colors in CIE.
 <a href="structhueplusplus_1_1_color_gamut.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_color_units_8h_source.html">hueplusplus/ColorUnits.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for hueplusplus::ColorGamut:</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="structhueplusplus_1_1_color_gamut__coll__graph.png" border="0" usemap="#hueplusplus_1_1_color_gamut_coll__map" alt="Collaboration graph"/></div>
<map name="hueplusplus_1_1_color_gamut_coll__map" id="hueplusplus_1_1_color_gamut_coll__map">
<area shape="rect" id="node2" href="structhueplusplus_1_1_x_y.html" title="Color in CIE x and y coordinates. " alt="" coords="36,5,161,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a286da2551cbd3d1ae5b538567a78dff0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhueplusplus_1_1_color_gamut.html#a286da2551cbd3d1ae5b538567a78dff0">contains</a> (const <a class="el" href="structhueplusplus_1_1_x_y.html">XY</a> &amp;xy) const</td></tr>
<tr class="memdesc:a286da2551cbd3d1ae5b538567a78dff0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether <code>xy</code> is representable.  <a href="#a286da2551cbd3d1ae5b538567a78dff0">More...</a><br /></td></tr>
<tr class="separator:a286da2551cbd3d1ae5b538567a78dff0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9626b384bd9869f0bc855f868cabcce7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structhueplusplus_1_1_x_y.html">XY</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhueplusplus_1_1_color_gamut.html#a9626b384bd9869f0bc855f868cabcce7">corrected</a> (const <a class="el" href="structhueplusplus_1_1_x_y.html">XY</a> &amp;xy) const</td></tr>
<tr class="memdesc:a9626b384bd9869f0bc855f868cabcce7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Correct <code>xy</code> to closest representable color.  <a href="#a9626b384bd9869f0bc855f868cabcce7">More...</a><br /></td></tr>
<tr class="separator:a9626b384bd9869f0bc855f868cabcce7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:acf9e80c64c782650c04e34a6b1c6b4e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structhueplusplus_1_1_x_y.html">XY</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhueplusplus_1_1_color_gamut.html#acf9e80c64c782650c04e34a6b1c6b4e4">redCorner</a></td></tr>
<tr class="memdesc:acf9e80c64c782650c04e34a6b1c6b4e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Red corner in the color triangle.  <a href="#acf9e80c64c782650c04e34a6b1c6b4e4">More...</a><br /></td></tr>
<tr class="separator:acf9e80c64c782650c04e34a6b1c6b4e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d93ca1f02b429cb463ceb214a01437e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structhueplusplus_1_1_x_y.html">XY</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhueplusplus_1_1_color_gamut.html#a3d93ca1f02b429cb463ceb214a01437e">greenCorner</a></td></tr>
<tr class="memdesc:a3d93ca1f02b429cb463ceb214a01437e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Green corner in the color triangle.  <a href="#a3d93ca1f02b429cb463ceb214a01437e">More...</a><br /></td></tr>
<tr class="separator:a3d93ca1f02b429cb463ceb214a01437e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9300f0d4b86be5dfae499f4e4d61c9a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structhueplusplus_1_1_x_y.html">XY</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhueplusplus_1_1_color_gamut.html#a9300f0d4b86be5dfae499f4e4d61c9a8">blueCorner</a></td></tr>
<tr class="memdesc:a9300f0d4b86be5dfae499f4e4d61c9a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blue corner in the color triangle.  <a href="#a9300f0d4b86be5dfae499f4e4d61c9a8">More...</a><br /></td></tr>
<tr class="separator:a9300f0d4b86be5dfae499f4e4d61c9a8"><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>Triangle of representable colors in CIE. </p>
<dl class="section note"><dt>Note</dt><dd>Red, green and blue corner are oriented counter clockwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a href="https://en.wikipedia.org/wiki/Chromaticity">https://en.wikipedia.org/wiki/Chromaticity</a> </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a286da2551cbd3d1ae5b538567a78dff0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a286da2551cbd3d1ae5b538567a78dff0">&#9670;&nbsp;</a></span>contains()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool hueplusplus::ColorGamut::contains </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structhueplusplus_1_1_x_y.html">XY</a> &amp;&#160;</td>
          <td class="paramname"><em>xy</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check whether <code>xy</code> is representable. </p>

</div>
</div>
<a id="a9626b384bd9869f0bc855f868cabcce7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9626b384bd9869f0bc855f868cabcce7">&#9670;&nbsp;</a></span>corrected()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structhueplusplus_1_1_x_y.html">XY</a> hueplusplus::ColorGamut::corrected </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structhueplusplus_1_1_x_y.html">XY</a> &amp;&#160;</td>
          <td class="paramname"><em>xy</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Correct <code>xy</code> to closest representable color. </p>
<dl class="section return"><dt>Returns</dt><dd><code>xy</code> if it is in the triangle, otherwise the closest point on the border. </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9300f0d4b86be5dfae499f4e4d61c9a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9300f0d4b86be5dfae499f4e4d61c9a8">&#9670;&nbsp;</a></span>blueCorner</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structhueplusplus_1_1_x_y.html">XY</a> hueplusplus::ColorGamut::blueCorner</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Blue corner in the color triangle. </p>

</div>
</div>
<a id="a3d93ca1f02b429cb463ceb214a01437e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d93ca1f02b429cb463ceb214a01437e">&#9670;&nbsp;</a></span>greenCorner</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structhueplusplus_1_1_x_y.html">XY</a> hueplusplus::ColorGamut::greenCorner</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Green corner in the color triangle. </p>

</div>
</div>
<a id="acf9e80c64c782650c04e34a6b1c6b4e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf9e80c64c782650c04e34a6b1c6b4e4">&#9670;&nbsp;</a></span>redCorner</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structhueplusplus_1_1_x_y.html">XY</a> hueplusplus::ColorGamut::redCorner</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Red corner in the color triangle. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>include/hueplusplus/<a class="el" href="_color_units_8h_source.html">ColorUnits.h</a></li>
<li>src/<a class="el" href="_color_units_8cpp.html">ColorUnits.cpp</a></li>
</ul>
</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>