1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192 |
- <!-- 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.15"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Generic Image Library: ColorBaseConcept< ColorBase > Struct Template 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.15 -->
- <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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',false,false,'search.php','Search');
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><b>boost</b></li><li class="navelem"><b>gil</b></li><li class="navelem"><a class="el" href="structboost_1_1gil_1_1_color_base_concept.html">ColorBaseConcept</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-attribs">Public Attributes</a> |
- <a href="structboost_1_1gil_1_1_color_base_concept-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">ColorBaseConcept< ColorBase > Struct Template Reference<div class="ingroups"><a class="el" href="group___color_base.html">ColorBase</a> » <a class="el" href="group___color_base_concept.html">Concepts</a></div></div> </div>
- </div><!--header-->
- <div class="contents">
- <p>A color base is a container of color elements (such as channels, channel references or channel pointers).
- <a href="structboost_1_1gil_1_1_color_base_concept.html#details">More...</a></p>
- <p><code>#include <<a class="el" href="concepts_2color__base_8hpp_source.html">color_base.hpp</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:ab0a0dbf6ca9028bbbb2240cad5882537"><td class="memItemLeft" align="right" valign="top"><a id="ab0a0dbf6ca9028bbbb2240cad5882537"></a>
- void </td><td class="memItemRight" valign="bottom"><b>constraints</b> ()</td></tr>
- <tr class="separator:ab0a0dbf6ca9028bbbb2240cad5882537"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
- Public Attributes</h2></td></tr>
- <tr class="memitem:a36965b52a82be93752886f21e7efcf94"><td class="memItemLeft" align="right" valign="top"><a id="a36965b52a82be93752886f21e7efcf94"></a>
- ColorBase </td><td class="memItemRight" valign="bottom"><b>cb</b></td></tr>
- <tr class="separator:a36965b52a82be93752886f21e7efcf94"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><h3>template<typename ColorBase><br />
- struct boost::gil::ColorBaseConcept< ColorBase ></h3>
- <p>A color base is a container of color elements (such as channels, channel references or channel pointers). </p>
- <p>The most common use of color base is in the implementation of a pixel, in which case the color elements are channel values. The color base concept, however, can be used in other scenarios. For example, a planar pixel has channels that are not contiguous in memory. Its reference is a proxy class that uses a color base whose elements are channel references. Its iterator uses a color base whose elements are channel iterators.</p>
- <p>A color base must have an associated layout (which consists of a color space, as well as an ordering of the channels). There are two ways to index the elements of a color base: A physical index corresponds to the way they are ordered in memory, and a semantic index corresponds to the way the elements are ordered in their color space. For example, in the RGB color space the elements are ordered as {<a class="el" href="structboost_1_1gil_1_1red__t.html" title="Red.">red_t</a>, <a class="el" href="structboost_1_1gil_1_1green__t.html" title="Green.">green_t</a>, <a class="el" href="structboost_1_1gil_1_1blue__t.html" title="Blue.">blue_t</a>}. For a color base with a BGR layout, the first element in physical ordering is the blue element, whereas the first semantic element is the red one. Models of <code><a class="el" href="structboost_1_1gil_1_1_color_base_concept.html" title="A color base is a container of color elements (such as channels, channel references or channel pointe...">ColorBaseConcept</a></code> are required to provide the <code>at_c<K>(ColorBase)</code> function, which allows for accessing the elements based on their physical order. GIL provides a <code>semantic_at_c<K>(ColorBase)</code> function (described later) which can operate on any model of <a class="el" href="structboost_1_1gil_1_1_color_base_concept.html" title="A color base is a container of color elements (such as channels, channel references or channel pointe...">ColorBaseConcept</a> and returns the corresponding semantic element.</p>
- <div class="fragment"><div class="line">concept ColorBaseConcept<typename T> : CopyConstructible<T>, EqualityComparable<T></div><div class="line">{</div><div class="line"> <span class="comment">// a GIL layout (the color space and element permutation)</span></div><div class="line"> <span class="keyword">typename</span> layout_t;</div><div class="line"></div><div class="line"> <span class="comment">// The type of K-th element</span></div><div class="line"> <span class="keyword">template</span> <<span class="keywordtype">int</span> K></div><div class="line"> <span class="keyword">struct </span>kth_element_type;</div><div class="line"> where Metafunction<kth_element_type>;</div><div class="line"></div><div class="line"> <span class="comment">// The result of at_c</span></div><div class="line"> <span class="keyword">template</span> <<span class="keywordtype">int</span> K></div><div class="line"> <span class="keyword">struct </span>kth_element_const_reference_type;</div><div class="line"> where Metafunction<kth_element_const_reference_type>;</div><div class="line"></div><div class="line"> <span class="keyword">template</span> <<span class="keywordtype">int</span> K></div><div class="line"> kth_element_const_reference_type<T,K>::type <a class="code" href="group___color_base_model_homogeneous.html#gae2eaf5eecbad94d7dc6432b8f759fba0">at_c</a>(T);</div><div class="line"></div><div class="line"> <span class="comment">// Copy-constructible and equality comparable with other compatible color bases</span></div><div class="line"> <span class="keyword">template</span> <ColorBaseConcept T2> where { ColorBasesCompatibleConcept<T,T2> }</div><div class="line"> T::T(T2);</div><div class="line"> <span class="keyword">template</span> <ColorBaseConcept T2> where { ColorBasesCompatibleConcept<T,T2> }</div><div class="line"> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> T&, <span class="keyword">const</span> T2&);</div><div class="line"> <span class="keyword">template</span> <ColorBaseConcept T2> where { ColorBasesCompatibleConcept<T,T2> }</div><div class="line"> <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> T&, <span class="keyword">const</span> T2&);</div><div class="line">};</div></div><!-- fragment --> </div><hr/>The documentation for this struct was generated from the following file:<ul>
- <li><a class="el" href="concepts_2color__base_8hpp_source.html">concepts/color_base.hpp</a></li>
- </ul>
- </div><!-- contents -->
- <!-- HTML footer for doxygen 1.8.13-->
- <!-- start footer part -->
- <hr class="footer"/>
- <address class="footer">
- <small>
- Generated by  <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
- </small>
- </address>
- </body>
- </html>
|