blob: 4f7e75d57c0f2723d2d7babc863a84415e9baee2 [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: planar_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_0611.html">planar_pixel_reference</a>
</div>
<div class="contents">
<h1>planar_pixel_reference Struct Template Reference<br>
<small>
[<a class="el" href="g_i_l_0210.html">planar_pixel_reference</a>,&nbsp;<a class="el" href="g_i_l_0124.html">planar_pixel_reference</a>,&nbsp;<a class="el" href="g_i_l_0182.html">Models</a>]</small>
</h1><!-- doxytag: class="boost::gil::planar_pixel_reference" --><code>#include &lt;<a class="el" href="g_i_l_0248.html">planar_pixel_reference.hpp</a>&gt;</code>
<p>
<p>
<a href="g_i_l_0610.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename ChannelReference, typename ColorSpace&gt;<br>
struct boost::gil::planar_pixel_reference&lt; ChannelReference, ColorSpace &gt;</h3>
A reference proxy to a planar <a class="el" href="g_i_l_0599.html" title="Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept...">pixel</a>. Models: <a class="el" href="g_i_l_0296.html" title="Color base whose elements all have the same type.">HomogeneousColorBaseConcept</a>, <a class="el" href="g_i_l_0302.html" title="Homogeneous pixel concept.">HomogeneousPixelConcept</a>.
<p>
A reference to a planar <a class="el" href="g_i_l_0599.html" title="Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept...">pixel</a> is a proxy class containing references to each of the corresponding channels. <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="1a5f62260eb47c48fd372ea7df1de6ee"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::parent_t" ref="1a5f62260eb47c48fd372ea7df1de6ee" args="" -->
typedef <br>
detail::homogeneous_color_base<br>
&lt; ChannelReference, <a class="el" href="g_i_l_0567.html">layout</a><br>
&lt; ColorSpace &gt;, mpl::size<br>
&lt; ColorSpace &gt;::value &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>parent_t</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="58fc016f8cc17a482ff4abea80558bb0"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::value_type" ref="58fc016f8cc17a482ff4abea80558bb0" args="" -->
typedef <a class="el" href="g_i_l_0599.html">pixel</a>&lt; channel_t, <br>
<a class="el" href="g_i_l_0567.html">layout</a>&lt; ColorSpace &gt; &gt;&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="513092e92cd5258638c9a16ad8ef4f6a"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::reference" ref="513092e92cd5258638c9a16ad8ef4f6a" args="" -->
typedef <a class="el" href="g_i_l_0611.html">planar_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="e0a3d8339ccdbacf93748df22e3a3169"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::const_reference" ref="e0a3d8339ccdbacf93748df22e3a3169" args="" -->
typedef <a class="el" href="g_i_l_0611.html">planar_pixel_reference</a><br>
&lt; channel_const_reference, <br>
ColorSpace &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="5c0c09a950ecb3fa7c9523c222415816"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::BOOST_STATIC_CONSTANT" ref="5c0c09a950ecb3fa7c9523c222415816" args="(bool, is_mutable=channel_traits&lt; ChannelReference &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; ChannelReference &gt;::is_mutable)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b85a6656613145874834ed272fed7f76"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::planar_pixel_reference" ref="b85a6656613145874834ed272fed7f76" args="(ChannelReference v0, ChannelReference v1)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_reference</b> (ChannelReference v0, ChannelReference v1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c748457647ef60e3058dd9a777a659f3"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::planar_pixel_reference" ref="c748457647ef60e3058dd9a777a659f3" args="(ChannelReference v0, ChannelReference v1, ChannelReference v2)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_reference</b> (ChannelReference v0, ChannelReference v1, ChannelReference v2)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1150133adc3a4f2edc3d3bd9dde477b1"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::planar_pixel_reference" ref="1150133adc3a4f2edc3d3bd9dde477b1" args="(ChannelReference v0, ChannelReference v1, ChannelReference v2, ChannelReference v3)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_reference</b> (ChannelReference v0, ChannelReference v1, ChannelReference v2, ChannelReference v3)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6074ff79afc3bc5206fa2008ff959886"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::planar_pixel_reference" ref="6074ff79afc3bc5206fa2008ff959886" args="(ChannelReference v0, ChannelReference v1, ChannelReference v2, ChannelReference v3, ChannelReference v4)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_reference</b> (ChannelReference v0, ChannelReference v1, ChannelReference v2, ChannelReference v3, ChannelReference v4)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="326177c672b834ebae1f606d092db69d"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::planar_pixel_reference" ref="326177c672b834ebae1f606d092db69d" args="(ChannelReference v0, ChannelReference v1, ChannelReference v2, ChannelReference v3, ChannelReference v4, ChannelReference v5)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_reference</b> (ChannelReference v0, ChannelReference v1, ChannelReference v2, ChannelReference v3, ChannelReference v4, ChannelReference v5)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="56baa217dc531e09f7f4324ff014c4ba"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::planar_pixel_reference" ref="56baa217dc531e09f7f4324ff014c4ba" args="(const P &amp;p)" -->
template&lt;typename P&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>planar_pixel_reference</b> (const P &amp;p)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="c29596386391d6089c7c6fca2279dd8c"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::planar_pixel_reference" ref="c29596386391d6089c7c6fca2279dd8c" args="(pixel&lt; ChannelV, layout&lt; ColorSpace, Mapping &gt; &gt; &amp;p)" -->
template&lt;typename ChannelV, typename Mapping&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>planar_pixel_reference</b> (<a class="el" href="g_i_l_0599.html">pixel</a>&lt; ChannelV, <a class="el" href="g_i_l_0567.html">layout</a>&lt; ColorSpace, Mapping &gt; &gt; &amp;p)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="d80593db8f81f5e38cca7f7431cfbf15"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::planar_pixel_reference" ref="d80593db8f81f5e38cca7f7431cfbf15" args="(const planar_pixel_iterator&lt; ChannelPtr, ColorSpace &gt; &amp;p, std::ptrdiff_t diff)" -->
template&lt;typename ChannelPtr&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>planar_pixel_reference</b> (const <a class="el" href="g_i_l_0609.html">planar_pixel_iterator</a>&lt; ChannelPtr, ColorSpace &gt; &amp;p, std::ptrdiff_t diff)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11856373a2fdf2992d6ec9c574fdaa3a"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::operator=" ref="11856373a2fdf2992d6ec9c574fdaa3a" args="(const planar_pixel_reference &amp;p) const " -->
const <a class="el" href="g_i_l_0611.html">planar_pixel_reference</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="g_i_l_0611.html">planar_pixel_reference</a> &amp;p) const </td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="173f12438a9a2379ae52ab207a1862cd"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::operator=" ref="173f12438a9a2379ae52ab207a1862cd" 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_0611.html">planar_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::planar_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::planar_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="e62e6d0e154050d639c4d779ad1df2e2"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::operator[]" ref="e62e6d0e154050d639c4d779ad1df2e2" args="(std::size_t i) const " -->
ChannelReference&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator[]</b> (std::size_t i) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c04d1e9caff628c590f156d59f400e23"></a><!-- doxytag: member="boost::gil::planar_pixel_reference::operator-&gt;" ref="c04d1e9caff628c590f156d59f400e23" args="() const " -->
const <a class="el" href="g_i_l_0611.html">planar_pixel_reference</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator-&gt;</b> () const </td></tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="g_i_l_0248.html">planar_pixel_reference.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>