blob: f6d2cb7d68b8c93309a47afe14777ac02ce6e7dc [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 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_0595.html">packed_pixel</a>
</div>
<div class="contents">
<h1>packed_pixel Struct Template Reference<br>
<small>
[<a class="el" href="g_i_l_0121.html">packed_pixel</a>,&nbsp;<a class="el" href="g_i_l_0208.html">packed_pixel</a>,&nbsp;<a class="el" href="g_i_l_0182.html">Models</a>]</small>
</h1><!-- doxytag: class="boost::gil::packed_pixel" --><code>#include &lt;<a class="el" href="g_i_l_0239.html">packed_pixel.hpp</a>&gt;</code>
<p>
<p>
<a href="g_i_l_0594.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename BitField, typename ChannelRefVec, typename Layout&gt;<br>
struct boost::gil::packed_pixel&lt; BitField, ChannelRefVec, Layout &gt;</h3>
Heterogeneous <a class="el" href="g_i_l_0599.html" title="Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept...">pixel</a> value whose channel references can be constructed from the <a class="el" href="g_i_l_0599.html" title="Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept...">pixel</a> bitfield and their index. Models <a class="el" href="g_i_l_0276.html" title="Color base that also has a default-constructor. Refines Regular.">ColorBaseValueConcept</a>, <a class="el" href="g_i_l_0356.html" title="Pixel concept that is a Regular type.">PixelValueConcept</a>, <a class="el" href="g_i_l_0344.html" title="Concept for all pixel-based GIL constructs, such as pixels, iterators, locators,...">PixelBasedConcept</a> Typical use for this is a model 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> (like 565 RGB). <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="9bf611797579dcbe2e6dd308a54660d1"></a><!-- doxytag: member="boost::gil::packed_pixel::layout_t" ref="9bf611797579dcbe2e6dd308a54660d1" args="" -->
typedef Layout&nbsp;</td><td class="memItemRight" valign="bottom"><b>layout_t</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="581d785b88712ff9e0b5022b573c8e91"></a><!-- doxytag: member="boost::gil::packed_pixel::value_type" ref="581d785b88712ff9e0b5022b573c8e91" args="" -->
typedef <a class="el" href="g_i_l_0595.html">packed_pixel</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>value_type</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="be8933d436779a43cb5c1896ff5f2918"></a><!-- doxytag: member="boost::gil::packed_pixel::reference" ref="be8933d436779a43cb5c1896ff5f2918" args="" -->
typedef <a class="el" href="g_i_l_0595.html">value_type</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>reference</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fdb67657e63a66ed3fae7b0c9fd81b48"></a><!-- doxytag: member="boost::gil::packed_pixel::const_reference" ref="fdb67657e63a66ed3fae7b0c9fd81b48" args="" -->
typedef const <a class="el" href="g_i_l_0595.html">value_type</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_reference</b></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="14c0e5abaf758efea57a44870b1dfd81"></a><!-- doxytag: member="boost::gil::packed_pixel::BOOST_STATIC_CONSTANT" ref="14c0e5abaf758efea57a44870b1dfd81" args="(bool, is_mutable=channel_traits&lt; typename mpl::front&lt; ChannelRefVec &gt;::type &gt;::is_mutable)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>BOOST_STATIC_CONSTANT</b> (bool, is_mutable=<a class="el" href="g_i_l_0429.html">channel_traits</a>&lt; typename mpl::front&lt; ChannelRefVec &gt;::type &gt;::is_mutable)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7a0f92a9c16bae51843b51bc403d4f66"></a><!-- doxytag: member="boost::gil::packed_pixel::packed_pixel" ref="7a0f92a9c16bae51843b51bc403d4f66" args="(const BitField &amp;bitfield)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>packed_pixel</b> (const BitField &amp;bitfield)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ff484214ed1cf602c6ff2ecdf61f6286"></a><!-- doxytag: member="boost::gil::packed_pixel::packed_pixel" ref="ff484214ed1cf602c6ff2ecdf61f6286" args="(const packed_pixel &amp;p)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>packed_pixel</b> (const <a class="el" href="g_i_l_0595.html">packed_pixel</a> &amp;p)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="51a0d66342d8219ea3831dfe3fd683e1"></a><!-- doxytag: member="boost::gil::packed_pixel::packed_pixel" ref="51a0d66342d8219ea3831dfe3fd683e1" args="(const P &amp;p, typename enable_if_c&lt; is_pixel&lt; P &gt;::value &gt;::type *d=0)" -->
template&lt;typename P&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>packed_pixel</b> (const P &amp;p, typename enable_if_c&lt; is_pixel&lt; P &gt;::value &gt;::type *d=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b0c095207a249eee45ef6395e797c07"></a><!-- doxytag: member="boost::gil::packed_pixel::packed_pixel" ref="1b0c095207a249eee45ef6395e797c07" args="(int chan0, int chan1)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>packed_pixel</b> (int chan0, int chan1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3abae6acc5d7a9390f90ce0ac4a921b2"></a><!-- doxytag: member="boost::gil::packed_pixel::packed_pixel" ref="3abae6acc5d7a9390f90ce0ac4a921b2" args="(int chan0, int chan1, int chan2)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>packed_pixel</b> (int chan0, int chan1, int chan2)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="58d1ee448cc3b98979fd9951a669c55d"></a><!-- doxytag: member="boost::gil::packed_pixel::packed_pixel" ref="58d1ee448cc3b98979fd9951a669c55d" args="(int chan0, int chan1, int chan2, int chan3)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>packed_pixel</b> (int chan0, int chan1, int chan2, int chan3)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="815777d11cb8b7c4277b99660bd3a755"></a><!-- doxytag: member="boost::gil::packed_pixel::packed_pixel" ref="815777d11cb8b7c4277b99660bd3a755" args="(int chan0, int chan1, int chan2, int chan3, int chan4)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>packed_pixel</b> (int chan0, int chan1, int chan2, int chan3, int chan4)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bab0f7074929c89dff7f77867b42e60c"></a><!-- doxytag: member="boost::gil::packed_pixel::operator=" ref="bab0f7074929c89dff7f77867b42e60c" args="(const packed_pixel &amp;p)" -->
<a class="el" href="g_i_l_0595.html">packed_pixel</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="g_i_l_0595.html">packed_pixel</a> &amp;p)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="183d1a19099dc1486095c257f59e42b0"></a><!-- doxytag: member="boost::gil::packed_pixel::operator=" ref="183d1a19099dc1486095c257f59e42b0" args="(const P &amp;p)" -->
template&lt;typename P&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"><a class="el" href="g_i_l_0595.html">packed_pixel</a> &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (const P &amp;p)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="9c8a7702432bad6596491569609182aa"></a><!-- doxytag: member="boost::gil::packed_pixel::operator==" ref="9c8a7702432bad6596491569609182aa" args="(const P &amp;p) const " -->
template&lt;typename P&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator==</b> (const P &amp;p) const </td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="d423c41799a9bb0cd5dcc28c16935a42"></a><!-- doxytag: member="boost::gil::packed_pixel::operator!=" ref="d423c41799a9bb0cd5dcc28c16935a42" args="(const P &amp;p) const " -->
template&lt;typename P&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator!=</b> (const P &amp;p) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0fe334197bdb0453d38d891132cafe56"></a><!-- doxytag: member="boost::gil::packed_pixel::operator=" ref="0fe334197bdb0453d38d891132cafe56" args="(int chan)" -->
<a class="el" href="g_i_l_0595.html">packed_pixel</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (int chan)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d1cc0ca44c249fa77cf401f68ea9b6ef"></a><!-- doxytag: member="boost::gil::packed_pixel::operator==" ref="d1cc0ca44c249fa77cf401f68ea9b6ef" args="(int chan) const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (int chan) const </td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="be60dad4ae2eb0daf0d399e66fc2c11a"></a><!-- doxytag: member="boost::gil::packed_pixel::_bitfield" ref="be60dad4ae2eb0daf0d399e66fc2c11a" args="" -->
BitField&nbsp;</td><td class="memItemRight" valign="bottom"><b>_bitfield</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_0239.html">packed_pixel.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>