2
0
mirror of https://github.com/boostorg/gil.git synced 2026-01-25 06:12:22 +00:00
Files
gil/develop/doc/html/reference/group___packed_channel_reference_model.html

106 lines
8.9 KiB
HTML

<!-- Copyright 2008 Lubomir Bourdev and Hailin Jin
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
-->
<!--
Copyright 2005-2007 Adobe Systems Incorporated
Distributed under the MIT License (see accompanying file LICENSE_1_0_0.txt
or a copy at http://stlab.adobe.com/licenses.html)
Some files are held under additional license.
Please see "http://stlab.adobe.com/licenses.html" for more information.
-->
<!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" lang="en" xml:lang="en">
<head>
<TITLE>packed_channel_reference</TITLE>
<META HTTP-EQUIV="content-type" CONTENT="text/html;charset=ISO-8859-1"/>
<link type="text/css" rel="stylesheet" href="../_static/style.css">
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
</head>
<body>
<div class="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/>
<table border="0" cellspacing="0" cellpadding="0" style='width: 100%; margin: 0; padding: 0'><tr>
<td width="100%" valign="top" style='padding-left: 10px; padding-right: 10px; padding-bottom: 10px'>
<div class="qindex"><a class="qindex" href="index.html">Modules</a>
| <a class="qindex" href="classes.html">Alphabetical List</a>
| <a class="qindex" href="annotated.html">Class List</a>
</div>
<!-- End Header -->
<!-- Generated by Doxygen 1.8.6 -->
</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_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 &#160;</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&lt; BitField, FirstBit, NumBits, false &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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">&#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__channel__reference_3_01_bit_field_00_01_first_bit_00_01_num_bits_00_01true_01_4.html">packed_channel_reference&lt; BitField, FirstBit, NumBits, true &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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">&#160;</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&lt;typename BF , int FB, int NB, bool M, typename R &gt; </td></tr>
<tr class="memitem:gaa0bd7927a859ab0e44df1df898b68e7c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</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&lt; BF, FB, NB, M &gt; x, R &amp;y)</td></tr>
<tr class="memdesc:gaa0bd7927a859ab0e44df1df898b68e7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_channel_reference <br/></td></tr>
<tr class="separator:gaa0bd7927a859ab0e44df1df898b68e7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaad704056496a9a216609ebde22497e5f"><td class="memTemplParams" colspan="2"><a class="anchor" id="gaad704056496a9a216609ebde22497e5f"></a>
template&lt;typename BF , int FB, int NB, bool M&gt; </td></tr>
<tr class="memitem:gaad704056496a9a216609ebde22497e5f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</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&lt; BF, FB, NB, M &gt;::value_type &amp;x, const boost::gil::packed_channel_reference&lt; BF, FB, NB, M &gt; y)</td></tr>
<tr class="memdesc:gaad704056496a9a216609ebde22497e5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_channel_reference <br/></td></tr>
<tr class="separator:gaad704056496a9a216609ebde22497e5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8dd3a59fa9f04ce822b13f268f8a1ed4"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga8dd3a59fa9f04ce822b13f268f8a1ed4"></a>
template&lt;typename BF , int FB, int NB, bool M&gt; </td></tr>
<tr class="memitem:ga8dd3a59fa9f04ce822b13f268f8a1ed4"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</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&lt; BF, FB, NB, M &gt; x, const boost::gil::packed_channel_reference&lt; BF, FB, NB, M &gt; y)</td></tr>
<tr class="memdesc:ga8dd3a59fa9f04ce822b13f268f8a1ed4"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_channel_reference <br/></td></tr>
<tr class="separator:ga8dd3a59fa9f04ce822b13f268f8a1ed4"><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 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&lt;uint16_t,1,2,true&gt; 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(&amp;data);</div>
<div class="line">channel_ref = channel_traits&lt;bits2_1_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 -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 26 2018 16:26:16 for Generic Image Library by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>