blob: 5cbcb32dbefa3c759916f91557f791ebc2dff585 [file] [log] [blame]
<!-- Copyright 2008 Lubomir Bourdev and Hailin Jin
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
-->
<!--
Copyright 2005-2007 Adobe Systems Incorporated
Distributed under the MIT License (see accompanying file LICENSE_1_0_0.txt
or a copy at http://stlab.adobe.com/licenses.html)
Some files are held under additional license.
Please see "http://stlab.adobe.com/licenses.html" for more information.
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<TITLE>Generic Image Library: packed_pixel_type Struct Template Reference</TITLE>
<META HTTP-EQUIV="content-type" CONTENT="text/html;charset=ISO-8859-1"/>
<LINK TYPE="text/css" REL="stylesheet" HREF="adobe_source.css"/>
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" style='width: 100%; margin: 0; padding: 0'><tr>
<td width="100%" valign="top" style='padding-left: 10px; padding-right: 10px; padding-bottom: 10px'>
<div class="qindex"><a class="qindex" href="index.html">Modules</a>
| <a class="qindex" href="classes.html">Alphabetical List</a>
| <a class="qindex" href="annotated.html">Class List</a>
| <a class="qindex" href="dirs.html">Directories</a>
| <a class="qindex" href="files.html">File List</a>
| <a class="qindex" href="../index.html">GIL Home Page</a>
</div>
<!-- End Header -->
<!-- Generated by Doxygen 1.5.6 -->
<div class="navpath"><a class="el" href="namespaceboost.html">boost</a>::<b>gil</b>::<a class="el" href="g_i_l_0597.html">packed_pixel_type</a>
</div>
<div class="contents">
<h1>packed_pixel_type Struct Template Reference<br>
<small>
[<a class="el" href="g_i_l_0220.html">xxx_type</a>]</small>
</h1><!-- doxytag: class="boost::gil::packed_pixel_type" --><code>#include &lt;<a class="el" href="g_i_l_0237.html">metafunctions.hpp</a>&gt;</code>
<p>
Inherited by pixel_value_type&lt; packed_channel_value&lt; NumBits &gt;, Layout &gt;.
<p>
<p>
<a href="g_i_l_0596.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename BitField, typename ChannelBitSizeVector, typename Layout&gt;<br>
struct boost::gil::packed_pixel_type&lt; BitField, ChannelBitSizeVector, Layout &gt;</h3>
Returns the type of a packed <a class="el" href="g_i_l_0599.html" title="Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept...">pixel</a> given its bitfield type, the bit <a class="el" href="g_i_l_0621.html" title="Returns an MPL integral type specifying the number of elements in a color base.">size</a> of its channels and its <a class="el" href="g_i_l_0567.html" title="Represents a color space and ordering of channels in memory.">layout</a>.
<p>
A packed <a class="el" href="g_i_l_0599.html" title="Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept...">pixel</a> has channels that cover bit ranges but itself is byte aligned. RGB565 <a class="el" href="g_i_l_0599.html" title="Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept...">pixel</a> is an example.<p>
The <a class="el" href="g_i_l_0621.html" title="Returns an MPL integral type specifying the number of elements in a color base.">size</a> of ChannelBitSizeVector must equal the number of channels in the given <a class="el" href="g_i_l_0567.html" title="Represents a color space and ordering of channels in memory.">layout</a> 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. <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c8ba32231d2be41ae49488714ec4eb7"></a><!-- doxytag: member="boost::gil::packed_pixel_type::type" ref="4c8ba32231d2be41ae49488714ec4eb7" args="" -->
typedef <a class="el" href="g_i_l_0595.html">packed_pixel</a>&lt; BitField, <br>
typename <br>
detail::packed_channel_references_vector_type<br>
&lt; BitField, <br>
ChannelBitSizeVector &gt;::<a class="el" href="g_i_l_0595.html">type</a>, <br>
Layout &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>type</b></td></tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="g_i_l_0237.html">metafunctions.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:18 2009 for Generic Image Library by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>