blob: e46aba4e1781c27e1cea160448cd8593d91b31e9 [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: scoped_channel_value 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_0620.html">scoped_channel_value</a>
</div>
<div class="contents">
<h1>scoped_channel_value Struct Template Reference<br>
<small>
[<a class="el" href="g_i_l_0215.html">scoped_channel_value</a>]</small>
</h1><!-- doxytag: class="boost::gil::scoped_channel_value" --><code>#include &lt;<a class="el" href="g_i_l_0014.html">channel.hpp</a>&gt;</code>
<p>
<p>
<a href="g_i_l_0619.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename BaseChannelValue, typename MinVal, typename MaxVal&gt;<br>
struct boost::gil::scoped_channel_value&lt; BaseChannelValue, MinVal, MaxVal &gt;</h3>
A channel adaptor that modifies the range of the source channel. Models: <a class="el" href="g_i_l_0270.html" title="A channel that supports default construction.">ChannelValueConcept</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="b55619ad0bb4fb1c8f0c2b3bcde50292"></a><!-- doxytag: member="boost::gil::scoped_channel_value::value_type" ref="b55619ad0bb4fb1c8f0c2b3bcde50292" args="" -->
typedef <a class="el" href="g_i_l_0620.html">scoped_channel_value</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::scoped_channel_value::reference" ref="be8933d436779a43cb5c1896ff5f2918" args="" -->
typedef <a class="el" href="g_i_l_0620.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="d25b518036b886d8f35a3c059301d007"></a><!-- doxytag: member="boost::gil::scoped_channel_value::pointer" ref="d25b518036b886d8f35a3c059301d007" args="" -->
typedef <a class="el" href="g_i_l_0620.html">value_type</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>pointer</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fdb67657e63a66ed3fae7b0c9fd81b48"></a><!-- doxytag: member="boost::gil::scoped_channel_value::const_reference" ref="fdb67657e63a66ed3fae7b0c9fd81b48" args="" -->
typedef const <a class="el" href="g_i_l_0620.html">value_type</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_reference</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="13c57dab17e2c903cadfa5e35ba84064"></a><!-- doxytag: member="boost::gil::scoped_channel_value::const_pointer" ref="13c57dab17e2c903cadfa5e35ba84064" args="" -->
typedef const <a class="el" href="g_i_l_0620.html">value_type</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_pointer</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="4d1bf1f717a685a1c1af641f5be0f5e5"></a><!-- doxytag: member="boost::gil::scoped_channel_value::BOOST_STATIC_CONSTANT" ref="4d1bf1f717a685a1c1af641f5be0f5e5" args="(bool, is_mutable=channel_traits&lt; BaseChannelValue &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; BaseChannelValue &gt;::is_mutable)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fdab75b4c5d9b0610e3aa9bc0c19ea42"></a><!-- doxytag: member="boost::gil::scoped_channel_value::scoped_channel_value" ref="fdab75b4c5d9b0610e3aa9bc0c19ea42" args="(const scoped_channel_value &amp;c)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>scoped_channel_value</b> (const <a class="el" href="g_i_l_0620.html">scoped_channel_value</a> &amp;c)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd0b8b52c551089eb67108a5c26856a7"></a><!-- doxytag: member="boost::gil::scoped_channel_value::scoped_channel_value" ref="dd0b8b52c551089eb67108a5c26856a7" args="(BaseChannelValue val)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>scoped_channel_value</b> (BaseChannelValue val)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d18161aa3f2807c551a64d2cf5377167"></a><!-- doxytag: member="boost::gil::scoped_channel_value::operator++" ref="d18161aa3f2807c551a64d2cf5377167" args="()" -->
<a class="el" href="g_i_l_0620.html">scoped_channel_value</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator++</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5fe5e74be552982f492a9606d56b83b1"></a><!-- doxytag: member="boost::gil::scoped_channel_value::operator--" ref="5fe5e74be552982f492a9606d56b83b1" args="()" -->
<a class="el" href="g_i_l_0620.html">scoped_channel_value</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator--</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="75b0dd1cde8fec98f0fd6cc77a9e4ee8"></a><!-- doxytag: member="boost::gil::scoped_channel_value::operator++" ref="75b0dd1cde8fec98f0fd6cc77a9e4ee8" args="(int)" -->
<a class="el" href="g_i_l_0620.html">scoped_channel_value</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator++</b> (int)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fce9602b5df696ebcc207a2965611f78"></a><!-- doxytag: member="boost::gil::scoped_channel_value::operator--" ref="fce9602b5df696ebcc207a2965611f78" args="(int)" -->
<a class="el" href="g_i_l_0620.html">scoped_channel_value</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator--</b> (int)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="43420534b048183f65ebeabb09bdc3a8"></a><!-- doxytag: member="boost::gil::scoped_channel_value::operator+=" ref="43420534b048183f65ebeabb09bdc3a8" args="(Scalar2 v)" -->
template&lt;typename Scalar2&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"><a class="el" href="g_i_l_0620.html">scoped_channel_value</a> &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator+=</b> (Scalar2 v)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="bfe79b995772ece021f9eb75ad749fe3"></a><!-- doxytag: member="boost::gil::scoped_channel_value::operator-=" ref="bfe79b995772ece021f9eb75ad749fe3" args="(Scalar2 v)" -->
template&lt;typename Scalar2&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"><a class="el" href="g_i_l_0620.html">scoped_channel_value</a> &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator-=</b> (Scalar2 v)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="0a41d31a69309e53a8bab8b957ec3449"></a><!-- doxytag: member="boost::gil::scoped_channel_value::operator*=" ref="0a41d31a69309e53a8bab8b957ec3449" args="(Scalar2 v)" -->
template&lt;typename Scalar2&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"><a class="el" href="g_i_l_0620.html">scoped_channel_value</a> &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator*=</b> (Scalar2 v)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="00b51250ea6dd04f38ce280bc74edd92"></a><!-- doxytag: member="boost::gil::scoped_channel_value::operator/=" ref="00b51250ea6dd04f38ce280bc74edd92" args="(Scalar2 v)" -->
template&lt;typename Scalar2&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"><a class="el" href="g_i_l_0620.html">scoped_channel_value</a> &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator/=</b> (Scalar2 v)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="773a34008148c085cab5db445f2865a2"></a><!-- doxytag: member="boost::gil::scoped_channel_value::operator=" ref="773a34008148c085cab5db445f2865a2" args="(BaseChannelValue v)" -->
<a class="el" href="g_i_l_0620.html">scoped_channel_value</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (BaseChannelValue v)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3b58d708916960907cd3498b3a2c31bc"></a><!-- doxytag: member="boost::gil::scoped_channel_value::operator BaseChannelValue" ref="3b58d708916960907cd3498b3a2c31bc" args="() const " -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator BaseChannelValue</b> () const </td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eea09e99122e4d51f9f957b09108c6e0"></a><!-- doxytag: member="boost::gil::scoped_channel_value::min_value" ref="eea09e99122e4d51f9f957b09108c6e0" args="()" -->
static <a class="el" href="g_i_l_0620.html">value_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>min_value</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2921f8eaaa8363418bbdc1be7febc725"></a><!-- doxytag: member="boost::gil::scoped_channel_value::max_value" ref="2921f8eaaa8363418bbdc1be7febc725" args="()" -->
static <a class="el" href="g_i_l_0620.html">value_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>max_value</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_0014.html">channel.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>