mirror of
https://github.com/boostorg/gil.git
synced 2026-01-24 18:02:17 +00:00
100 lines
8.7 KiB
HTML
100 lines
8.7 KiB
HTML
<!-- 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.6"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Generic Image Library: packed_channel_reference</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.6 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</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">packed_channel_reference<div class="ingroups"><a class="el" href="group___channel_model.html">Models</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Represents a reference proxy to a channel operating over a bit range whose offset is fixed at compile 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> Example:
|
|
<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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1packed__channel__reference_3_01_bit_field_00_01_first_bit_00_01_num_bits_00_01false_01_4.html">packed_channel_reference< BitField, FirstBit, NumBits, false ></a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A constant subbyte channel reference whose bit offset is fixed at compile 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>. <a href="classboost_1_1gil_1_1packed__channel__reference_3_01_bit_field_00_01_first_bit_00_01_num_bits_00_01false_01_4.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1packed__channel__reference_3_01_bit_field_00_01_first_bit_00_01_num_bits_00_01true_01_4.html">packed_channel_reference< BitField, FirstBit, NumBits, true ></a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A mutable subbyte channel reference whose bit offset is fixed at compile 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>. <a href="classboost_1_1gil_1_1packed__channel__reference_3_01_bit_field_00_01_first_bit_00_01_num_bits_00_01true_01_4.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:gaa0bd7927a859ab0e44df1df898b68e7c"><td class="memTemplParams" colspan="2"><a class="anchor" id="gaa0bd7927a859ab0e44df1df898b68e7c"></a>
|
|
template<typename BF , int FB, int NB, bool M, typename R > </td></tr>
|
|
<tr class="memitem:gaa0bd7927a859ab0e44df1df898b68e7c"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_reference_model.html#gaa0bd7927a859ab0e44df1df898b68e7c">swap</a> (const boost::gil::packed_channel_reference< BF, FB, NB, M > x, R &y)</td></tr>
|
|
<tr class="memdesc:gaa0bd7927a859ab0e44df1df898b68e7c"><td class="mdescLeft"> </td><td class="mdescRight">swap for packed_channel_reference <br/></td></tr>
|
|
<tr class="separator:gaa0bd7927a859ab0e44df1df898b68e7c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaad704056496a9a216609ebde22497e5f"><td class="memTemplParams" colspan="2"><a class="anchor" id="gaad704056496a9a216609ebde22497e5f"></a>
|
|
template<typename BF , int FB, int NB, bool M> </td></tr>
|
|
<tr class="memitem:gaad704056496a9a216609ebde22497e5f"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_reference_model.html#gaad704056496a9a216609ebde22497e5f">swap</a> (typename boost::gil::packed_channel_reference< BF, FB, NB, M >::value_type &x, const boost::gil::packed_channel_reference< BF, FB, NB, M > y)</td></tr>
|
|
<tr class="memdesc:gaad704056496a9a216609ebde22497e5f"><td class="mdescLeft"> </td><td class="mdescRight">swap for packed_channel_reference <br/></td></tr>
|
|
<tr class="separator:gaad704056496a9a216609ebde22497e5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8dd3a59fa9f04ce822b13f268f8a1ed4"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga8dd3a59fa9f04ce822b13f268f8a1ed4"></a>
|
|
template<typename BF , int FB, int NB, bool M> </td></tr>
|
|
<tr class="memitem:ga8dd3a59fa9f04ce822b13f268f8a1ed4"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_reference_model.html#ga8dd3a59fa9f04ce822b13f268f8a1ed4">swap</a> (const boost::gil::packed_channel_reference< BF, FB, NB, M > x, const boost::gil::packed_channel_reference< BF, FB, NB, M > y)</td></tr>
|
|
<tr class="memdesc:ga8dd3a59fa9f04ce822b13f268f8a1ed4"><td class="mdescLeft"> </td><td class="mdescRight">swap for packed_channel_reference <br/></td></tr>
|
|
<tr class="separator:ga8dd3a59fa9f04ce822b13f268f8a1ed4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Represents a reference proxy to a channel operating over a bit range whose offset is fixed at compile 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> Example: </p>
|
|
<div class="fragment"><div class="line"><span class="comment">// Reference to a 2-bit channel starting at bit 1 (i.e. the second bit)</span></div>
|
|
<div class="line"><span class="keyword">typedef</span> <span class="keyword">const</span> packed_channel_reference<uint16_t,1,2,true> bits2_1_ref_t;</div>
|
|
<div class="line"></div>
|
|
<div class="line">uint16_t data=0;</div>
|
|
<div class="line">bits2_1_ref_t channel_ref(&data);</div>
|
|
<div class="line">channel_ref = channel_traits<bits2_1_ref_t>::max_value(); <span class="comment">// == 3</span></div>
|
|
<div class="line">assert(data == 6); <span class="comment">// == 3<<1 == 6</span></div>
|
|
</div><!-- fragment --> </div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.13-->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/>
|
|
<address class="footer">
|
|
<small>
|
|
Generated on Wed Apr 25 2018 20:27:26 for Generic Image Library by  <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.6
|
|
</small>
|
|
</address>
|
|
</body>
|
|
</html>
|