boost/libs/gil/doc/html/reference/group___scoped_channel_value.html
2021-10-05 21:37:46 +02:00

67 lines
5.2 KiB
HTML

<!-- HTML header for doxygen 1.8.13-->
<!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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Generic Image Library: scoped_channel_value</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="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div class="boost-header">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
<tr>
<td valign="top" width="300">
<h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
</td>
<td ><h1 align="center"><a href="../index.html"></a></h1></td>
<td></td>
</tr>
</table>
</div>
<hr/>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- Generated by Doxygen 1.8.15 -->
<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&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> </div>
<div class="headertitle">
<div class="title">scoped_channel_value<div class="ingroups"><a class="el" href="group___channel.html">Channel</a> &raquo; <a class="el" href="group___channel_model.html">Models</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group___packed_channel_value_model"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___packed_channel_value_model.html">packed_channel_value</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Traits for channels. Contains the following members: </p><div class="fragment"><div class="line"><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Channel&gt;</div><div class="line"><span class="keyword">struct </span>channel_traits {</div><div class="line"> <span class="keyword">using</span> value_type = ...;</div><div class="line"> <span class="keyword">using</span> reference = ...;</div><div class="line"> <span class="keyword">using</span> pointer = ...;</div><div class="line"> <span class="keyword">using</span> const_reference = ...;</div><div class="line"> <span class="keyword">using</span> const_pointer = ...;</div><div class="line"></div><div class="line"> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> is_mutable;</div><div class="line"> <span class="keyword">static</span> value_type min_value();</div><div class="line"> <span class="keyword">static</span> value_type max_value();</div><div class="line">};</div></div><!-- fragment --><p>A channel adaptor that modifies the range of the source channel. Models: ChannelValueConcept</p>
<p>Example: </p><div class="fragment"><div class="line"><span class="comment">// Create a double channel with range [-0.5 .. 0.5]</span></div><div class="line"><span class="keyword">struct </span>double_minus_half { <span class="keyword">static</span> <span class="keywordtype">double</span> apply() { <span class="keywordflow">return</span> -0.5; } };</div><div class="line"><span class="keyword">struct </span>double_plus_half { <span class="keyword">static</span> <span class="keywordtype">double</span> apply() { <span class="keywordflow">return</span> 0.5; } };</div><div class="line"><span class="keyword">using</span> bits64custom_t = scoped_channel_value&lt;double, double_minus_half, double_plus_half&gt;;</div><div class="line"></div><div class="line"><span class="comment">// channel_convert its maximum should map to the maximum</span></div><div class="line">bits64custom_t x = channel_traits&lt;bits64custom_t&gt;::max_value();</div><div class="line">assert(x == 0.5);</div><div class="line">uint16_t y = channel_convert&lt;uint16_t&gt;(x);</div><div class="line">assert(y == 65535);</div></div><!-- fragment --> </div><!-- contents -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<hr class="footer"/>
<address class="footer">
<small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
</small>
</address>
</body>
</html>