1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495 |
- <!-- HTML header for doxygen 1.8.13-->
- <!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">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.15"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Generic Image Library: color_element_type, color_element_reference_type, color_element_const_reference_type, get_color, contains_color</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div class="boost-header">
- <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
- <tr>
- <td valign="top" width="300">
- <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
- </td>
- <td ><h1 align="center"><a href="../index.html"></a></h1></td>
- <td></td>
- </tr>
- </table>
- </div>
- <hr/>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <!-- Generated by Doxygen 1.8.15 -->
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',false,false,'search.php','Search');
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Classes</a> |
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">color_element_type, color_element_reference_type, color_element_const_reference_type, get_color, contains_color<div class="ingroups"><a class="el" href="group___color_base.html">ColorBase</a> » <a class="el" href="group___color_base_algorithm.html">Algorithms and Utility Functions</a></div></div> </div>
- </div><!--header-->
- <div class="contents">
- <p>get_color: Named channel accessors
- <a href="#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
- Classes</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1contains__color.html">contains_color< ColorBase, Color ></a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A predicate metafunction determining whether a given color base contains a given color. <a href="structboost_1_1gil_1_1contains__color.html#details">More...</a><br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1color__element__type.html">color_element_type< ColorBase, Color ></a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the type of the element associated with a given color tag. <a href="structboost_1_1gil_1_1color__element__type.html#details">More...</a><br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1color__element__reference__type.html">color_element_reference_type< ColorBase, Color ></a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the return type of the mutable element accessor by color name, get_color(color_base, Color());. <a href="structboost_1_1gil_1_1color__element__reference__type.html#details">More...</a><br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1color__element__const__reference__type.html">color_element_const_reference_type< ColorBase, Color ></a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the return type of the constant element accessor by color name, get_color(color_base, Color());. <a href="structboost_1_1gil_1_1color__element__const__reference__type.html#details">More...</a><br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:gab2d1dda637cb2b7c32cc87f199ea1dc0"><td class="memTemplParams" colspan="2"><a id="gab2d1dda637cb2b7c32cc87f199ea1dc0"></a>
- template<typename ColorBase , typename Color > </td></tr>
- <tr class="memitem:gab2d1dda637cb2b7c32cc87f199ea1dc0"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1gil_1_1color__element__reference__type.html">color_element_reference_type</a>< ColorBase, Color >::type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___color_base_algorithm_color.html#gab2d1dda637cb2b7c32cc87f199ea1dc0">get_color</a> (ColorBase &cb, Color=Color())</td></tr>
- <tr class="memdesc:gab2d1dda637cb2b7c32cc87f199ea1dc0"><td class="mdescLeft"> </td><td class="mdescRight">Mutable accessor to the element associated with a given color name. <br /></td></tr>
- <tr class="separator:gab2d1dda637cb2b7c32cc87f199ea1dc0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga3f358408ca48aa4ac1c869044ca60e7c"><td class="memTemplParams" colspan="2"><a id="ga3f358408ca48aa4ac1c869044ca60e7c"></a>
- template<typename ColorBase , typename Color > </td></tr>
- <tr class="memitem:ga3f358408ca48aa4ac1c869044ca60e7c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1gil_1_1color__element__const__reference__type.html">color_element_const_reference_type</a>< ColorBase, Color >::type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___color_base_algorithm_color.html#ga3f358408ca48aa4ac1c869044ca60e7c">get_color</a> (const ColorBase &cb, Color=Color())</td></tr>
- <tr class="memdesc:ga3f358408ca48aa4ac1c869044ca60e7c"><td class="mdescLeft"> </td><td class="mdescRight">Constant accessor to the element associated with a given color name. <br /></td></tr>
- <tr class="separator:ga3f358408ca48aa4ac1c869044ca60e7c"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>get_color: Named channel accessors </p>
- <p>Support for accessing the elements of a color base by color name</p>
- <p>Example: A function that takes a generic pixel containing a red channel and sets it to 100%:</p>
- <div class="fragment"><div class="line"><span class="keyword">template</span> <<span class="keyword">typename</span> Pixel></div><div class="line"><span class="keywordtype">void</span> set_red_to_max(Pixel& pixel) {</div><div class="line"> boost::function_requires<MutablePixelConcept<Pixel> >();</div><div class="line"> static_assert(contains_color<Pixel, red_t>::value, <span class="stringliteral">""</span>);</div><div class="line"></div><div class="line"> <span class="keyword">using</span> red_channel_t = <span class="keyword">typename</span> color_element_type<Pixel, red_t>::type;</div><div class="line"> <a class="code" href="group___color_base_algorithm_color.html#gab2d1dda637cb2b7c32cc87f199ea1dc0">get_color</a>(pixel, red_t()) = channel_traits<red_channel_t>::max_value();</div><div class="line">}</div></div><!-- fragment --> </div><!-- contents -->
- <!-- HTML footer for doxygen 1.8.13-->
- <!-- start footer part -->
- <hr class="footer"/>
- <address class="footer">
- <small>
- Generated by  <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
- </small>
- </address>
- </body>
- </html>
|