libs/gil/doc/html/reference/group___packed_channel_reference_model.html

   1 <!-- HTML header for doxygen 1.8.13-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4   <head>
   5     <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6     <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7     <meta name="generator" content="Doxygen 1.8.15"/>
   8     <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9     <title>Generic Image Library: packed_channel_reference</title>
  10     <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11     <script type="text/javascript" src="jquery.js"></script>
  12     <script type="text/javascript" src="dynsections.js"></script>
  13     <link href="doxygen.css" rel="stylesheet" type="text/css" />
  14     <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
  15   </head>
  16   <body>
  17     <div class="boost-header">
  18       <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
  19         <tr>
  20           <td valign="top" width="300">
  21             <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
  22           </td>
  23           <td ><h1 align="center"><a href="../index.html"></a></h1></td>
  24           <td></td>
  25         </tr>
  26       </table>
  27     </div>
  28     <hr/>
  29     <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  30 <!-- Generated by Doxygen 1.8.15 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#func-members">Functions</a>  </div>
  44   <div class="headertitle">
  45 <div class="title">packed_channel_reference<div class="ingroups"><a class="el" href="group___channel.html">Channel</a> &raquo; <a class="el" href="group___channel_model.html">Models</a> &raquo; <a class="el" href="group___scoped_channel_value.html">scoped_channel_value</a> &raquo; <a class="el" href="group___packed_channel_value_model.html">packed_channel_value</a></div></div>  </div>
  46 </div><!--header-->
  47 <div class="contents">
  48 <table class="memberdecls">
  49 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  50 Functions</h2></td></tr>
  51 <tr class="memitem:ga70de3c85964650c16afcc42c02bd5df9"><td class="memTemplParams" colspan="2"><a id="ga70de3c85964650c16afcc42c02bd5df9"></a>
  52 template&lt;typename BF , int FB, int NB, bool M, typename R &gt; </td></tr>
  53 <tr class="memitem:ga70de3c85964650c16afcc42c02bd5df9"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_reference_model.html#ga70de3c85964650c16afcc42c02bd5df9">swap</a> (boost::gil::packed_channel_reference&lt; BF, FB, NB, M &gt; const x, R &amp;y)</td></tr>
  54 <tr class="memdesc:ga70de3c85964650c16afcc42c02bd5df9"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_channel_reference <br /></td></tr>
  55 <tr class="separator:ga70de3c85964650c16afcc42c02bd5df9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56 <tr class="memitem:gaca47621e82bdf4e03cf6fee2e468a840"><td class="memTemplParams" colspan="2"><a id="gaca47621e82bdf4e03cf6fee2e468a840"></a>
  57 template&lt;typename BF , int FB, int NB, bool M&gt; </td></tr>
  58 <tr class="memitem:gaca47621e82bdf4e03cf6fee2e468a840"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_reference_model.html#gaca47621e82bdf4e03cf6fee2e468a840">swap</a> (typename boost::gil::packed_channel_reference&lt; BF, FB, NB, M &gt;::value_type &amp;x, boost::gil::packed_channel_reference&lt; BF, FB, NB, M &gt; const y)</td></tr>
  59 <tr class="memdesc:gaca47621e82bdf4e03cf6fee2e468a840"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_channel_reference <br /></td></tr>
  60 <tr class="separator:gaca47621e82bdf4e03cf6fee2e468a840"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 <tr class="memitem:ga9f03e6f5254fdfc3848a9a9c1bba13cb"><td class="memTemplParams" colspan="2"><a id="ga9f03e6f5254fdfc3848a9a9c1bba13cb"></a>
  62 template&lt;typename BF , int FB, int NB, bool M&gt; </td></tr>
  63 <tr class="memitem:ga9f03e6f5254fdfc3848a9a9c1bba13cb"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_reference_model.html#ga9f03e6f5254fdfc3848a9a9c1bba13cb">swap</a> (boost::gil::packed_channel_reference&lt; BF, FB, NB, M &gt; const x, boost::gil::packed_channel_reference&lt; BF, FB, NB, M &gt; const y)</td></tr>
  64 <tr class="memdesc:ga9f03e6f5254fdfc3848a9a9c1bba13cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_channel_reference <br /></td></tr>
  65 <tr class="separator:ga9f03e6f5254fdfc3848a9a9c1bba13cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 </table>
  67 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  68 <p>The value of a subbyte channel. Models: ChannelValueConcept</p>
  69 <p>Represents a reference proxy to a channel operating over a bit range whose offset is fixed at compile time. Models ChannelConcept Example: </p><div class="fragment"><div class="line"><span class="comment">// Reference to a 2-bit channel starting at bit 1 (i.e. the second bit)</span></div><div class="line"><span class="keyword">using</span> bits2_1_ref_t = packed_channel_reference&lt;uint16_t,1,2,true&gt; <span class="keyword">const</span>;</div><div class="line"></div><div class="line">uint16_t data=0;</div><div class="line">bits2_1_ref_t channel_ref(&amp;data);</div><div class="line">channel_ref = channel_traits&lt;bits2_1_ref_t&gt;::max_value();   <span class="comment">// == 3</span></div><div class="line">assert(data == 6);                                          <span class="comment">// == 3&lt;&lt;1 == 6</span></div></div><!-- fragment --> </div><!-- contents -->
  70      <!-- HTML footer for doxygen 1.8.13-->
  71      <!-- start footer part -->
  72      <hr class="footer"/>
  73      <address class="footer">
  74       <small>
  75         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  76       </small>
  77     </address>
  78   </body>
  79 </html>