mirror of
https://github.com/boostorg/gil.git
synced 2026-01-24 05:52:13 +00:00
183 lines
22 KiB
HTML
183 lines
22 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.6"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Generic Image Library: pixel_iterator.hpp Source File</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.6 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1878a3f4746a95c6aad317458cc7ef80.html">boost</a></li><li class="navelem"><a class="el" href="dir_df4750f408086f9b9c1b5ee4251365ff.html">gil</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">pixel_iterator.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright 2005-2007 Adobe Systems Incorporated</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Distributed under the Boost Software License, Version 1.0</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// See accompanying file LICENSE_1_0.txt or copy at</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// http://www.boost.org/LICENSE_1_0.txt</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#ifndef BOOST_GIL_PIXEL_ITERATOR_HPP</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor"></span><span class="preprocessor">#define BOOST_GIL_PIXEL_ITERATOR_HPP</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <boost/gil/concepts.hpp></span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <boost/gil/utilities.hpp></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <boost/gil/pixel.hpp></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <iterator></span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>gil {</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">//forwarded declaration (as this file is included in step_iterator.hpp)</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Iterator></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">class </span>memory_based_step_iterator;</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Iterator> <span class="keyword">struct </span>dynamic_x_step_type;</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">template</span> <<span class="keyword">typename</span> It></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">struct </span>is_iterator_adaptor : <span class="keyword">public</span> mpl::false_{};</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">template</span> <<span class="keyword">typename</span> It></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">struct </span>iterator_adaptor_get_base;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">template</span> <<span class="keyword">typename</span> It, <span class="keyword">typename</span> NewBaseIt></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1iterator__adaptor__rebind.html"> 36</a></span> <span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1iterator__adaptor__rebind.html">iterator_adaptor_rebind</a>;</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">template</span> <<span class="keyword">typename</span> It></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1const__iterator__type.html"> 40</a></span> <span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1const__iterator__type.html">const_iterator_type</a>;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// The default implementation when the iterator is a C pointer is to use the standard constness semantics</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T> <span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1const__iterator__type.html">const_iterator_type</a><T*> { <span class="keyword">using</span> type = T <span class="keyword">const</span>*; };</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T> <span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1const__iterator__type.html">const_iterator_type</a><T const*> { <span class="keyword">using</span> type = T <span class="keyword">const</span>*; };</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">template</span> <<span class="keyword">typename</span> It></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1iterator__is__mutable.html"> 49</a></span> <span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1iterator__is__mutable.html">iterator_is_mutable</a>{};</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// The default implementation when the iterator is a C pointer is to use the standard constness semantics</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T> <span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1iterator__is__mutable.html">iterator_is_mutable</a>< T*> : <span class="keyword">public</span> mpl::true_{};</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T> <span class="keyword">struct </span>iterator_is_mutable<const T*> : <span class="keyword">public</span> mpl::false_{};</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">// HasDynamicXStepTypeConcept</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Pixel></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">struct </span>dynamic_x_step_type<Pixel*> {</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">using</span> type = memory_based_step_iterator<Pixel *>;</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> };</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Pixel></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">struct </span>dynamic_x_step_type<const Pixel*> {</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">using</span> type = memory_based_step_iterator<const Pixel *>;</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> };</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">// PixelBasedConcept</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Pixel> <span class="keyword">struct </span>color_space_type< Pixel*> : <span class="keyword">public</span> color_space_type<Pixel> {};</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Pixel> <span class="keyword">struct </span>color_space_type<const Pixel*> : <span class="keyword">public</span> color_space_type<Pixel> {};</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Pixel> <span class="keyword">struct </span>channel_mapping_type< Pixel*> : <span class="keyword">public</span> channel_mapping_type<Pixel> {};</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Pixel> <span class="keyword">struct </span>channel_mapping_type<const Pixel*> : <span class="keyword">public</span> channel_mapping_type<Pixel> {};</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Pixel> <span class="keyword">struct </span>is_planar< Pixel*> : <span class="keyword">public</span> is_planar<Pixel> {};</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Pixel> <span class="keyword">struct </span>is_planar<const Pixel*> : <span class="keyword">public</span> is_planar<Pixel> {};</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">// HomogeneousPixelBasedConcept</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Pixel> <span class="keyword">struct </span>channel_type<Pixel*> : <span class="keyword">public</span> channel_type<Pixel> {};</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Pixel> <span class="keyword">struct </span>channel_type<const Pixel*> : <span class="keyword">public</span> channel_type<Pixel> {};</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">// MemoryBasedIteratorConcept</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1byte__to__memunit.html"> 111</a></span> <span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1byte__to__memunit.html">byte_to_memunit</a> : <span class="keyword">public</span> mpl::int_<1> {};</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keyword">template</span> <<span class="keyword">typename</span> P></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">inline</span> std::ptrdiff_t memunit_step(<span class="keyword">const</span> P*) { <span class="keywordflow">return</span> <span class="keyword">sizeof</span>(P); }</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keyword">template</span> <<span class="keyword">typename</span> P></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">inline</span> std::ptrdiff_t memunit_distance(<span class="keyword">const</span> P* p1, <span class="keyword">const</span> P* p2) {</div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordflow">return</span> (gil_reinterpret_cast_c<const unsigned char*>(p2)-gil_reinterpret_cast_c<const unsigned char*>(p1));</div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> }</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="keyword">template</span> <<span class="keyword">typename</span> P></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> memunit_advance(P* &p, std::ptrdiff_t diff) {</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  p=(P*)((<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>*)(p)+diff);</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> }</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="keyword">template</span> <<span class="keyword">typename</span> P></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="keyword">inline</span> P* memunit_advanced(<span class="keyword">const</span> P* p, std::ptrdiff_t diff) {</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordflow">return</span> (P*)((<span class="keywordtype">char</span>*)(p)+diff);</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> }</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">// memunit_advanced_ref</span></div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">// (shortcut to advancing a pointer by a given number of memunits and taking the reference in case the compiler is not smart enough)</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keyword">template</span> <<span class="keyword">typename</span> P></div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="keyword">inline</span> P& memunit_advanced_ref(P* p, std::ptrdiff_t diff) {</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordflow">return</span> *memunit_advanced(p,diff);</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> }</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> } } <span class="comment">// namespace boost::gil</span></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="structboost_1_1gil_1_1byte__to__memunit_html"><div class="ttname"><a href="structboost_1_1gil_1_1byte__to__memunit.html">boost::gil::byte_to_memunit</a></div><div class="ttdef"><b>Definition:</b> pixel_iterator.hpp:111</div></div>
|
|
<div class="ttc" id="structboost_1_1gil_1_1iterator__adaptor__rebind_html"><div class="ttname"><a href="structboost_1_1gil_1_1iterator__adaptor__rebind.html">boost::gil::iterator_adaptor_rebind</a></div><div class="ttdoc">Changes the base iterator of an iterator adaptor. Provide an specialization when introducing new iter...</div><div class="ttdef"><b>Definition:</b> pixel_iterator.hpp:36</div></div>
|
|
<div class="ttc" id="structboost_1_1gil_1_1iterator__is__mutable_html"><div class="ttname"><a href="structboost_1_1gil_1_1iterator__is__mutable.html">boost::gil::iterator_is_mutable</a></div><div class="ttdoc">Metafunction predicate returning whether the given iterator allows for changing its values...</div><div class="ttdef"><b>Definition:</b> pixel_iterator.hpp:49</div></div>
|
|
<div class="ttc" id="structboost_1_1gil_1_1const__iterator__type_html"><div class="ttname"><a href="structboost_1_1gil_1_1const__iterator__type.html">boost::gil::const_iterator_type</a></div><div class="ttdoc">Returns the type of an iterator just like the input iterator, except operating over immutable values...</div><div class="ttdef"><b>Definition:</b> pixel_iterator.hpp:40</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.13-->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/>
|
|
<address class="footer">
|
|
<small>
|
|
Generated on Tue Jan 15 2019 09:36:38 for Generic Image Library by  <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.6
|
|
</small>
|
|
</address>
|
|
</body>
|
|
</html>
|