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">
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: channel_multiply</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"/>
17 <div class="boost-header">
18 <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
20 <td valign="top" width="300">
21 <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
23 <td ><h1 align="center"><a href="../index.html"></a></h1></td>
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&dn=gpl-2.0.txt GPL-v2 */
36 initMenu('',false,false,'search.php','Search');
38 /* @license-end */</script>
39 <div id="main-nav"></div>
43 <a href="#nested-classes">Classes</a> |
44 <a href="#func-members">Functions</a> </div>
45 <div class="headertitle">
46 <div class="title">channel_multiply<div class="ingroups"><a class="el" href="group___channel.html">Channel</a> » <a class="el" href="group___channel_algorithm.html">Algorithms and Utility Functions</a></div></div> </div>
48 <div class="contents">
50 <p>Multiplying unsigned channel values of the same type. Performs scaled multiplication result = a * b / max_value.
51 <a href="#details">More...</a></p>
52 <table class="memberdecls">
53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
54 Classes</h2></td></tr>
55 <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_1channel__multiplier__unsigned.html">channel_multiplier_unsigned< ChannelValue ></a></td></tr>
56 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This is the default implementation. Performance specializatons are provided. <a href="structboost_1_1gil_1_1channel__multiplier__unsigned.html#details">More...</a><br /></td></tr>
57 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
58 <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_1channel__multiplier__unsigned_3_01uint8__t_01_4.html">channel_multiplier_unsigned< uint8_t ></a></td></tr>
59 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Specialization of channel_multiply for 8-bit unsigned channels. <a href="structboost_1_1gil_1_1channel__multiplier__unsigned_3_01uint8__t_01_4.html#details">More...</a><br /></td></tr>
60 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
61 <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_1channel__multiplier__unsigned_3_01uint16__t_01_4.html">channel_multiplier_unsigned< uint16_t ></a></td></tr>
62 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Specialization of channel_multiply for 16-bit unsigned channels. <a href="structboost_1_1gil_1_1channel__multiplier__unsigned_3_01uint16__t_01_4.html#details">More...</a><br /></td></tr>
63 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
64 <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_1channel__multiplier__unsigned_3_01float32__t_01_4.html">channel_multiplier_unsigned< float32_t ></a></td></tr>
65 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Specialization of channel_multiply for float 0..1 channels. <a href="structboost_1_1gil_1_1channel__multiplier__unsigned_3_01float32__t_01_4.html#details">More...</a><br /></td></tr>
66 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
67 <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_1channel__multiplier.html">channel_multiplier< ChannelValue ></a></td></tr>
68 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A function object to multiply two channels. result = a * b / max_value. <a href="structboost_1_1gil_1_1channel__multiplier.html#details">More...</a><br /></td></tr>
69 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
70 </table><table class="memberdecls">
71 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
72 Functions</h2></td></tr>
73 <tr class="memitem:ga0af81efbbb77846afe2570f242d2b974"><td class="memTemplParams" colspan="2"><a id="ga0af81efbbb77846afe2570f242d2b974"></a>
74 template<typename Channel > </td></tr>
75 <tr class="memitem:ga0af81efbbb77846afe2570f242d2b974"><td class="memTemplItemLeft" align="right" valign="top">channel_traits< Channel >::value_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___channel_multiply_algorithm.html#ga0af81efbbb77846afe2570f242d2b974">channel_multiply</a> (Channel a, Channel b)</td></tr>
76 <tr class="memdesc:ga0af81efbbb77846afe2570f242d2b974"><td class="mdescLeft"> </td><td class="mdescRight">A function multiplying two channels. result = a * b / max_value. <br /></td></tr>
77 <tr class="separator:ga0af81efbbb77846afe2570f242d2b974"><td class="memSeparator" colspan="2"> </td></tr>
79 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
80 <p>Multiplying unsigned channel values of the same type. Performs scaled multiplication result = a * b / max_value. </p>
81 <p>Example: </p><div class="fragment"><div class="line">uint8_t x=128;</div><div class="line">uint8_t y=128;</div><div class="line">uint8_t mul = <a class="code" href="group___channel_multiply_algorithm.html#ga0af81efbbb77846afe2570f242d2b974">channel_multiply</a>(x,y);</div><div class="line">assert(mul == 64); <span class="comment">// 64 = 128 * 128 / 255</span></div></div><!-- fragment --> </div><!-- contents -->
82 <!-- HTML footer for doxygen 1.8.13-->
83 <!-- start footer part -->
85 <address class="footer">
87 Generated by  <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15