blob: 5f1763c24fd1355b4a760e50532892a3505d443e [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: bit_aligned_pixel_reference 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_0403.html">bit_aligned_pixel_reference</a>
</div>
<div class="contents">
<h1>bit_aligned_pixel_reference Struct Template Reference<br>
<small>
[<a class="el" href="g_i_l_0120.html">bit_aligned_pixel_reference</a>,&nbsp;<a class="el" href="g_i_l_0207.html">bit_aligned_pixel_reference</a>,&nbsp;<a class="el" href="g_i_l_0182.html">Models</a>]</small>
</h1><!-- doxytag: class="boost::gil::bit_aligned_pixel_reference" --><code>#include &lt;<a class="el" href="g_i_l_0012.html">bit_aligned_pixel_reference.hpp</a>&gt;</code>
<p>
<p>
<a href="g_i_l_0402.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename BitField, typename ChannelBitSizes, typename Layout, bool IsMutable&gt;<br>
struct boost::gil::bit_aligned_pixel_reference&lt; BitField, ChannelBitSizes, Layout, IsMutable &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> reference corresponding to non-byte-aligned bit range. Models <a class="el" href="g_i_l_0274.html" title="A color base is a container of color elements (such as channels, channel references...">ColorBaseConcept</a>, <a class="el" href="g_i_l_0346.html" title="Pixel concept - A color base whose elements are channels.">PixelConcept</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>. <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="090a47563db6aaa3b7a65496a526745d"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::bit_range_t" ref="090a47563db6aaa3b7a65496a526745d" args="" -->
typedef boost::gil::bit_range<br>
&lt; bit_size, IsMutable &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>bit_range_t</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aba5710712a30d6edf78d95c5188a785"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::bitfield_t" ref="aba5710712a30d6edf78d95c5188a785" args="" -->
typedef BitField&nbsp;</td><td class="memItemRight" valign="bottom"><b>bitfield_t</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f59e345033c9be8446e064b67ab0cf09"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::data_ptr_t" ref="f59e345033c9be8446e064b67ab0cf09" args="" -->
typedef mpl::if_c&lt; IsMutable, <br>
unsigned char *, const <br>
unsigned char * &gt;::type&nbsp;</td><td class="memItemRight" valign="bottom"><b>data_ptr_t</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9bf611797579dcbe2e6dd308a54660d1"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::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="1c440a8aaa072f8f4a06ab15bd7e6475"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::value_type" ref="1c440a8aaa072f8f4a06ab15bd7e6475" args="" -->
typedef <a class="el" href="g_i_l_0597.html">packed_pixel_type</a><br>
&lt; bitfield_t, ChannelBitSizes, <br>
Layout &gt;::type&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="c252e003e41a202aee175ee1f12ddfa8"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::reference" ref="c252e003e41a202aee175ee1f12ddfa8" args="" -->
typedef const <br>
<a class="el" href="g_i_l_0403.html">bit_aligned_pixel_reference</a>&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="ab28f2d0b6764eef60a8acd933ea3a7b"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::const_reference" ref="ab28f2d0b6764eef60a8acd933ea3a7b" args="" -->
typedef const <br>
<a class="el" href="g_i_l_0403.html">bit_aligned_pixel_reference</a><br>
&lt; BitField, ChannelBitSizes, <br>
Layout, false &gt;&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="3a69cb8aefa526414b269be2f7479545"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::BOOST_STATIC_CONSTANT" ref="3a69cb8aefa526414b269be2f7479545" args="(int, bit_size=(mpl::accumulate&lt; ChannelBitSizes, mpl::int_&lt; 0 &gt;, mpl::plus&lt; mpl::_1, mpl::_2 &gt; &gt;::type::value))" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>BOOST_STATIC_CONSTANT</b> (int, bit_size=(mpl::accumulate&lt; ChannelBitSizes, mpl::int_&lt; 0 &gt;, mpl::plus&lt; mpl::_1, mpl::_2 &gt; &gt;::type::value))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4eb33e401f076a2eff14329f860c090"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::BOOST_STATIC_CONSTANT" ref="b4eb33e401f076a2eff14329f860c090" args="(bool, is_mutable=IsMutable)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>BOOST_STATIC_CONSTANT</b> (bool, is_mutable=IsMutable)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d71c7d0bfa6f28062aea6987e0ae570"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::bit_aligned_pixel_reference" ref="3d71c7d0bfa6f28062aea6987e0ae570" args="(data_ptr_t data_ptr, int bit_offset)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>bit_aligned_pixel_reference</b> (data_ptr_t data_ptr, int bit_offset)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="34e80e47893a75cb3183d9eced434dc8"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::bit_aligned_pixel_reference" ref="34e80e47893a75cb3183d9eced434dc8" args="(const bit_range_t &amp;bit_range)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>bit_aligned_pixel_reference</b> (const bit_range_t &amp;bit_range)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="2efa5ad7c27a0f43aa0cfe1e7b9faff7"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::bit_aligned_pixel_reference" ref="2efa5ad7c27a0f43aa0cfe1e7b9faff7" args="(const bit_aligned_pixel_reference&lt; BitField, ChannelBitSizes, Layout, IsMutable2 &gt; &amp;p)" -->
template&lt;bool IsMutable2&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>bit_aligned_pixel_reference</b> (const <a class="el" href="g_i_l_0403.html">bit_aligned_pixel_reference</a>&lt; BitField, ChannelBitSizes, Layout, IsMutable2 &gt; &amp;p)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad4b3240662f95381f941ec6f6e8f199"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::bit_aligned_pixel_reference" ref="ad4b3240662f95381f941ec6f6e8f199" args="(const typename kth_element_type&lt; bit_aligned_pixel_reference, 0 &gt;::type channel0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>bit_aligned_pixel_reference</b> (const typename kth_element_type&lt; <a class="el" href="g_i_l_0403.html">bit_aligned_pixel_reference</a>, 0 &gt;::type channel0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83f586bee6b3ed5ded0d1203f85d5311"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::bit_aligned_pixel_reference" ref="83f586bee6b3ed5ded0d1203f85d5311" args="(const bit_aligned_pixel_reference &amp;p)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>bit_aligned_pixel_reference</b> (const <a class="el" href="g_i_l_0403.html">bit_aligned_pixel_reference</a> &amp;p)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="564a405b03c9f18a2b1309484d800676"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::bit_aligned_pixel_reference" ref="564a405b03c9f18a2b1309484d800676" args="(packed_pixel&lt; BF, CR, Layout &gt; &amp;p)" -->
template&lt;typename BF, typename CR&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>bit_aligned_pixel_reference</b> (<a class="el" href="g_i_l_0595.html">packed_pixel</a>&lt; BF, CR, Layout &gt; &amp;p)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a862c1a1748a98154256fc80c289514"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::operator=" ref="3a862c1a1748a98154256fc80c289514" args="(const bit_aligned_pixel_reference &amp;p) const " -->
const <a class="el" href="g_i_l_0403.html">bit_aligned_pixel_reference</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="g_i_l_0403.html">bit_aligned_pixel_reference</a> &amp;p) const </td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="fd718e6e23ccfd708b8972a5575a5a35"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::operator=" ref="fd718e6e23ccfd708b8972a5575a5a35" args="(const P &amp;p) const " -->
template&lt;typename P&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">const <a class="el" href="g_i_l_0403.html">bit_aligned_pixel_reference</a> &amp;&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="9c8a7702432bad6596491569609182aa"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::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::bit_aligned_pixel_reference::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="101f88432309b851a530e8b4585f9e05"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::operator-&gt;" ref="101f88432309b851a530e8b4585f9e05" args="() const " -->
const <a class="el" href="g_i_l_0403.html">bit_aligned_pixel_reference</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator-&gt;</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4930ce6d0686634aa4695f47e0e9e64e"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::bit_range" ref="4930ce6d0686634aa4695f47e0e9e64e" args="() const " -->
const bit_range_t &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>bit_range</b> () const </td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d655cd4dbc7c07c3e1a3a2e5bee699f5"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_reference::bit_aligned_pixel_reference" ref="d655cd4dbc7c07c3e1a3a2e5bee699f5" args="" -->
struct&nbsp;</td><td class="memItemRight" valign="bottom"><b>bit_aligned_pixel_reference</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_0012.html">bit_aligned_pixel_reference.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:17 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>