libs/gil/doc/html/reference/structboost_1_1gil_1_1packed__pixel__type.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: packed_pixel_type&lt; BitField, ChannelBitSizes, 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__type.html">packed_pixel_type</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="structboost_1_1gil_1_1packed__pixel__type-members.html">List of all members</a>  </div>
  49   <div class="headertitle">
  50 <div class="title">packed_pixel_type&lt; BitField, ChannelBitSizes, Layout &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group___metafunctions.html">Metafunctions</a> &raquo; <a class="el" href="group___type_factory.html">Type Factory Metafunctions</a> &raquo; <a class="el" href="group___type_factory_from_elements.html">xxx_type</a></div></div>  </div>
  51 </div><!--header-->
  52 <div class="contents">
  53
  54 <p>Returns the type of a packed pixel given its bitfield type, the bit size of its channels and its layout.
  55  <a href="structboost_1_1gil_1_1packed__pixel__type.html#details">More...</a></p>
  56
  57 <p><code>#include &lt;<a class="el" href="metafunctions_8hpp_source.html">metafunctions.hpp</a>&gt;</code></p>
  58 <table class="memberdecls">
  59 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  60 Public Types</h2></td></tr>
  61 <tr class="memitem:ac974d4ee6a421283cf5abf93907e2d99"><td class="memItemLeft" align="right" valign="top"><a id="ac974d4ee6a421283cf5abf93907e2d99"></a>
  62 using&#160;</td><td class="memItemRight" valign="bottom"><b>type</b> = <a class="el" href="structboost_1_1gil_1_1packed__pixel.html">packed_pixel</a>&lt; BitField, typename detail::packed_channel_references_vector_type&lt; BitField, ChannelBitSizes &gt;::<a class="el" href="structboost_1_1gil_1_1packed__pixel.html">type</a>, Layout &gt;</td></tr>
  63 <tr class="separator:ac974d4ee6a421283cf5abf93907e2d99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 </table>
  65 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  66 <div class="textblock"><h3>template&lt;typename BitField, typename ChannelBitSizes, typename Layout&gt;<br />
  67 struct boost::gil::packed_pixel_type&lt; BitField, ChannelBitSizes, Layout &gt;</h3>
  68
  69 <p>Returns the type of a packed pixel given its bitfield type, the bit size of its channels and its layout. </p>
  70 <p>A packed pixel has channels that cover bit ranges but itself is byte aligned. RGB565 pixel is an example.</p>
  71 <p>The size of ChannelBitSizes must equal the number of channels in the given layout The sum of bit sizes for all channels must be less than or equal to the number of bits in BitField (and cannot exceed 64). If it is less than the number of bits in BitField, the last bits will be unused. </p>
  72 </div><hr/>The documentation for this struct was generated from the following file:<ul>
  73 <li><a class="el" href="metafunctions_8hpp_source.html">metafunctions.hpp</a></li>
  74 </ul>
  75 </div><!-- contents -->
  76      <!-- HTML footer for doxygen 1.8.13-->
  77      <!-- start footer part -->
  78      <hr class="footer"/>
  79      <address class="footer">
  80       <small>
  81         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  82       </small>
  83     </address>
  84   </body>
  85 </html>