group___packed_channel_dynamic_reference_model.html 8.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  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: packed_dynamic_channel_reference</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">packed_dynamic_channel_reference<div class="ingroups"><a class="el" href="group___channel.html">Channel</a> &raquo; <a class="el" href="group___channel_model.html">Models</a></div></div> </div>
  47. </div><!--header-->
  48. <div class="contents">
  49. <p>Represents a reference proxy to a channel operating over a bit range whose offset is specified at run time. Models <a class="el" href="structboost_1_1gil_1_1_channel_concept.html" title="A channel is the building block of a color. Color is defined as a mixture of primary colors and a cha...">ChannelConcept</a>.
  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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1packed__dynamic__channel__reference_3_01_bit_field_00_01_num_bits_00_01false_01_4.html">packed_dynamic_channel_reference&lt; BitField, NumBits, false &gt;</a></td></tr>
  55. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Models a constant subbyte channel reference whose bit offset is a runtime parameter. Models <a class="el" href="structboost_1_1gil_1_1_channel_concept.html" title="A channel is the building block of a color. Color is defined as a mixture of primary colors and a cha...">ChannelConcept</a> Same as packed_channel_reference, except that the offset is a runtime parameter. <a href="classboost_1_1gil_1_1packed__dynamic__channel__reference_3_01_bit_field_00_01_num_bits_00_01false_01_4.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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1packed__dynamic__channel__reference_3_01_bit_field_00_01_num_bits_00_01true_01_4.html">packed_dynamic_channel_reference&lt; BitField, NumBits, true &gt;</a></td></tr>
  58. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Models a mutable subbyte channel reference whose bit offset is a runtime parameter. Models <a class="el" href="structboost_1_1gil_1_1_channel_concept.html" title="A channel is the building block of a color. Color is defined as a mixture of primary colors and a cha...">ChannelConcept</a> Same as packed_channel_reference, except that the offset is a runtime parameter. <a href="classboost_1_1gil_1_1packed__dynamic__channel__reference_3_01_bit_field_00_01_num_bits_00_01true_01_4.html#details">More...</a><br /></td></tr>
  59. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. </table><table class="memberdecls">
  61. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  62. Functions</h2></td></tr>
  63. <tr class="memitem:ga787db0870b8b34244289b895ed8345e2"><td class="memTemplParams" colspan="2"><a id="ga787db0870b8b34244289b895ed8345e2"></a>
  64. template&lt;typename BF , int NB, bool M, typename R &gt; </td></tr>
  65. <tr class="memitem:ga787db0870b8b34244289b895ed8345e2"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_dynamic_reference_model.html#ga787db0870b8b34244289b895ed8345e2">swap</a> (const boost::gil::packed_dynamic_channel_reference&lt; BF, NB, M &gt; x, R &amp;y)</td></tr>
  66. <tr class="memdesc:ga787db0870b8b34244289b895ed8345e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_dynamic_channel_reference <br /></td></tr>
  67. <tr class="separator:ga787db0870b8b34244289b895ed8345e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:gab7ea281b0cce57c44a9046f732e4112b"><td class="memTemplParams" colspan="2"><a id="gab7ea281b0cce57c44a9046f732e4112b"></a>
  69. template&lt;typename BF , int NB, bool M&gt; </td></tr>
  70. <tr class="memitem:gab7ea281b0cce57c44a9046f732e4112b"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_dynamic_reference_model.html#gab7ea281b0cce57c44a9046f732e4112b">swap</a> (typename boost::gil::packed_dynamic_channel_reference&lt; BF, NB, M &gt;::value_type &amp;x, const boost::gil::packed_dynamic_channel_reference&lt; BF, NB, M &gt; y)</td></tr>
  71. <tr class="memdesc:gab7ea281b0cce57c44a9046f732e4112b"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_dynamic_channel_reference <br /></td></tr>
  72. <tr class="separator:gab7ea281b0cce57c44a9046f732e4112b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:gac4c1b188cdeb2280d9c803726e4d2cdc"><td class="memTemplParams" colspan="2"><a id="gac4c1b188cdeb2280d9c803726e4d2cdc"></a>
  74. template&lt;typename BF , int NB, bool M&gt; </td></tr>
  75. <tr class="memitem:gac4c1b188cdeb2280d9c803726e4d2cdc"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_dynamic_reference_model.html#gac4c1b188cdeb2280d9c803726e4d2cdc">swap</a> (const boost::gil::packed_dynamic_channel_reference&lt; BF, NB, M &gt; x, const boost::gil::packed_dynamic_channel_reference&lt; BF, NB, M &gt; y)</td></tr>
  76. <tr class="memdesc:gac4c1b188cdeb2280d9c803726e4d2cdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_dynamic_channel_reference <br /></td></tr>
  77. <tr class="separator:gac4c1b188cdeb2280d9c803726e4d2cdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. </table>
  79. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  80. <p>Represents a reference proxy to a channel operating over a bit range whose offset is specified at run time. Models <a class="el" href="structboost_1_1gil_1_1_channel_concept.html" title="A channel is the building block of a color. Color is defined as a mixture of primary colors and a cha...">ChannelConcept</a>. </p>
  81. <p>Example: </p><div class="fragment"><div class="line"><span class="comment">// Reference to a 2-bit channel whose offset is specified at construction time</span></div><div class="line"><span class="keyword">using</span> bits2_dynamic_ref_t = packed_dynamic_channel_reference&lt;uint8_t,2,true&gt; <span class="keyword">const</span>;</div><div class="line"></div><div class="line">uint16_t data=0;</div><div class="line">bits2_dynamic_ref_t channel_ref(&amp;data,1);</div><div class="line">channel_ref = channel_traits&lt;bits2_dynamic_ref_t&gt;::max_value(); <span class="comment">// == 3</span></div><div class="line">assert(data == 6); <span class="comment">// == (3&lt;&lt;1) == 6</span></div></div><!-- fragment --> </div><!-- contents -->
  82. <!-- HTML footer for doxygen 1.8.13-->
  83. <!-- start footer part -->
  84. <hr class="footer"/>
  85. <address class="footer">
  86. <small>
  87. Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  88. </small>
  89. </address>
  90. </body>
  91. </html>