Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / gil / doc / html / reference / classboost_1_1gil_1_1packed__dynamic__channel__reference_3_01_bit_field_00_01_num_bits_00_01true_01_4.html
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&lt; BitField, NumBits, true &gt; Class Template 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 id="nav-path" class="navpath">
41   <ul>
42 <li class="navelem"><b>boost</b></li><li class="navelem"><b>gil</b></li><li class="navelem"><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></li>  </ul>
43 </div>
44 </div><!-- top -->
45 <div class="header">
46   <div class="summary">
47 <a href="#pub-types">Public Types</a> &#124;
48 <a href="#pub-methods">Public Member Functions</a> &#124;
49 <a href="#friends">Friends</a> &#124;
50 <a href="classboost_1_1gil_1_1packed__dynamic__channel__reference_3_01_bit_field_00_01_num_bits_00_01true_01_4-members.html">List of all members</a>  </div>
51   <div class="headertitle">
52 <div class="title">packed_dynamic_channel_reference&lt; BitField, NumBits, true &gt; Class Template Reference<div class="ingroups"><a class="el" href="group___channel.html">Channel</a> &raquo; <a class="el" href="group___channel_model.html">Models</a> &raquo; <a class="el" href="group___packed_channel_dynamic_reference_model.html">packed_dynamic_channel_reference</a></div></div>  </div>
53 </div><!--header-->
54 <div class="contents">
55
56 <p>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.  
57  <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></p>
58
59 <p><code>#include &lt;<a class="el" href="channel_8hpp_source.html">channel.hpp</a>&gt;</code></p>
60
61 <p>Inherits packed_channel_reference_base&lt; packed_dynamic_channel_reference&lt; BitField, NumBits, true &gt;, BitField, NumBits, true &gt;.</p>
62 <table class="memberdecls">
63 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
64 Public Types</h2></td></tr>
65 <tr class="memitem:a7eec9eb32d387cdbb8f867adf290af9e"><td class="memItemLeft" align="right" valign="top"><a id="a7eec9eb32d387cdbb8f867adf290af9e"></a>
66 using&#160;</td><td class="memItemRight" valign="bottom"><b>const_reference</b> = packed_dynamic_channel_reference&lt; BitField, NumBits, false &gt; const</td></tr>
67 <tr class="separator:a7eec9eb32d387cdbb8f867adf290af9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
68 <tr class="memitem:a959468ff7fe89627eb9e28a08bb4a742"><td class="memItemLeft" align="right" valign="top"><a id="a959468ff7fe89627eb9e28a08bb4a742"></a>
69 using&#160;</td><td class="memItemRight" valign="bottom"><b>mutable_reference</b> = packed_dynamic_channel_reference&lt; BitField, NumBits, true &gt; const</td></tr>
70 <tr class="separator:a959468ff7fe89627eb9e28a08bb4a742"><td class="memSeparator" colspan="2">&#160;</td></tr>
71 <tr class="memitem:afc257779d294685f169034a94cc6d1b4"><td class="memItemLeft" align="right" valign="top"><a id="afc257779d294685f169034a94cc6d1b4"></a>
72 using&#160;</td><td class="memItemRight" valign="bottom"><b>integer_t</b> = typename parent_t::integer_t</td></tr>
73 <tr class="separator:afc257779d294685f169034a94cc6d1b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
74 </table><table class="memberdecls">
75 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
76 Public Member Functions</h2></td></tr>
77 <tr class="memitem:a0713bf1f9f7010be538a791a0dc24eec"><td class="memItemLeft" align="right" valign="top"><a id="a0713bf1f9f7010be538a791a0dc24eec"></a>
78 &#160;</td><td class="memItemRight" valign="bottom"><b>packed_dynamic_channel_reference</b> (void *data_ptr, unsigned first_bit)</td></tr>
79 <tr class="separator:a0713bf1f9f7010be538a791a0dc24eec"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:a4f683735092b7c064934aab28e6e0e17"><td class="memItemLeft" align="right" valign="top"><a id="a4f683735092b7c064934aab28e6e0e17"></a>
81 &#160;</td><td class="memItemRight" valign="bottom"><b>packed_dynamic_channel_reference</b> (const packed_dynamic_channel_reference &amp;ref)</td></tr>
82 <tr class="separator:a4f683735092b7c064934aab28e6e0e17"><td class="memSeparator" colspan="2">&#160;</td></tr>
83 <tr class="memitem:a0cced48fdb85d550b3f0fd61ac0abc8f"><td class="memItemLeft" align="right" valign="top"><a id="a0cced48fdb85d550b3f0fd61ac0abc8f"></a>
84 packed_dynamic_channel_reference const  &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (integer_t value) const</td></tr>
85 <tr class="separator:a0cced48fdb85d550b3f0fd61ac0abc8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:a1e726fb56448c6922f7bedd76aa799f5"><td class="memItemLeft" align="right" valign="top"><a id="a1e726fb56448c6922f7bedd76aa799f5"></a>
87 const packed_dynamic_channel_reference &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const mutable_reference &amp;ref) const</td></tr>
88 <tr class="separator:a1e726fb56448c6922f7bedd76aa799f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 <tr class="memitem:a20b551c375fe9a1fe2d465e13a0a7ffa"><td class="memItemLeft" align="right" valign="top"><a id="a20b551c375fe9a1fe2d465e13a0a7ffa"></a>
90 const packed_dynamic_channel_reference &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const const_reference &amp;ref) const</td></tr>
91 <tr class="separator:a20b551c375fe9a1fe2d465e13a0a7ffa"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:ab64113ce18c0302b900e4f3e65e18e12"><td class="memTemplParams" colspan="2"><a id="ab64113ce18c0302b900e4f3e65e18e12"></a>
93 template&lt;typename BitField1 , int FirstBit1, bool Mutable1&gt; </td></tr>
94 <tr class="memitem:ab64113ce18c0302b900e4f3e65e18e12"><td class="memTemplItemLeft" align="right" valign="top">const packed_dynamic_channel_reference &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (const packed_channel_reference&lt; BitField1, FirstBit1, NumBits, Mutable1 &gt; &amp;ref) const</td></tr>
95 <tr class="separator:ab64113ce18c0302b900e4f3e65e18e12"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:ae65449d818a8f883c42d1cc560896719"><td class="memItemLeft" align="right" valign="top"><a id="ae65449d818a8f883c42d1cc560896719"></a>
97 unsigned&#160;</td><td class="memItemRight" valign="bottom"><b>first_bit</b> () const</td></tr>
98 <tr class="separator:ae65449d818a8f883c42d1cc560896719"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 <tr class="memitem:a92ab8f5426e0b0a6ab643804e2ea4979"><td class="memItemLeft" align="right" valign="top"><a id="a92ab8f5426e0b0a6ab643804e2ea4979"></a>
100 integer_t&#160;</td><td class="memItemRight" valign="bottom"><b>get</b> () const</td></tr>
101 <tr class="separator:a92ab8f5426e0b0a6ab643804e2ea4979"><td class="memSeparator" colspan="2">&#160;</td></tr>
102 <tr class="memitem:a3a11fa93e9a408307863a442879e445f"><td class="memItemLeft" align="right" valign="top"><a id="a3a11fa93e9a408307863a442879e445f"></a>
103 void&#160;</td><td class="memItemRight" valign="bottom"><b>set_unsafe</b> (integer_t value) const</td></tr>
104 <tr class="separator:a3a11fa93e9a408307863a442879e445f"><td class="memSeparator" colspan="2">&#160;</td></tr>
105 </table><table class="memberdecls">
106 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
107 Friends</h2></td></tr>
108 <tr class="memitem:abb8649e8c09150f1f64a4460f8390a2e"><td class="memItemLeft" align="right" valign="top"><a id="abb8649e8c09150f1f64a4460f8390a2e"></a>
109 class&#160;</td><td class="memItemRight" valign="bottom"><b>packed_dynamic_channel_reference&lt; BitField, NumBits, false &gt;</b></td></tr>
110 <tr class="separator:abb8649e8c09150f1f64a4460f8390a2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
111 </table>
112 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
113 <div class="textblock"><h3>template&lt;typename BitField, int NumBits&gt;<br />
114 class boost::gil::packed_dynamic_channel_reference&lt; BitField, NumBits, true &gt;</h3>
115
116 <p>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. </p>
117 </div><hr/>The documentation for this class was generated from the following file:<ul>
118 <li><a class="el" href="channel_8hpp_source.html">channel.hpp</a></li>
119 </ul>
120 </div><!-- contents -->
121      <!-- HTML footer for doxygen 1.8.13-->
122      <!-- start footer part -->
123      <hr class="footer"/>
124      <address class="footer">
125       <small>
126         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
127       </small>
128     </address>
129   </body>
130 </html>