structboost_1_1gil_1_1packed__pixel.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  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: packed_pixel&lt; BitField, ChannelRefs, Layout &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_1packed__pixel.html">packed_pixel</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-attribs">Public Attributes</a> &#124;
  50. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  51. <a href="structboost_1_1gil_1_1packed__pixel-members.html">List of all members</a> </div>
  52. <div class="headertitle">
  53. <div class="title">packed_pixel&lt; BitField, ChannelRefs, Layout &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group___color_base.html">ColorBase</a> &raquo; <a class="el" href="group___color_base_model.html">Models</a> &raquo; <a class="el" href="group___color_base_model_packed_pixel.html">packed_pixel</a><a class="el" href="group___pixel.html">Pixel</a> &raquo; <a class="el" href="group___pixel_model.html">Models</a> &raquo; &#124; <a class="el" href="group___pixel_model_packed_pixel.html">packed_pixel</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>
  54. </div><!--header-->
  55. <div class="contents">
  56. <p>Heterogeneous pixel value whose channel references can be constructed from the pixel bitfield and their index. Models <a class="el" href="structboost_1_1gil_1_1_color_base_value_concept.html" title="Color base that also has a default-constructor. Refines Regular.">ColorBaseValueConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_value_concept.html" title="Pixel concept that is a Regular type.">PixelValueConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs.">PixelBasedConcept</a> Typical use for this is a model of a packed pixel (like 565 RGB)
  57. <a href="structboost_1_1gil_1_1packed__pixel.html#details">More...</a></p>
  58. <p><code>#include &lt;<a class="el" href="packed__pixel_8hpp_source.html">packed_pixel.hpp</a>&gt;</code></p>
  59. <table class="memberdecls">
  60. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  61. Public Types</h2></td></tr>
  62. <tr class="memitem:a6cfd5e763db68846a46fb3b68190cc4b"><td class="memItemLeft" align="right" valign="top"><a id="a6cfd5e763db68846a46fb3b68190cc4b"></a>
  63. using&#160;</td><td class="memItemRight" valign="bottom"><b>layout_t</b> = Layout</td></tr>
  64. <tr class="separator:a6cfd5e763db68846a46fb3b68190cc4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a9caab176c3c73465d23e583c98bc6633"><td class="memItemLeft" align="right" valign="top"><a id="a9caab176c3c73465d23e583c98bc6633"></a>
  66. using&#160;</td><td class="memItemRight" valign="bottom"><b>value_type</b> = <a class="el" href="structboost_1_1gil_1_1packed__pixel.html">packed_pixel</a>&lt; BitField, ChannelRefs, Layout &gt;</td></tr>
  67. <tr class="separator:a9caab176c3c73465d23e583c98bc6633"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a74202cdd96628bc49a756e5fc87d22de"><td class="memItemLeft" align="right" valign="top"><a id="a74202cdd96628bc49a756e5fc87d22de"></a>
  69. using&#160;</td><td class="memItemRight" valign="bottom"><b>reference</b> = <a class="el" href="structboost_1_1gil_1_1packed__pixel.html">value_type</a> &amp;</td></tr>
  70. <tr class="separator:a74202cdd96628bc49a756e5fc87d22de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a4780295ff953151e0121aebfbcade4da"><td class="memItemLeft" align="right" valign="top"><a id="a4780295ff953151e0121aebfbcade4da"></a>
  72. using&#160;</td><td class="memItemRight" valign="bottom"><b>const_reference</b> = <a class="el" href="structboost_1_1gil_1_1packed__pixel.html">value_type</a> const &amp;</td></tr>
  73. <tr class="separator:a4780295ff953151e0121aebfbcade4da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. </table><table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  76. Public Member Functions</h2></td></tr>
  77. <tr class="memitem:a7a0f92a9c16bae51843b51bc403d4f66"><td class="memItemLeft" align="right" valign="top"><a id="a7a0f92a9c16bae51843b51bc403d4f66"></a>
  78. &#160;</td><td class="memItemRight" valign="bottom"><b>packed_pixel</b> (const BitField &amp;bitfield)</td></tr>
  79. <tr class="separator:a7a0f92a9c16bae51843b51bc403d4f66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:aff484214ed1cf602c6ff2ecdf61f6286"><td class="memItemLeft" align="right" valign="top"><a id="aff484214ed1cf602c6ff2ecdf61f6286"></a>
  81. &#160;</td><td class="memItemRight" valign="bottom"><b>packed_pixel</b> (const <a class="el" href="structboost_1_1gil_1_1packed__pixel.html">packed_pixel</a> &amp;p)</td></tr>
  82. <tr class="separator:aff484214ed1cf602c6ff2ecdf61f6286"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a809da6068eff496b1a058bcd91cb7d45"><td class="memTemplParams" colspan="2"><a id="a809da6068eff496b1a058bcd91cb7d45"></a>
  84. template&lt;typename Pixel &gt; </td></tr>
  85. <tr class="memitem:a809da6068eff496b1a058bcd91cb7d45"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>packed_pixel</b> (Pixel const &amp;p, typename std::enable_if&lt; is_pixel&lt; Pixel &gt;::value &gt;::type *=nullptr)</td></tr>
  86. <tr class="separator:a809da6068eff496b1a058bcd91cb7d45"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a1b0c095207a249eee45ef6395e797c07"><td class="memItemLeft" align="right" valign="top"><a id="a1b0c095207a249eee45ef6395e797c07"></a>
  88. &#160;</td><td class="memItemRight" valign="bottom"><b>packed_pixel</b> (int chan0, int chan1)</td></tr>
  89. <tr class="separator:a1b0c095207a249eee45ef6395e797c07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a3abae6acc5d7a9390f90ce0ac4a921b2"><td class="memItemLeft" align="right" valign="top"><a id="a3abae6acc5d7a9390f90ce0ac4a921b2"></a>
  91. &#160;</td><td class="memItemRight" valign="bottom"><b>packed_pixel</b> (int chan0, int chan1, int chan2)</td></tr>
  92. <tr class="separator:a3abae6acc5d7a9390f90ce0ac4a921b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a58d1ee448cc3b98979fd9951a669c55d"><td class="memItemLeft" align="right" valign="top"><a id="a58d1ee448cc3b98979fd9951a669c55d"></a>
  94. &#160;</td><td class="memItemRight" valign="bottom"><b>packed_pixel</b> (int chan0, int chan1, int chan2, int chan3)</td></tr>
  95. <tr class="separator:a58d1ee448cc3b98979fd9951a669c55d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a815777d11cb8b7c4277b99660bd3a755"><td class="memItemLeft" align="right" valign="top"><a id="a815777d11cb8b7c4277b99660bd3a755"></a>
  97. &#160;</td><td class="memItemRight" valign="bottom"><b>packed_pixel</b> (int chan0, int chan1, int chan2, int chan3, int chan4)</td></tr>
  98. <tr class="separator:a815777d11cb8b7c4277b99660bd3a755"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ac39c4a6bacaea27fb7686e755998e647"><td class="memItemLeft" align="right" valign="top"><a id="ac39c4a6bacaea27fb7686e755998e647"></a>
  100. auto&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="structboost_1_1gil_1_1packed__pixel.html">packed_pixel</a> const &amp;p) -&gt; <a class="el" href="structboost_1_1gil_1_1packed__pixel.html">packed_pixel</a> &amp;</td></tr>
  101. <tr class="separator:ac39c4a6bacaea27fb7686e755998e647"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a553893831e1583d86f28eb5596402385"><td class="memTemplParams" colspan="2"><a id="a553893831e1583d86f28eb5596402385"></a>
  103. template&lt;typename Pixel &gt; </td></tr>
  104. <tr class="memitem:a553893831e1583d86f28eb5596402385"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (Pixel const &amp;p) -&gt; <a class="el" href="structboost_1_1gil_1_1packed__pixel.html">packed_pixel</a> &amp;</td></tr>
  105. <tr class="separator:a553893831e1583d86f28eb5596402385"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a2ee168419936700a6db322af16b6fa56"><td class="memTemplParams" colspan="2"><a id="a2ee168419936700a6db322af16b6fa56"></a>
  107. template&lt;typename Pixel &gt; </td></tr>
  108. <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>
  109. <tr class="separator:a2ee168419936700a6db322af16b6fa56"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a7e84b33a61c27a8ca0d4cfd1d17a3ce7"><td class="memTemplParams" colspan="2"><a id="a7e84b33a61c27a8ca0d4cfd1d17a3ce7"></a>
  111. template&lt;typename Pixel &gt; </td></tr>
  112. <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>
  113. <tr class="separator:a7e84b33a61c27a8ca0d4cfd1d17a3ce7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a90a835cc55452cb9fad3ddea37edeee0"><td class="memItemLeft" align="right" valign="top"><a id="a90a835cc55452cb9fad3ddea37edeee0"></a>
  115. auto&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (int channel) -&gt; <a class="el" href="structboost_1_1gil_1_1packed__pixel.html">packed_pixel</a> &amp;</td></tr>
  116. <tr class="separator:a90a835cc55452cb9fad3ddea37edeee0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:ade7d7abc5e0caec28ccdb97448916b32"><td class="memItemLeft" align="right" valign="top"><a id="ade7d7abc5e0caec28ccdb97448916b32"></a>
  118. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (int channel) const</td></tr>
  119. <tr class="separator:ade7d7abc5e0caec28ccdb97448916b32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table><table class="memberdecls">
  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  122. Public Attributes</h2></td></tr>
  123. <tr class="memitem:abe60dad4ae2eb0daf0d399e66fc2c11a"><td class="memItemLeft" align="right" valign="top"><a id="abe60dad4ae2eb0daf0d399e66fc2c11a"></a>
  124. BitField&#160;</td><td class="memItemRight" valign="bottom"><b>_bitfield</b> {0}</td></tr>
  125. <tr class="separator:abe60dad4ae2eb0daf0d399e66fc2c11a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table><table class="memberdecls">
  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
  128. Static Public Attributes</h2></td></tr>
  129. <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>
  130. <tr class="separator:ada04709db53ded2c170444a3f1c4e5d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table>
  132. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  133. <div class="textblock"><h3>template&lt;typename BitField, typename ChannelRefs, typename Layout&gt;<br />
  134. struct boost::gil::packed_pixel&lt; BitField, ChannelRefs, Layout &gt;</h3>
  135. <p>Heterogeneous pixel value whose channel references can be constructed from the pixel bitfield and their index. Models <a class="el" href="structboost_1_1gil_1_1_color_base_value_concept.html" title="Color base that also has a default-constructor. Refines Regular.">ColorBaseValueConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_value_concept.html" title="Pixel concept that is a Regular type.">PixelValueConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs.">PixelBasedConcept</a> Typical use for this is a model of a packed pixel (like 565 RGB) </p>
  136. <dl class="tparams"><dt>Template Parameters</dt><dd>
  137. <table class="tparams">
  138. <tr><td class="paramname">BitField</td><td>Type that holds the bits of the pixel. Typically an integral type, like std::uint16_t. </td></tr>
  139. <tr><td class="paramname">ChannelRefs</td><td>MP11 list whose elements are packed channels. They must be constructible from BitField. GIL uses packed_channel_reference </td></tr>
  140. <tr><td class="paramname">Layout</td><td>defining the color space and ordering of the channels. Example value: rgb_layout_t </td></tr>
  141. </table>
  142. </dd>
  143. </dl>
  144. </div><h2 class="groupheader">Member Data Documentation</h2>
  145. <a id="ada04709db53ded2c170444a3f1c4e5d4"></a>
  146. <h2 class="memtitle"><span class="permalink"><a href="#ada04709db53ded2c170444a3f1c4e5d4">&#9670;&nbsp;</a></span>is_mutable</h2>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="mlabels">
  150. <tr>
  151. <td class="mlabels-left">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">constexpr bool is_mutable</td>
  155. </tr>
  156. </table>
  157. </td>
  158. <td class="mlabels-right">
  159. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. <b>Initial value:</b><div class="fragment"><div class="line">=</div><div class="line"> channel_traits&lt;mp11::mp_front&lt;ChannelRefs&gt;&gt;::is_mutable</div></div><!-- fragment -->
  164. </div>
  165. </div>
  166. <hr/>The documentation for this struct was generated from the following files:<ul>
  167. <li><a class="el" href="metafunctions_8hpp_source.html">metafunctions.hpp</a></li>
  168. <li><a class="el" href="packed__pixel_8hpp_source.html">packed_pixel.hpp</a></li>
  169. </ul>
  170. </div><!-- contents -->
  171. <!-- HTML footer for doxygen 1.8.13-->
  172. <!-- start footer part -->
  173. <hr class="footer"/>
  174. <address class="footer">
  175. <small>
  176. Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  177. </small>
  178. </address>
  179. </body>
  180. </html>