ceph/src/boost/libs/gil/doc/html/g_i_l_0106.html

   1 <!-- Copyright 2008 Lubomir Bourdev and Hailin Jin
   2
   3      Distributed under the Boost Software License, Version 1.0.
   4      (See accompanying file LICENSE_1_0.txt or copy at
   5      http://www.boost.org/LICENSE_1_0.txt)
   6   -->
   7
   8 <!--
   9     Copyright 2005-2007 Adobe Systems Incorporated
  10     Distributed under the MIT License (see accompanying file LICENSE_1_0_0.txt
  11     or a copy at http://stlab.adobe.com/licenses.html)
  12
  13     Some files are held under additional license.
  14     Please see "http://stlab.adobe.com/licenses.html" for more information.
  15 -->
  16
  17 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  18         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  19 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
  20
  21 <head>
  22     <TITLE>Generic Image Library: color_element_type, color_element_reference_type, color_element_const_reference_type, get_color, contains_color</TITLE>
  23     <META HTTP-EQUIV="content-type" CONTENT="text/html;charset=ISO-8859-1"/>
  24     <LINK TYPE="text/css" REL="stylesheet" HREF="adobe_source.css"/>
  25 </head>
  26 <body>
  27 <table border="0" cellspacing="0" cellpadding="0" style='width: 100%; margin: 0; padding: 0'><tr>
  28 <td width="100%" valign="top" style='padding-left: 10px; padding-right: 10px; padding-bottom: 10px'>
  29 <div class="qindex"><a class="qindex" href="index.html">Modules</a>
  30                   | <a class="qindex" href="classes.html">Alphabetical List</a>
  31                   | <a class="qindex" href="annotated.html">Class List</a>
  32                   | <a class="qindex" href="dirs.html">Directories</a>
  33                   | <a class="qindex" href="files.html">File List</a>
  34                   | <a class="qindex" href="../index.html">GIL Home Page</a>
  35 </div>
  36 <!-- End Header -->
  37 <!-- Generated by Doxygen 1.5.6 -->
  38 <div class="contents">
  39 <h1>color_element_type, color_element_reference_type, color_element_const_reference_type, get_color, contains_color<br>
  40 <small>
  41 [<a class="el" href="g_i_l_0105.html">Algorithms and Utility Functions</a>]</small>
  42 </h1><hr><a name="_details"></a><h2>Detailed Description</h2>
  43 Support for accessing the elements of a color base by color name.
  44 <p>
  45 get_color: Named channel accessors<p>
  46 Example: A function that takes a generic <a class="el" href="g_i_l_0599.html" title="Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept...">pixel</a> containing a red channel and sets it to 100%:<p>
  47 <div class="fragment"><pre class="fragment"><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Pixel&gt;
  48 <span class="keywordtype">void</span> set_red_to_max(Pixel&amp; pixel) {
  49     boost::function_requires&lt;MutablePixelConcept&lt;Pixel&gt; &gt;();
  50     BOOST_STATIC_ASSERT((contains_color&lt;Pixel, red_t&gt;::value));
  51
  52     <span class="keyword">typedef</span> <span class="keyword">typename</span> color_element_type&lt;Pixel, red_t&gt;::type red_channel_t;
  53     <a class="code" href="g_i_l_0106.html#gab1205781ba628ca806c47a51f40f5f6" title="Mutable accessor to the element associated with a given color name.">get_color</a>(pixel, red_t()) = channel_traits&lt;red_channel_t&gt;::max_value();
  54 }
  55 </pre></div>
  56 <p>
  57 <table border="0" cellpadding="0" cellspacing="0">
  58 <tr><td></td></tr>
  59 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
  60 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="g_i_l_0447.html">contains_color</a></td></tr>
  61
  62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A predicate metafunction determining whether a given color base contains a given color.  <a href="g_i_l_0447.html#_details">More...</a><br></td></tr>
  63 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="g_i_l_0444.html">color_element_type</a></td></tr>
  64
  65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specifies the type of the element associated with a given color tag.  <a href="g_i_l_0444.html#_details">More...</a><br></td></tr>
  66 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="g_i_l_0442.html">color_element_reference_type</a></td></tr>
  67
  68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specifies the return type of the mutable element accessor by color name, get_color(color_base, Color());.  <a href="g_i_l_0442.html#_details">More...</a><br></td></tr>
  69 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="g_i_l_0440.html">color_element_const_reference_type</a></td></tr>
  70
  71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specifies the return type of the constant element accessor by color name, get_color(color_base, Color());.  <a href="g_i_l_0440.html#_details">More...</a><br></td></tr>
  72 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
  73 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="gab1205781ba628ca806c47a51f40f5f6"></a><!-- doxytag: member="ColorBaseAlgorithmColor::get_color" ref="gab1205781ba628ca806c47a51f40f5f6" args="(ColorBase &amp;cb, Color=Color())" -->
  74 template&lt;typename ColorBase, typename Color&gt; </td></tr>
  75 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">color_element_reference_type<br>
  76 &lt; ColorBase, Color &gt;::type&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="g_i_l_0106.html#gab1205781ba628ca806c47a51f40f5f6">get_color</a> (ColorBase &amp;cb, Color=Color())</td></tr>
  77
  78 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mutable accessor to the element associated with a given color name. <br></td></tr>
  79 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="g4b9fe0ec8239047ac50842800de872b9"></a><!-- doxytag: member="ColorBaseAlgorithmColor::get_color" ref="g4b9fe0ec8239047ac50842800de872b9" args="(const ColorBase &amp;cb, Color=Color())" -->
  80 template&lt;typename ColorBase, typename Color&gt; </td></tr>
  81 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">color_element_const_reference_type<br>
  82 &lt; ColorBase, Color &gt;::type&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="g_i_l_0106.html#g4b9fe0ec8239047ac50842800de872b9">get_color</a> (const ColorBase &amp;cb, Color=Color())</td></tr>
  83
  84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constant accessor to the element associated with a given color name. <br></td></tr>
  85 </table>
  86 </div>
  87 <hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:17 2009 for Generic Image Library by&nbsp;
  88 <a href="http://www.doxygen.org/index.html">
  89 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
  90 </body>
  91 </html>