libs/gil/doc/html/reference/group___pixel_model_planar_ref.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</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><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#nested-classes">Classes</a> &#124;
  44 <a href="#func-members">Functions</a>  </div>
  45   <div class="headertitle">
  46 <div class="title">planar_pixel_reference<div class="ingroups"><a class="el" href="group___pixel.html">Pixel</a> &raquo; <a class="el" href="group___pixel_model.html">Models</a></div></div>  </div>
  47 </div><!--header-->
  48 <div class="contents">
  49
  50 <p>A reference proxy to a planar pixel. 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>.
  51 <a href="#details">More...</a></p>
  52 <table class="memberdecls">
  53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  54 Classes</h2></td></tr>
  55 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html">planar_pixel_reference&lt; ChannelReference, ColorSpace &gt;</a></td></tr>
  56 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A reference proxy to a planar pixel.  <a href="structboost_1_1gil_1_1planar__pixel__reference.html#details">More...</a><br /></td></tr>
  57 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1is__pixel_3_01planar__pixel__reference_3_01_channel_reference_00_01_color_space_01_4_01_4.html">is_pixel&lt; planar_pixel_reference&lt; ChannelReference, ColorSpace &gt; &gt;</a></td></tr>
  59 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structboost_1_1gil_1_1_metafunction.html" title="Concept for type as metafunction requirement.">Metafunction</a> predicate that flags <a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html" title="A reference proxy to a planar pixel.">planar_pixel_reference</a> as a model of <a class="el" href="structboost_1_1gil_1_1_pixel_concept.html" title="Pixel concept - A color base whose elements are channels.">PixelConcept</a>. Required by <a class="el" href="structboost_1_1gil_1_1_pixel_concept.html" title="Pixel concept - A color base whose elements are channels.">PixelConcept</a>.  <a href="structboost_1_1gil_1_1is__pixel_3_01planar__pixel__reference_3_01_channel_reference_00_01_color_space_01_4_01_4.html#details">More...</a><br /></td></tr>
  60 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1color__space__type_3_01planar__pixel__reference_3_01_channel_reference_00_01_color_space_01_4_01_4.html">color_space_type&lt; planar_pixel_reference&lt; ChannelReference, ColorSpace &gt; &gt;</a></td></tr>
  62 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the color space type of a planar pixel reference. Required by <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs.">PixelBasedConcept</a>.  <a href="structboost_1_1gil_1_1color__space__type_3_01planar__pixel__reference_3_01_channel_reference_00_01_color_space_01_4_01_4.html#details">More...</a><br /></td></tr>
  63 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1channel__mapping__type_3_01planar__pixel__reference_3_01_channel_reference_00_01_color_space_01_4_01_4.html">channel_mapping_type&lt; planar_pixel_reference&lt; ChannelReference, ColorSpace &gt; &gt;</a></td></tr>
  65 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the color space type of a planar pixel reference. Required by <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs.">PixelBasedConcept</a>.  <a href="structboost_1_1gil_1_1channel__mapping__type_3_01planar__pixel__reference_3_01_channel_reference_00_01_color_space_01_4_01_4.html#details">More...</a><br /></td></tr>
  66 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1is__planar_3_01planar__pixel__reference_3_01_channel_reference_00_01_color_space_01_4_01_4.html">is_planar&lt; planar_pixel_reference&lt; ChannelReference, ColorSpace &gt; &gt;</a></td></tr>
  68 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies that <a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html" title="A reference proxy to a planar pixel.">planar_pixel_reference</a> represents a planar construct. Required by <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs.">PixelBasedConcept</a>.  <a href="structboost_1_1gil_1_1is__planar_3_01planar__pixel__reference_3_01_channel_reference_00_01_color_space_01_4_01_4.html#details">More...</a><br /></td></tr>
  69 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1channel__type_3_01planar__pixel__reference_3_01_channel_reference_00_01_color_space_01_4_01_4.html">channel_type&lt; planar_pixel_reference&lt; ChannelReference, ColorSpace &gt; &gt;</a></td></tr>
  71 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the color space type of a planar pixel reference. Required by <a class="el" href="structboost_1_1gil_1_1_homogeneous_pixel_based_concept.html" title="Concept for homogeneous pixel-based GIL constructs.">HomogeneousPixelBasedConcept</a>.  <a href="structboost_1_1gil_1_1channel__type_3_01planar__pixel__reference_3_01_channel_reference_00_01_color_space_01_4_01_4.html#details">More...</a><br /></td></tr>
  72 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 </table><table class="memberdecls">
  74 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  75 Functions</h2></td></tr>
  76 <tr class="memitem:gac1855b0fafda74af530813672c6ce65c"><td class="memTemplParams" colspan="2"><a id="gac1855b0fafda74af530813672c6ce65c"></a>
  77 template&lt;typename CR , typename CS , typename R &gt; </td></tr>
  78 <tr class="memitem:gac1855b0fafda74af530813672c6ce65c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___pixel_model_planar_ref.html#gac1855b0fafda74af530813672c6ce65c">swap</a> (const <a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html">boost::gil::planar_pixel_reference</a>&lt; CR, CS &gt; x, R &amp;y)</td></tr>
  79 <tr class="memdesc:gac1855b0fafda74af530813672c6ce65c"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for planar_pixel_reference <br /></td></tr>
  80 <tr class="separator:gac1855b0fafda74af530813672c6ce65c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 <tr class="memitem:ga969f83be8690210f205e16b3a09fd3cc"><td class="memTemplParams" colspan="2"><a id="ga969f83be8690210f205e16b3a09fd3cc"></a>
  82 template&lt;typename CR , typename CS &gt; </td></tr>
  83 <tr class="memitem:ga969f83be8690210f205e16b3a09fd3cc"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___pixel_model_planar_ref.html#ga969f83be8690210f205e16b3a09fd3cc">swap</a> (typename <a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html">boost::gil::planar_pixel_reference</a>&lt; CR, CS &gt;::value_type &amp;x, const <a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html">boost::gil::planar_pixel_reference</a>&lt; CR, CS &gt; y)</td></tr>
  84 <tr class="memdesc:ga969f83be8690210f205e16b3a09fd3cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for planar_pixel_reference <br /></td></tr>
  85 <tr class="separator:ga969f83be8690210f205e16b3a09fd3cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:gac535985999b55dddc716a7fea20ce5e2"><td class="memTemplParams" colspan="2"><a id="gac535985999b55dddc716a7fea20ce5e2"></a>
  87 template&lt;typename CR , typename CS &gt; </td></tr>
  88 <tr class="memitem:gac535985999b55dddc716a7fea20ce5e2"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___pixel_model_planar_ref.html#gac535985999b55dddc716a7fea20ce5e2">swap</a> (const <a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html">boost::gil::planar_pixel_reference</a>&lt; CR, CS &gt; x, const <a class="el" href="structboost_1_1gil_1_1planar__pixel__reference.html">boost::gil::planar_pixel_reference</a>&lt; CR, CS &gt; y)</td></tr>
  89 <tr class="memdesc:gac535985999b55dddc716a7fea20ce5e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for planar_pixel_reference <br /></td></tr>
  90 <tr class="separator:gac535985999b55dddc716a7fea20ce5e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91 </table>
  92 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  93 <p>A reference proxy to a planar pixel. 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>
  94 </div><!-- contents -->
  95      <!-- HTML footer for doxygen 1.8.13-->
  96      <!-- start footer part -->
  97      <hr class="footer"/>
  98      <address class="footer">
  99       <small>
 100         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 101       </small>
 102     </address>
 103   </body>
 104 </html>