libs/gil/doc/html/reference/structboost_1_1gil_1_1bit__aligned__pixel__iterator.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_aligned_pixel_iterator&lt; NonAlignedPixelReference &gt; Struct 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="structboost_1_1gil_1_1bit__aligned__pixel__iterator.html">bit_aligned_pixel_iterator</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="structboost_1_1gil_1_1bit__aligned__pixel__iterator-members.html">List of all members</a>  </div>
  51   <div class="headertitle">
  52 <div class="title">bit_aligned_pixel_iterator&lt; NonAlignedPixelReference &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group___pixel_iterator.html">Pixel Iterator</a> &raquo; <a class="el" href="group___pixel_iterator_model.html">Models</a> &raquo; <a class="el" href="group___pixel_iterator_non_aligned_pixel_iterator.html">bit_aligned_pixel_iterator</a><a class="el" href="group___pixel_based.html">PixelBased</a> &raquo;  &#124; <a class="el" href="group___pixel_based_model.html">Models</a></div></div>  </div>
  53 </div><!--header-->
  54 <div class="contents">
  55
  56 <p>An iterator over non-byte-aligned pixels. Models <a class="el" href="structboost_1_1gil_1_1_pixel_iterator_concept.html" title="An STL random access traversal iterator over a model of PixelConcept.">PixelIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs.">PixelBasedConcept</a>, <a class="el" href="structboost_1_1gil_1_1_memory_based_iterator_concept.html" title="Concept of a random-access iterator that can be advanced in memory units (bytes or bits)">MemoryBasedIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_has_dynamic_x_step_type_concept.html" title="Concept for iterators, locators and views that can define a type just like the given iterator,...">HasDynamicXStepTypeConcept</a>.
  57  <a href="structboost_1_1gil_1_1bit__aligned__pixel__iterator.html#details">More...</a></p>
  58
  59 <p><code>#include &lt;<a class="el" href="bit__aligned__pixel__iterator_8hpp_source.html">bit_aligned_pixel_iterator.hpp</a>&gt;</code></p>
  60
  61 <p>Inherits iterator_facade&lt; bit_aligned_pixel_iterator&lt; NonAlignedPixelReference &gt;, NonAlignedPixelReference::value_type, std::random_access_iterator_tag, const NonAlignedPixelReference, NonAlignedPixelReference::bit_range_t::difference_type &gt;.</p>
  62 <table class="memberdecls">
  63 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  64 Public Types</h2></td></tr>
  65 <tr class="memitem:a2ae9f9bc144b7bd7d8523c345ac34a58"><td class="memItemLeft" align="right" valign="top"><a id="a2ae9f9bc144b7bd7d8523c345ac34a58"></a>
  66 using&#160;</td><td class="memItemRight" valign="bottom"><b>difference_type</b> = typename parent_t::difference_type</td></tr>
  67 <tr class="separator:a2ae9f9bc144b7bd7d8523c345ac34a58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 <tr class="memitem:afd3670b743c9f80b9c2f6b3ccb5fe37c"><td class="memItemLeft" align="right" valign="top"><a id="afd3670b743c9f80b9c2f6b3ccb5fe37c"></a>
  69 using&#160;</td><td class="memItemRight" valign="bottom"><b>reference</b> = typename parent_t::reference</td></tr>
  70 <tr class="separator:afd3670b743c9f80b9c2f6b3ccb5fe37c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 </table><table class="memberdecls">
  72 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  73 Public Member Functions</h2></td></tr>
  74 <tr class="memitem:a97cc267cffad3d7413aa13c11d9172bb"><td class="memItemLeft" align="right" valign="top"><a id="a97cc267cffad3d7413aa13c11d9172bb"></a>
  75 &#160;</td><td class="memItemRight" valign="bottom"><b>bit_aligned_pixel_iterator</b> (const <a class="el" href="structboost_1_1gil_1_1bit__aligned__pixel__iterator.html">bit_aligned_pixel_iterator</a> &amp;p)</td></tr>
  76 <tr class="separator:a97cc267cffad3d7413aa13c11d9172bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 <tr class="memitem:a31fe24d00d718ba4c265224c2f058eff"><td class="memItemLeft" align="right" valign="top"><a id="a31fe24d00d718ba4c265224c2f058eff"></a>
  78 <a class="el" href="structboost_1_1gil_1_1bit__aligned__pixel__iterator.html">bit_aligned_pixel_iterator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="structboost_1_1gil_1_1bit__aligned__pixel__iterator.html">bit_aligned_pixel_iterator</a> &amp;p)</td></tr>
  79 <tr class="separator:a31fe24d00d718ba4c265224c2f058eff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:adac3bbd46d480a19f792bebc5fda3290"><td class="memTemplParams" colspan="2"><a id="adac3bbd46d480a19f792bebc5fda3290"></a>
  81 template&lt;typename Ref &gt; </td></tr>
  82 <tr class="memitem:adac3bbd46d480a19f792bebc5fda3290"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>bit_aligned_pixel_iterator</b> (const <a class="el" href="structboost_1_1gil_1_1bit__aligned__pixel__iterator.html">bit_aligned_pixel_iterator</a>&lt; Ref &gt; &amp;p)</td></tr>
  83 <tr class="separator:adac3bbd46d480a19f792bebc5fda3290"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:a26e6dc7fc834136b6a8955287f65f685"><td class="memItemLeft" align="right" valign="top"><a id="a26e6dc7fc834136b6a8955287f65f685"></a>
  85 &#160;</td><td class="memItemRight" valign="bottom"><b>bit_aligned_pixel_iterator</b> (reference *ref)</td></tr>
  86 <tr class="separator:a26e6dc7fc834136b6a8955287f65f685"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87 <tr class="memitem:abd45ffa88b7303eec204718824892cee"><td class="memItemLeft" align="right" valign="top"><a id="abd45ffa88b7303eec204718824892cee"></a>
  88 &#160;</td><td class="memItemRight" valign="bottom"><b>bit_aligned_pixel_iterator</b> (typename bit_range_t::byte_t *data, int bit_offset=0)</td></tr>
  89 <tr class="separator:abd45ffa88b7303eec204718824892cee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 <tr class="memitem:a16d8e6857dd561244ca73764f2b94801"><td class="memItemLeft" align="right" valign="top">reference&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1bit__aligned__pixel__iterator.html#a16d8e6857dd561244ca73764f2b94801">operator[]</a> (difference_type d) const</td></tr>
  91 <tr class="separator:a16d8e6857dd561244ca73764f2b94801"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:a805e05f32890139f6f2665c7ec37bf6e"><td class="memItemLeft" align="right" valign="top"><a id="a805e05f32890139f6f2665c7ec37bf6e"></a>
  93 reference&#160;</td><td class="memItemRight" valign="bottom"><b>operator-&gt;</b> () const</td></tr>
  94 <tr class="separator:a805e05f32890139f6f2665c7ec37bf6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95 <tr class="memitem:a5234c1a5a75ea437a63b9680f13745b5"><td class="memItemLeft" align="right" valign="top"><a id="a5234c1a5a75ea437a63b9680f13745b5"></a>
  96 const bit_range_t &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>bit_range</b> () const</td></tr>
  97 <tr class="separator:a5234c1a5a75ea437a63b9680f13745b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98 <tr class="memitem:ab9aa87c78490cd8bc74b338c81490730"><td class="memItemLeft" align="right" valign="top"><a id="ab9aa87c78490cd8bc74b338c81490730"></a>
  99 bit_range_t &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>bit_range</b> ()</td></tr>
 100 <tr class="separator:ab9aa87c78490cd8bc74b338c81490730"><td class="memSeparator" colspan="2">&#160;</td></tr>
 101 </table><table class="memberdecls">
 102 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
 103 Friends</h2></td></tr>
 104 <tr class="memitem:a643c7b0be807b6ab9b506359b8cfa21d"><td class="memTemplParams" colspan="2"><a id="a643c7b0be807b6ab9b506359b8cfa21d"></a>
 105 template&lt;typename Ref &gt; </td></tr>
 106 <tr class="memitem:a643c7b0be807b6ab9b506359b8cfa21d"><td class="memTemplItemLeft" align="right" valign="top">struct&#160;</td><td class="memTemplItemRight" valign="bottom"><b>bit_aligned_pixel_iterator</b></td></tr>
 107 <tr class="separator:a643c7b0be807b6ab9b506359b8cfa21d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 108 <tr class="memitem:ac09f73e325921cc50ebcd96bed0f8096"><td class="memItemLeft" align="right" valign="top"><a id="ac09f73e325921cc50ebcd96bed0f8096"></a>
 109 class&#160;</td><td class="memItemRight" valign="bottom"><b>boost::iterator_core_access</b></td></tr>
 110 <tr class="separator:ac09f73e325921cc50ebcd96bed0f8096"><td class="memSeparator" colspan="2">&#160;</td></tr>
 111 </table>
 112 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 113 <div class="textblock"><h3>template&lt;typename NonAlignedPixelReference&gt;<br />
 114 struct boost::gil::bit_aligned_pixel_iterator&lt; NonAlignedPixelReference &gt;</h3>
 115
 116 <p>An iterator over non-byte-aligned pixels. Models <a class="el" href="structboost_1_1gil_1_1_pixel_iterator_concept.html" title="An STL random access traversal iterator over a model of PixelConcept.">PixelIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs.">PixelBasedConcept</a>, <a class="el" href="structboost_1_1gil_1_1_memory_based_iterator_concept.html" title="Concept of a random-access iterator that can be advanced in memory units (bytes or bits)">MemoryBasedIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_has_dynamic_x_step_type_concept.html" title="Concept for iterators, locators and views that can define a type just like the given iterator,...">HasDynamicXStepTypeConcept</a>. </p>
 117 <p>An iterator over pixels that correspond to non-byte-aligned bit ranges. Examples of such pixels are single bit grayscale pixel, or a 6-bit RGB 222 pixel. </p>
 118 </div><h2 class="groupheader">Member Function Documentation</h2>
 119 <a id="a16d8e6857dd561244ca73764f2b94801"></a>
 120 <h2 class="memtitle"><span class="permalink"><a href="#a16d8e6857dd561244ca73764f2b94801">&#9670;&nbsp;</a></span>operator[]()</h2>
 121
 122 <div class="memitem">
 123 <div class="memproto">
 124 <table class="mlabels">
 125   <tr>
 126   <td class="mlabels-left">
 127       <table class="memname">
 128         <tr>
 129           <td class="memname">reference operator[] </td>
 130           <td>(</td>
 131           <td class="paramtype">difference_type&#160;</td>
 132           <td class="paramname"><em>d</em></td><td>)</td>
 133           <td> const</td>
 134         </tr>
 135       </table>
 136   </td>
 137   <td class="mlabels-right">
 138 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 139   </tr>
 140 </table>
 141 </div><div class="memdoc">
 142 <p>For some reason operator[] provided by iterator_adaptor returns a custom class that is convertible to reference We require our own reference because it is registered in iterator_traits </p>
 143
 144 </div>
 145 </div>
 146 <hr/>The documentation for this struct was generated from the following file:<ul>
 147 <li><a class="el" href="bit__aligned__pixel__iterator_8hpp_source.html">bit_aligned_pixel_iterator.hpp</a></li>
 148 </ul>
 149 </div><!-- contents -->
 150      <!-- HTML footer for doxygen 1.8.13-->
 151      <!-- start footer part -->
 152      <hr class="footer"/>
 153      <address class="footer">
 154       <small>
 155         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 156       </small>
 157     </address>
 158   </body>
 159 </html>