2
0
mirror of https://github.com/boostorg/gil.git synced 2026-02-10 23:42:13 +00:00
Files
gil/html/reference/group___packed_channel_dynamic_reference_model.html
github-actions[bot] 08908035e5 deploy: c1c0a33e38
2025-11-19 13:36:05 +00:00

100 lines
8.9 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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Generic Image Library: packed_dynamic_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.9.8 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><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>
</div><!--header-->
<div class="contents">
<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>.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga819b2b48ceacea523b2d9188ad2e2f11" id="r_ga819b2b48ceacea523b2d9188ad2e2f11"><td class="memTemplParams" colspan="2"><a id="ga819b2b48ceacea523b2d9188ad2e2f11" name="ga819b2b48ceacea523b2d9188ad2e2f11"></a>
template&lt;typename BF , int NB, bool M, typename R &gt; </td></tr>
<tr class="memitem:ga819b2b48ceacea523b2d9188ad2e2f11"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>swap</b> (const boost::gil::packed_dynamic_channel_reference&lt; BF, NB, M &gt; x, R &amp;y)</td></tr>
<tr class="memdesc:ga819b2b48ceacea523b2d9188ad2e2f11"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_dynamic_channel_reference <br /></td></tr>
<tr class="separator:ga819b2b48ceacea523b2d9188ad2e2f11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga272f55c1c65415235aae51f8dbba5ccb" id="r_ga272f55c1c65415235aae51f8dbba5ccb"><td class="memTemplParams" colspan="2"><a id="ga272f55c1c65415235aae51f8dbba5ccb" name="ga272f55c1c65415235aae51f8dbba5ccb"></a>
template&lt;typename BF , int NB, bool M&gt; </td></tr>
<tr class="memitem:ga272f55c1c65415235aae51f8dbba5ccb"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>swap</b> (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>
<tr class="memdesc:ga272f55c1c65415235aae51f8dbba5ccb"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_dynamic_channel_reference <br /></td></tr>
<tr class="separator:ga272f55c1c65415235aae51f8dbba5ccb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31471d00682051688ae336bdf3cd431f" id="r_ga31471d00682051688ae336bdf3cd431f"><td class="memTemplParams" colspan="2"><a id="ga31471d00682051688ae336bdf3cd431f" name="ga31471d00682051688ae336bdf3cd431f"></a>
template&lt;typename BF , int NB, bool M&gt; </td></tr>
<tr class="memitem:ga31471d00682051688ae336bdf3cd431f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>swap</b> (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>
<tr class="memdesc:ga31471d00682051688ae336bdf3cd431f"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_dynamic_channel_reference <br /></td></tr>
<tr class="separator:ga31471d00682051688ae336bdf3cd431f"><td class="memSeparator" colspan="2">&#160;</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 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>
<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 -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<hr class="footer"/>
<address class="footer">
<small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.9.8
</small>
</address>
</body>
</html>