libs/gil/doc/html/reference/classboost_1_1gil_1_1bit__range.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: bit_range&lt; RangeSize, IsMutable &gt; Class Template 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 id="nav-path" class="navpath">
  41   <ul>
  42 <li class="navelem"><b>boost</b></li><li class="navelem"><b>gil</b></li><li class="navelem"><a class="el" href="classboost_1_1gil_1_1bit__range.html">bit_range</a></li>  </ul>
  43 </div>
  44 </div><!-- top -->
  45 <div class="header">
  46   <div class="summary">
  47 <a href="#pub-types">Public Types</a> &#124;
  48 <a href="#pub-methods">Public Member Functions</a> &#124;
  49 <a href="#friends">Friends</a> &#124;
  50 <a href="classboost_1_1gil_1_1bit__range-members.html">List of all members</a>  </div>
  51   <div class="headertitle">
  52 <div class="title">bit_range&lt; RangeSize, IsMutable &gt; Class Template Reference</div>  </div>
  53 </div><!--header-->
  54 <div class="contents">
  55
  56 <p><code>#include &lt;<a class="el" href="bit__aligned__pixel__reference_8hpp_source.html">bit_aligned_pixel_reference.hpp</a>&gt;</code></p>
  57 <table class="memberdecls">
  58 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  59 Public Types</h2></td></tr>
  60 <tr class="memitem:a7e9bf15e4450a6b4abd2ad5684b2a226"><td class="memItemLeft" align="right" valign="top"><a id="a7e9bf15e4450a6b4abd2ad5684b2a226"></a>
  61 using&#160;</td><td class="memItemRight" valign="bottom"><b>byte_t</b> = mp11::mp_if_c&lt; IsMutable, unsigned char, unsigned char const  &gt;</td></tr>
  62 <tr class="separator:a7e9bf15e4450a6b4abd2ad5684b2a226"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63 <tr class="memitem:ace405568d0b2f3fad4990044252c7732"><td class="memItemLeft" align="right" valign="top"><a id="ace405568d0b2f3fad4990044252c7732"></a>
  64 using&#160;</td><td class="memItemRight" valign="bottom"><b>difference_type</b> = std::ptrdiff_t</td></tr>
  65 <tr class="separator:ace405568d0b2f3fad4990044252c7732"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 </table><table class="memberdecls">
  67 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  68 Public Member Functions</h2></td></tr>
  69 <tr class="memitem:ac338775a679b30de801876cf3ea4300b"><td class="memItemLeft" align="right" valign="top"><a id="ac338775a679b30de801876cf3ea4300b"></a>
  70 &#160;</td><td class="memItemRight" valign="bottom"><b>bit_range</b> (byte_t *current_byte, int bit_offset)</td></tr>
  71 <tr class="separator:ac338775a679b30de801876cf3ea4300b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <tr class="memitem:a0dc195da8f84da41d2d56d1799d6b485"><td class="memItemLeft" align="right" valign="top"><a id="a0dc195da8f84da41d2d56d1799d6b485"></a>
  73 &#160;</td><td class="memItemRight" valign="bottom"><b>bit_range</b> (const <a class="el" href="classboost_1_1gil_1_1bit__range.html">bit_range</a> &amp;br)</td></tr>
  74 <tr class="separator:a0dc195da8f84da41d2d56d1799d6b485"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:a1840bb7b73d5630c331cfc03b5bc704d"><td class="memTemplParams" colspan="2"><a id="a1840bb7b73d5630c331cfc03b5bc704d"></a>
  76 template&lt;bool M&gt; </td></tr>
  77 <tr class="memitem:a1840bb7b73d5630c331cfc03b5bc704d"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>bit_range</b> (const <a class="el" href="classboost_1_1gil_1_1bit__range.html">bit_range</a>&lt; RangeSize, M &gt; &amp;br)</td></tr>
  78 <tr class="separator:a1840bb7b73d5630c331cfc03b5bc704d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79 <tr class="memitem:a089e26c692c4b65f2d78f480ac193d98"><td class="memItemLeft" align="right" valign="top"><a id="a089e26c692c4b65f2d78f480ac193d98"></a>
  80 <a class="el" href="classboost_1_1gil_1_1bit__range.html">bit_range</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classboost_1_1gil_1_1bit__range.html">bit_range</a> &amp;br)</td></tr>
  81 <tr class="separator:a089e26c692c4b65f2d78f480ac193d98"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <tr class="memitem:ab146112ec4ac1dee85ca78bfad35c383"><td class="memItemLeft" align="right" valign="top"><a id="ab146112ec4ac1dee85ca78bfad35c383"></a>
  83 bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classboost_1_1gil_1_1bit__range.html">bit_range</a> &amp;br) const</td></tr>
  84 <tr class="separator:ab146112ec4ac1dee85ca78bfad35c383"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85 <tr class="memitem:ac927156c7cc182436b04bda2c3b6aa7b"><td class="memItemLeft" align="right" valign="top"><a id="ac927156c7cc182436b04bda2c3b6aa7b"></a>
  86 <a class="el" href="classboost_1_1gil_1_1bit__range.html">bit_range</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator++</b> ()</td></tr>
  87 <tr class="separator:ac927156c7cc182436b04bda2c3b6aa7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:a784caf9d9cdb40e5af2e5dba63c7cbd2"><td class="memItemLeft" align="right" valign="top"><a id="a784caf9d9cdb40e5af2e5dba63c7cbd2"></a>
  89 <a class="el" href="classboost_1_1gil_1_1bit__range.html">bit_range</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator--</b> ()</td></tr>
  90 <tr class="separator:a784caf9d9cdb40e5af2e5dba63c7cbd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91 <tr class="memitem:a81e62aa4195c728fa378dfe335f8d7c9"><td class="memItemLeft" align="right" valign="top"><a id="a81e62aa4195c728fa378dfe335f8d7c9"></a>
  92 void&#160;</td><td class="memItemRight" valign="bottom"><b>bit_advance</b> (difference_type num_bits)</td></tr>
  93 <tr class="separator:a81e62aa4195c728fa378dfe335f8d7c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:a9acf422d26ec62037eea0d68f619b783"><td class="memItemLeft" align="right" valign="top"><a id="a9acf422d26ec62037eea0d68f619b783"></a>
  95 difference_type&#160;</td><td class="memItemRight" valign="bottom"><b>bit_distance_to</b> (const <a class="el" href="classboost_1_1gil_1_1bit__range.html">bit_range</a> &amp;b) const</td></tr>
  96 <tr class="separator:a9acf422d26ec62037eea0d68f619b783"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97 <tr class="memitem:aa2e9b071dfe866df671067d5dca99141"><td class="memItemLeft" align="right" valign="top"><a id="aa2e9b071dfe866df671067d5dca99141"></a>
  98 byte_t *&#160;</td><td class="memItemRight" valign="bottom"><b>current_byte</b> () const</td></tr>
  99 <tr class="separator:aa2e9b071dfe866df671067d5dca99141"><td class="memSeparator" colspan="2">&#160;</td></tr>
 100 <tr class="memitem:a2c771117039fc897c3d219be8fa6511d"><td class="memItemLeft" align="right" valign="top"><a id="a2c771117039fc897c3d219be8fa6511d"></a>
 101 int&#160;</td><td class="memItemRight" valign="bottom"><b>bit_offset</b> () const</td></tr>
 102 <tr class="separator:a2c771117039fc897c3d219be8fa6511d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 103 </table><table class="memberdecls">
 104 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
 105 Friends</h2></td></tr>
 106 <tr class="memitem:ad3704c8f87c4499fda0b3888b747869d"><td class="memTemplParams" colspan="2"><a id="ad3704c8f87c4499fda0b3888b747869d"></a>
 107 template&lt;int RS, bool M&gt; </td></tr>
 108 <tr class="memitem:ad3704c8f87c4499fda0b3888b747869d"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><b>bit_range</b></td></tr>
 109 <tr class="separator:ad3704c8f87c4499fda0b3888b747869d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 110 </table>
 111 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 112 <div class="textblock"><h3>template&lt;int RangeSize, bool IsMutable&gt;<br />
 113 class boost::gil::bit_range&lt; RangeSize, IsMutable &gt;</h3>
 114
 115 <p>A model of a heterogeneous pixel that is not byte aligned. Examples are bitmap (1-bit pixels) or 6-bit RGB (222). </p>
 116 </div><hr/>The documentation for this class was generated from the following file:<ul>
 117 <li><a class="el" href="bit__aligned__pixel__reference_8hpp_source.html">bit_aligned_pixel_reference.hpp</a></li>
 118 </ul>
 119 </div><!-- contents -->
 120      <!-- HTML footer for doxygen 1.8.13-->
 121      <!-- start footer part -->
 122      <hr class="footer"/>
 123      <address class="footer">
 124       <small>
 125         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 126       </small>
 127     </address>
 128   </body>
 129 </html>