libs/gil/doc/html/reference/structboost_1_1gil_1_1detail_1_1kth__channel__deref__fn.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: kth_channel_deref_fn&lt; K, SrcP &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"><b>detail</b></li><li class="navelem"><a class="el" href="structboost_1_1gil_1_1detail_1_1kth__channel__deref__fn.html">kth_channel_deref_fn</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_1detail_1_1kth__channel__deref__fn-members.html">List of all members</a>  </div>
  51   <div class="headertitle">
  52 <div class="title">kth_channel_deref_fn&lt; K, SrcP &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group___pixel_dereference_adaptor.html">Pixel Dereference Adaptor</a> &raquo; <a class="el" href="group___pixel_dereference_adaptor_model.html">Models</a></div></div>  </div>
  53 </div><!--header-->
  54 <div class="contents">
  55
  56 <p>Function object that returns a grayscale reference of the K-th channel (specified as a template parameter) of a given reference. Models: <a class="el" href="structboost_1_1gil_1_1_pixel_dereference_adaptor_concept.html" title="Represents a unary function object that can be invoked upon dereferencing a pixel iterator.">PixelDereferenceAdaptorConcept</a>.If the input is a pixel value or constant reference, the function object is immutable. Otherwise it is mutable (and returns non-const reference to the k-th channel)
  57  <a href="structboost_1_1gil_1_1detail_1_1kth__channel__deref__fn.html#details">More...</a></p>
  58
  59 <p><code>#include &lt;<a class="el" href="image__view__factory_8hpp_source.html">image_view_factory.hpp</a>&gt;</code></p>
  60 <table class="memberdecls">
  61 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  62 Public Types</h2></td></tr>
  63 <tr class="memitem:af21131141b1bfa3e3fa13e76ff809a33"><td class="memItemLeft" align="right" valign="top"><a id="af21131141b1bfa3e3fa13e76ff809a33"></a>
  64 using&#160;</td><td class="memItemRight" valign="bottom"><b>const_t</b> = <a class="el" href="structboost_1_1gil_1_1detail_1_1kth__channel__deref__fn.html">kth_channel_deref_fn</a>&lt; K, const_ref_t &gt;</td></tr>
  65 <tr class="separator:af21131141b1bfa3e3fa13e76ff809a33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 <tr class="memitem:af13bb156678a77ca4776c2c8711a8e42"><td class="memItemLeft" align="right" valign="top"><a id="af13bb156678a77ca4776c2c8711a8e42"></a>
  67 using&#160;</td><td class="memItemRight" valign="bottom"><b>value_type</b> = typename <a class="el" href="structboost_1_1gil_1_1pixel__value__type.html">pixel_value_type</a>&lt; channel_t, <a class="el" href="structboost_1_1gil_1_1layout.html">gray_layout_t</a> &gt;::type</td></tr>
  68 <tr class="separator:af13bb156678a77ca4776c2c8711a8e42"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:a33e39d505543dbfd49f764d84e3a016c"><td class="memItemLeft" align="right" valign="top"><a id="a33e39d505543dbfd49f764d84e3a016c"></a>
  70 using&#160;</td><td class="memItemRight" valign="bottom"><b>const_reference</b> = typename <a class="el" href="structboost_1_1gil_1_1pixel__reference__type.html">pixel_reference_type</a>&lt; channel_t, <a class="el" href="structboost_1_1gil_1_1layout.html">gray_layout_t</a>, false, false &gt;::type</td></tr>
  71 <tr class="separator:a33e39d505543dbfd49f764d84e3a016c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <tr class="memitem:a14a98eaf38a5a767e5262a3f3786c551"><td class="memItemLeft" align="right" valign="top"><a id="a14a98eaf38a5a767e5262a3f3786c551"></a>
  73 using&#160;</td><td class="memItemRight" valign="bottom"><b>argument_type</b> = SrcP</td></tr>
  74 <tr class="separator:a14a98eaf38a5a767e5262a3f3786c551"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:a1692d53ee117c16b067e18eca746be2f"><td class="memItemLeft" align="right" valign="top"><a id="a1692d53ee117c16b067e18eca746be2f"></a>
  76 using&#160;</td><td class="memItemRight" valign="bottom"><b>reference</b> = mp11::mp_if_c&lt; is_mutable, ref_t, value_type &gt;</td></tr>
  77 <tr class="separator:a1692d53ee117c16b067e18eca746be2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 <tr class="memitem:a1cef15c2b7d2b47815a814dd269ffc4f"><td class="memItemLeft" align="right" valign="top"><a id="a1cef15c2b7d2b47815a814dd269ffc4f"></a>
  79 using&#160;</td><td class="memItemRight" valign="bottom"><b>result_type</b> = reference</td></tr>
  80 <tr class="separator:a1cef15c2b7d2b47815a814dd269ffc4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 </table><table class="memberdecls">
  82 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  83 Public Member Functions</h2></td></tr>
  84 <tr class="memitem:a906f2ce69782c4c5c9791c58c5f20e04"><td class="memTemplParams" colspan="2"><a id="a906f2ce69782c4c5c9791c58c5f20e04"></a>
  85 template&lt;typename P &gt; </td></tr>
  86 <tr class="memitem:a906f2ce69782c4c5c9791c58c5f20e04"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>kth_channel_deref_fn</b> (const <a class="el" href="structboost_1_1gil_1_1detail_1_1kth__channel__deref__fn.html">kth_channel_deref_fn</a>&lt; K, P &gt; &amp;)</td></tr>
  87 <tr class="separator:a906f2ce69782c4c5c9791c58c5f20e04"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:a9aebd82eca95512d88cbefa0525939b6"><td class="memItemLeft" align="right" valign="top"><a id="a9aebd82eca95512d88cbefa0525939b6"></a>
  89 result_type&#160;</td><td class="memItemRight" valign="bottom"><b>operator()</b> (argument_type srcP) const</td></tr>
  90 <tr class="separator:a9aebd82eca95512d88cbefa0525939b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91 </table><table class="memberdecls">
  92 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
  93 Static Public Attributes</h2></td></tr>
  94 <tr class="memitem:ada04709db53ded2c170444a3f1c4e5d4"><td class="memItemLeft" align="right" valign="top">static constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_mutable</b></td></tr>
  95 <tr class="separator:ada04709db53ded2c170444a3f1c4e5d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 </table>
  97 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  98 <div class="textblock"><h3>template&lt;int K, typename SrcP&gt;<br />
  99 struct boost::gil::detail::kth_channel_deref_fn&lt; K, SrcP &gt;</h3>
 100
 101 <p>Function object that returns a grayscale reference of the K-th channel (specified as a template parameter) of a given reference. Models: <a class="el" href="structboost_1_1gil_1_1_pixel_dereference_adaptor_concept.html" title="Represents a unary function object that can be invoked upon dereferencing a pixel iterator.">PixelDereferenceAdaptorConcept</a>.</p>
 102 <p>If the input is a pixel value or constant reference, the function object is immutable. Otherwise it is mutable (and returns non-const reference to the k-th channel) </p>
 103 <dl class="tparams"><dt>Template Parameters</dt><dd>
 104   <table class="tparams">
 105     <tr><td class="paramname">SrcP</td><td>reference to <a class="el" href="structboost_1_1gil_1_1_pixel_concept.html" title="Pixel concept - A color base whose elements are channels.">PixelConcept</a> (could be pixel value or const/non-const reference) Examples: pixel&lt;T,L&gt;, pixel&lt;T,L&gt;&amp;, const pixel&lt;T,L&gt;&amp;, planar_pixel_reference&lt;T&amp;,L&gt;, planar_pixel_reference&lt;const T&amp;,L&gt; </td></tr>
 106   </table>
 107   </dd>
 108 </dl>
 109 </div><h2 class="groupheader">Member Data Documentation</h2>
 110 <a id="ada04709db53ded2c170444a3f1c4e5d4"></a>
 111 <h2 class="memtitle"><span class="permalink"><a href="#ada04709db53ded2c170444a3f1c4e5d4">&#9670;&nbsp;</a></span>is_mutable</h2>
 112
 113 <div class="memitem">
 114 <div class="memproto">
 115 <table class="mlabels">
 116   <tr>
 117   <td class="mlabels-left">
 118       <table class="memname">
 119         <tr>
 120           <td class="memname">constexpr bool is_mutable</td>
 121         </tr>
 122       </table>
 123   </td>
 124   <td class="mlabels-right">
 125 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 126   </tr>
 127 </table>
 128 </div><div class="memdoc">
 129 <b>Initial value:</b><div class="fragment"><div class="line">=</div><div class="line">            pixel_is_reference&lt;SrcP&gt;::value &amp;&amp; pixel_reference_is_mutable&lt;SrcP&gt;::value</div></div><!-- fragment -->
 130 </div>
 131 </div>
 132 <hr/>The documentation for this struct was generated from the following file:<ul>
 133 <li><a class="el" href="image__view__factory_8hpp_source.html">image_view_factory.hpp</a></li>
 134 </ul>
 135 </div><!-- contents -->
 136      <!-- HTML footer for doxygen 1.8.13-->
 137      <!-- start footer part -->
 138      <hr class="footer"/>
 139      <address class="footer">
 140       <small>
 141         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 142       </small>
 143     </address>
 144   </body>
 145 </html>