libs/gil/doc/html/reference/structboost_1_1gil_1_1planar__pixel__reference.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: planar_pixel_reference&lt; ChannelReference, ColorSpace &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_1planar__pixel__reference.html">planar_pixel_reference</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="#pub-static-attribs">Static Public Attributes</a> &#124;
  50 <a href="structboost_1_1gil_1_1planar__pixel__reference-members.html">List of all members</a>  </div>
  51   <div class="headertitle">
  52 <div class="title">planar_pixel_reference&lt; ChannelReference, ColorSpace &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group___pixel.html">Pixel</a> &raquo; <a class="el" href="group___pixel_model.html">Models</a> &raquo; <a class="el" href="group___pixel_model_planar_ref.html">planar_pixel_reference</a><a class="el" href="group___color_base.html">ColorBase</a> &raquo; <a class="el" href="group___color_base_model.html">Models</a> &raquo;  &#124; <a class="el" href="group___color_base_model_planar_ref.html">planar_pixel_reference</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>A reference proxy to a planar pixel.
  57  <a href="structboost_1_1gil_1_1planar__pixel__reference.html#details">More...</a></p>
  58
  59 <p><code>#include &lt;<a class="el" href="planar__pixel__reference_8hpp_source.html">planar_pixel_reference.hpp</a>&gt;</code></p>
  60
  61 <p>Inherits homogeneous_color_base&lt; Element, Layout, K &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:aa58b25ebd200242c9ac69d6277535a0f"><td class="memItemLeft" align="right" valign="top"><a id="aa58b25ebd200242c9ac69d6277535a0f"></a>
  66 using&#160;</td><td class="memItemRight" valign="bottom"><b>parent_t</b> = detail::homogeneous_color_base&lt; ChannelReference, <a class="el" href="structboost_1_1gil_1_1layout.html">layout</a>&lt; ColorSpace &gt;, mp11::mp_size&lt; ColorSpace &gt;::value &gt;</td></tr>
  67 <tr class="separator:aa58b25ebd200242c9ac69d6277535a0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 <tr class="memitem:a555a9845ae172f4bba280ee40e5bac00"><td class="memItemLeft" align="right" valign="top"><a id="a555a9845ae172f4bba280ee40e5bac00"></a>
  69 using&#160;</td><td class="memItemRight" valign="bottom"><b>value_type</b> = <a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a>&lt; channel_t, <a class="el" href="structboost_1_1gil_1_1layout.html">layout</a>&lt; ColorSpace &gt; &gt;</td></tr>
  70 <tr class="separator:a555a9845ae172f4bba280ee40e5bac00"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 <tr class="memitem:a85cb80ed1553967ad2c639a01f5886dd"><td class="memItemLeft" align="right" valign="top"><a id="a85cb80ed1553967ad2c639a01f5886dd"></a>
  72 using&#160;</td><td class="memItemRight" valign="bottom"><b>reference</b> = <a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html">planar_pixel_reference</a>&lt; ChannelReference, ColorSpace &gt;</td></tr>
  73 <tr class="separator:a85cb80ed1553967ad2c639a01f5886dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74 <tr class="memitem:a7402622b02382ce4ca74caa76db55e47"><td class="memItemLeft" align="right" valign="top"><a id="a7402622b02382ce4ca74caa76db55e47"></a>
  75 using&#160;</td><td class="memItemRight" valign="bottom"><b>const_reference</b> = <a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html">planar_pixel_reference</a>&lt; channel_const_reference, ColorSpace &gt;</td></tr>
  76 <tr class="separator:a7402622b02382ce4ca74caa76db55e47"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 </table><table class="memberdecls">
  78 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  79 Public Member Functions</h2></td></tr>
  80 <tr class="memitem:ab85a6656613145874834ed272fed7f76"><td class="memItemLeft" align="right" valign="top"><a id="ab85a6656613145874834ed272fed7f76"></a>
  81 &#160;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_reference</b> (ChannelReference v0, ChannelReference v1)</td></tr>
  82 <tr class="separator:ab85a6656613145874834ed272fed7f76"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 <tr class="memitem:ac748457647ef60e3058dd9a777a659f3"><td class="memItemLeft" align="right" valign="top"><a id="ac748457647ef60e3058dd9a777a659f3"></a>
  84 &#160;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_reference</b> (ChannelReference v0, ChannelReference v1, ChannelReference v2)</td></tr>
  85 <tr class="separator:ac748457647ef60e3058dd9a777a659f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:a1150133adc3a4f2edc3d3bd9dde477b1"><td class="memItemLeft" align="right" valign="top"><a id="a1150133adc3a4f2edc3d3bd9dde477b1"></a>
  87 &#160;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_reference</b> (ChannelReference v0, ChannelReference v1, ChannelReference v2, ChannelReference v3)</td></tr>
  88 <tr class="separator:a1150133adc3a4f2edc3d3bd9dde477b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 <tr class="memitem:a6074ff79afc3bc5206fa2008ff959886"><td class="memItemLeft" align="right" valign="top"><a id="a6074ff79afc3bc5206fa2008ff959886"></a>
  90 &#160;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_reference</b> (ChannelReference v0, ChannelReference v1, ChannelReference v2, ChannelReference v3, ChannelReference v4)</td></tr>
  91 <tr class="separator:a6074ff79afc3bc5206fa2008ff959886"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:a326177c672b834ebae1f606d092db69d"><td class="memItemLeft" align="right" valign="top"><a id="a326177c672b834ebae1f606d092db69d"></a>
  93 &#160;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_reference</b> (ChannelReference v0, ChannelReference v1, ChannelReference v2, ChannelReference v3, ChannelReference v4, ChannelReference v5)</td></tr>
  94 <tr class="separator:a326177c672b834ebae1f606d092db69d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95 <tr class="memitem:ac7ac169b22308d88e887c184884b7503"><td class="memItemLeft" align="right" valign="top"><a id="ac7ac169b22308d88e887c184884b7503"></a>
  96 &#160;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_reference</b> (<a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html">planar_pixel_reference</a> const &amp;p)</td></tr>
  97 <tr class="separator:ac7ac169b22308d88e887c184884b7503"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98 <tr class="memitem:aba8c88de90b8e2dc7756789f39803eba"><td class="memItemLeft" align="right" valign="top"><a id="aba8c88de90b8e2dc7756789f39803eba"></a>
  99 auto&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html">planar_pixel_reference</a> const &amp;p) const -&gt; <a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html">planar_pixel_reference</a> const &amp;</td></tr>
 100 <tr class="separator:aba8c88de90b8e2dc7756789f39803eba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 101 <tr class="memitem:af3f63ccd3ad9904cc7df630d342f17c5"><td class="memTemplParams" colspan="2"><a id="af3f63ccd3ad9904cc7df630d342f17c5"></a>
 102 template&lt;typename Pixel &gt; </td></tr>
 103 <tr class="memitem:af3f63ccd3ad9904cc7df630d342f17c5"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>planar_pixel_reference</b> (Pixel const &amp;p)</td></tr>
 104 <tr class="separator:af3f63ccd3ad9904cc7df630d342f17c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 105 <tr class="memitem:a6683e7afb9f3d8e1e44a9e95d76fe2fa"><td class="memTemplParams" colspan="2"><a id="a6683e7afb9f3d8e1e44a9e95d76fe2fa"></a>
 106 template&lt;typename Pixel &gt; </td></tr>
 107 <tr class="memitem:a6683e7afb9f3d8e1e44a9e95d76fe2fa"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (Pixel const &amp;p) const -&gt; <a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html">planar_pixel_reference</a> const &amp;</td></tr>
 108 <tr class="separator:a6683e7afb9f3d8e1e44a9e95d76fe2fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 109 <tr class="memitem:a9236ce4ebec269c382f8d9d7681fa0d8"><td class="memTemplParams" colspan="2"><a id="a9236ce4ebec269c382f8d9d7681fa0d8"></a>
 110 template&lt;typename ChannelV , typename Mapping &gt; </td></tr>
 111 <tr class="memitem:a9236ce4ebec269c382f8d9d7681fa0d8"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>planar_pixel_reference</b> (<a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a>&lt; ChannelV, <a class="el" href="structboost_1_1gil_1_1layout.html">layout</a>&lt; ColorSpace, Mapping &gt;&gt; &amp;p)</td></tr>
 112 <tr class="separator:a9236ce4ebec269c382f8d9d7681fa0d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 113 <tr class="memitem:a72ac5f7f127cd6d6bd0c5d38e8647bcd"><td class="memTemplParams" colspan="2"><a id="a72ac5f7f127cd6d6bd0c5d38e8647bcd"></a>
 114 template&lt;typename ChannelPtr &gt; </td></tr>
 115 <tr class="memitem:a72ac5f7f127cd6d6bd0c5d38e8647bcd"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>planar_pixel_reference</b> (<a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a>&lt; ChannelPtr, ColorSpace &gt; const &amp;p, std::ptrdiff_t diff)</td></tr>
 116 <tr class="separator:a72ac5f7f127cd6d6bd0c5d38e8647bcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 117 <tr class="memitem:a2ee168419936700a6db322af16b6fa56"><td class="memTemplParams" colspan="2"><a id="a2ee168419936700a6db322af16b6fa56"></a>
 118 template&lt;typename Pixel &gt; </td></tr>
 119 <tr class="memitem:a2ee168419936700a6db322af16b6fa56"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator==</b> (Pixel const &amp;p) const</td></tr>
 120 <tr class="separator:a2ee168419936700a6db322af16b6fa56"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 <tr class="memitem:a7e84b33a61c27a8ca0d4cfd1d17a3ce7"><td class="memTemplParams" colspan="2"><a id="a7e84b33a61c27a8ca0d4cfd1d17a3ce7"></a>
 122 template&lt;typename Pixel &gt; </td></tr>
 123 <tr class="memitem:a7e84b33a61c27a8ca0d4cfd1d17a3ce7"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator!=</b> (Pixel const &amp;p) const</td></tr>
 124 <tr class="separator:a7e84b33a61c27a8ca0d4cfd1d17a3ce7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 <tr class="memitem:a43fcae62467ed761b142a423a3c8fbf6"><td class="memItemLeft" align="right" valign="top"><a id="a43fcae62467ed761b142a423a3c8fbf6"></a>
 126 auto&#160;</td><td class="memItemRight" valign="bottom"><b>operator[]</b> (std::size_t i) const -&gt; ChannelReference</td></tr>
 127 <tr class="separator:a43fcae62467ed761b142a423a3c8fbf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 128 <tr class="memitem:a3717bd7d088f0e11bb897704be7ee4e4"><td class="memItemLeft" align="right" valign="top"><a id="a3717bd7d088f0e11bb897704be7ee4e4"></a>
 129 auto&#160;</td><td class="memItemRight" valign="bottom"><b>operator-&gt;</b> () const -&gt; <a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html">planar_pixel_reference</a> const *</td></tr>
 130 <tr class="separator:a3717bd7d088f0e11bb897704be7ee4e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 131 </table><table class="memberdecls">
 132 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
 133 Static Public Attributes</h2></td></tr>
 134 <tr class="memitem:ada04709db53ded2c170444a3f1c4e5d4"><td class="memItemLeft" align="right" valign="top"><a id="ada04709db53ded2c170444a3f1c4e5d4"></a>
 135 static constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_mutable</b> = channel_traits&lt;ChannelReference&gt;::is_mutable</td></tr>
 136 <tr class="separator:ada04709db53ded2c170444a3f1c4e5d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 </table>
 138 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 139 <div class="textblock"><h3>template&lt;typename ChannelReference, typename ColorSpace&gt;<br />
 140 struct boost::gil::planar_pixel_reference&lt; ChannelReference, ColorSpace &gt;</h3>
 141
 142 <p>A reference proxy to a planar pixel. </p>
 143 <p>A reference to a planar pixel is a proxy class containing references to each of the corresponding channels. Models: <a class="el" href="structboost_1_1gil_1_1_homogeneous_color_base_concept.html" title="Color base whose elements all have the same type.">HomogeneousColorBaseConcept</a>, <a class="el" href="structboost_1_1gil_1_1_homogeneous_pixel_concept.html" title="Homogeneous pixel concept.">HomogeneousPixelConcept</a></p>
 144 <dl class="tparams"><dt>Template Parameters</dt><dd>
 145   <table class="tparams">
 146     <tr><td class="paramname">ChannelReference</td><td>A channel reference, either const or mutable </td></tr>
 147     <tr><td class="paramname">ColorSpace</td><td></td></tr>
 148   </table>
 149   </dd>
 150 </dl>
 151 </div><hr/>The documentation for this struct was generated from the following files:<ul>
 152 <li><a class="el" href="metafunctions_8hpp_source.html">metafunctions.hpp</a></li>
 153 <li><a class="el" href="planar__pixel__reference_8hpp_source.html">planar_pixel_reference.hpp</a></li>
 154 </ul>
 155 </div><!-- contents -->
 156      <!-- HTML footer for doxygen 1.8.13-->
 157      <!-- start footer part -->
 158      <hr class="footer"/>
 159      <address class="footer">
 160       <small>
 161         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 162       </small>
 163     </address>
 164   </body>
 165 </html>