group___color_base_algorithm_color.html 8.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. <!-- HTML header for doxygen 1.8.13-->
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  6. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  7. <meta name="generator" content="Doxygen 1.8.15"/>
  8. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  9. <title>Generic Image Library: color_element_type, color_element_reference_type, color_element_const_reference_type, get_color, contains_color</title>
  10. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11. <script type="text/javascript" src="jquery.js"></script>
  12. <script type="text/javascript" src="dynsections.js"></script>
  13. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  14. <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
  15. </head>
  16. <body>
  17. <div class="boost-header">
  18. <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
  19. <tr>
  20. <td valign="top" width="300">
  21. <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
  22. </td>
  23. <td ><h1 align="center"><a href="../index.html"></a></h1></td>
  24. <td></td>
  25. </tr>
  26. </table>
  27. </div>
  28. <hr/>
  29. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  30. <!-- Generated by Doxygen 1.8.15 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */</script>
  39. <div id="main-nav"></div>
  40. </div><!-- top -->
  41. <div class="header">
  42. <div class="summary">
  43. <a href="#nested-classes">Classes</a> &#124;
  44. <a href="#func-members">Functions</a> </div>
  45. <div class="headertitle">
  46. <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> &raquo; <a class="el" href="group___color_base_algorithm.html">Algorithms and Utility Functions</a></div></div> </div>
  47. </div><!--header-->
  48. <div class="contents">
  49. <p>get_color: Named channel accessors
  50. <a href="#details">More...</a></p>
  51. <table class="memberdecls">
  52. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  53. Classes</h2></td></tr>
  54. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1contains__color.html">contains_color&lt; ColorBase, Color &gt;</a></td></tr>
  55. <tr class="memdesc:"><td class="mdescLeft">&#160;</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>
  56. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1color__element__type.html">color_element_type&lt; ColorBase, Color &gt;</a></td></tr>
  58. <tr class="memdesc:"><td class="mdescLeft">&#160;</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>
  59. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1color__element__reference__type.html">color_element_reference_type&lt; ColorBase, Color &gt;</a></td></tr>
  61. <tr class="memdesc:"><td class="mdescLeft">&#160;</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>
  62. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</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&lt; ColorBase, Color &gt;</a></td></tr>
  64. <tr class="memdesc:"><td class="mdescLeft">&#160;</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>
  65. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. </table><table class="memberdecls">
  67. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  68. Functions</h2></td></tr>
  69. <tr class="memitem:gab2d1dda637cb2b7c32cc87f199ea1dc0"><td class="memTemplParams" colspan="2"><a id="gab2d1dda637cb2b7c32cc87f199ea1dc0"></a>
  70. template&lt;typename ColorBase , typename Color &gt; </td></tr>
  71. <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>&lt; ColorBase, Color &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___color_base_algorithm_color.html#gab2d1dda637cb2b7c32cc87f199ea1dc0">get_color</a> (ColorBase &amp;cb, Color=Color())</td></tr>
  72. <tr class="memdesc:gab2d1dda637cb2b7c32cc87f199ea1dc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mutable accessor to the element associated with a given color name. <br /></td></tr>
  73. <tr class="separator:gab2d1dda637cb2b7c32cc87f199ea1dc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ga3f358408ca48aa4ac1c869044ca60e7c"><td class="memTemplParams" colspan="2"><a id="ga3f358408ca48aa4ac1c869044ca60e7c"></a>
  75. template&lt;typename ColorBase , typename Color &gt; </td></tr>
  76. <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>&lt; ColorBase, Color &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___color_base_algorithm_color.html#ga3f358408ca48aa4ac1c869044ca60e7c">get_color</a> (const ColorBase &amp;cb, Color=Color())</td></tr>
  77. <tr class="memdesc:ga3f358408ca48aa4ac1c869044ca60e7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constant accessor to the element associated with a given color name. <br /></td></tr>
  78. <tr class="separator:ga3f358408ca48aa4ac1c869044ca60e7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. </table>
  80. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  81. <p>get_color: Named channel accessors </p>
  82. <p>Support for accessing the elements of a color base by color name</p>
  83. <p>Example: A function that takes a generic pixel containing a red channel and sets it to 100%:</p>
  84. <div class="fragment"><div class="line"><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Pixel&gt;</div><div class="line"><span class="keywordtype">void</span> set_red_to_max(Pixel&amp; pixel) {</div><div class="line"> boost::function_requires&lt;MutablePixelConcept&lt;Pixel&gt; &gt;();</div><div class="line"> static_assert(contains_color&lt;Pixel, red_t&gt;::value, <span class="stringliteral">&quot;&quot;</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&lt;Pixel, red_t&gt;::type;</div><div class="line"> <a class="code" href="group___color_base_algorithm_color.html#gab2d1dda637cb2b7c32cc87f199ea1dc0">get_color</a>(pixel, red_t()) = channel_traits&lt;red_channel_t&gt;::max_value();</div><div class="line">}</div></div><!-- fragment --> </div><!-- contents -->
  85. <!-- HTML footer for doxygen 1.8.13-->
  86. <!-- start footer part -->
  87. <hr class="footer"/>
  88. <address class="footer">
  89. <small>
  90. Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  91. </small>
  92. </address>
  93. </body>
  94. </html>