mirror of
https://github.com/boostorg/gil.git
synced 2026-02-13 00:22:11 +00:00
164 lines
18 KiB
HTML
164 lines
18 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: pixel< ChannelValue, Layout > 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.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&dn=expat.txt MIT */
|
|
$(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"><a class="el" href="namespaceboost.html">boost</a></li><li class="navelem"><b>gil</b></li><li class="navelem"><a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
|
<a href="structboost_1_1gil_1_1pixel-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">pixel< ChannelValue, Layout > Struct Template Reference<div class="ingroups"><a class="el" href="group___pixel.html">Pixel</a> » <a class="el" href="group___pixel_model.html">Models</a> » <a class="el" href="group___pixel_model_pixel.html">pixel</a> | <a class="el" href="group___color_base.html">ColorBase</a> » <a class="el" href="group___color_base_model.html">Models</a> » <a class="el" href="group___color_base_model_pixel.html">pixel</a> | <a class="el" href="group___pixel_based.html">PixelBased</a> » <a class="el" href="group___pixel_based_model.html">Models</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Represents a pixel value (a container of channels). Models: <a class="el" href="structboost_1_1gil_1_1_homogeneous_color_base_value_concept.html" title="Homogeneous color base that also has a default constructor. Refines Regular.">HomogeneousColorBaseValueConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_value_concept.html" title="Pixel concept that is a Regular type.">PixelValueConcept</a>, <a class="el" href="structboost_1_1gil_1_1_homogeneous_pixel_based_concept.html" title="Concept for homogeneous pixel-based GIL constructs.">HomogeneousPixelBasedConcept</a>.
|
|
<a href="structboost_1_1gil_1_1pixel.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="pixel_8hpp_source.html">pixel.hpp</a>></code></p>
|
|
|
|
<p>Inherits homogeneous_color_base< Element, Layout, K >.</p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a41e636d5aab49f830310d96cc20a62e4" id="r_a41e636d5aab49f830310d96cc20a62e4"><td class="memItemLeft" align="right" valign="top"><a id="a41e636d5aab49f830310d96cc20a62e4" name="a41e636d5aab49f830310d96cc20a62e4"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>value_type</b> = <a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a>< ChannelValue, Layout ></td></tr>
|
|
<tr class="separator:a41e636d5aab49f830310d96cc20a62e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74202cdd96628bc49a756e5fc87d22de" id="r_a74202cdd96628bc49a756e5fc87d22de"><td class="memItemLeft" align="right" valign="top"><a id="a74202cdd96628bc49a756e5fc87d22de" name="a74202cdd96628bc49a756e5fc87d22de"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>reference</b> = <a class="el" href="structboost_1_1gil_1_1pixel.html">value_type</a> &</td></tr>
|
|
<tr class="separator:a74202cdd96628bc49a756e5fc87d22de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4780295ff953151e0121aebfbcade4da" id="r_a4780295ff953151e0121aebfbcade4da"><td class="memItemLeft" align="right" valign="top"><a id="a4780295ff953151e0121aebfbcade4da" name="a4780295ff953151e0121aebfbcade4da"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>const_reference</b> = <a class="el" href="structboost_1_1gil_1_1pixel.html">value_type</a> const &</td></tr>
|
|
<tr class="separator:a4780295ff953151e0121aebfbcade4da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a39970d76708fe02233e30494f8bfcc08" id="r_a39970d76708fe02233e30494f8bfcc08"><td class="memItemLeft" align="right" valign="top"><a id="a39970d76708fe02233e30494f8bfcc08" name="a39970d76708fe02233e30494f8bfcc08"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>pixel</b> (channel_t v)</td></tr>
|
|
<tr class="separator:a39970d76708fe02233e30494f8bfcc08"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac8fc3a7aa3c2eb33c5647adba7154a10" id="r_ac8fc3a7aa3c2eb33c5647adba7154a10"><td class="memItemLeft" align="right" valign="top"><a id="ac8fc3a7aa3c2eb33c5647adba7154a10" name="ac8fc3a7aa3c2eb33c5647adba7154a10"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>pixel</b> (channel_t v0, channel_t v1)</td></tr>
|
|
<tr class="separator:ac8fc3a7aa3c2eb33c5647adba7154a10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8de9c605ecf5e105d983af12e4753a02" id="r_a8de9c605ecf5e105d983af12e4753a02"><td class="memItemLeft" align="right" valign="top"><a id="a8de9c605ecf5e105d983af12e4753a02" name="a8de9c605ecf5e105d983af12e4753a02"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>pixel</b> (channel_t v0, channel_t v1, channel_t v2)</td></tr>
|
|
<tr class="separator:a8de9c605ecf5e105d983af12e4753a02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ebaaeee8a7a4befe3fbcc208c08d51c" id="r_a1ebaaeee8a7a4befe3fbcc208c08d51c"><td class="memItemLeft" align="right" valign="top"><a id="a1ebaaeee8a7a4befe3fbcc208c08d51c" name="a1ebaaeee8a7a4befe3fbcc208c08d51c"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>pixel</b> (channel_t v0, channel_t v1, channel_t v2, channel_t v3)</td></tr>
|
|
<tr class="separator:a1ebaaeee8a7a4befe3fbcc208c08d51c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91df320aa55ea9139d70ebe7ace80c14" id="r_a91df320aa55ea9139d70ebe7ace80c14"><td class="memItemLeft" align="right" valign="top"><a id="a91df320aa55ea9139d70ebe7ace80c14" name="a91df320aa55ea9139d70ebe7ace80c14"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>pixel</b> (channel_t v0, channel_t v1, channel_t v2, channel_t v3, channel_t v4)</td></tr>
|
|
<tr class="separator:a91df320aa55ea9139d70ebe7ace80c14"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaed63e339592d8e9cfd284c62fcee905" id="r_aaed63e339592d8e9cfd284c62fcee905"><td class="memItemLeft" align="right" valign="top"><a id="aaed63e339592d8e9cfd284c62fcee905" name="aaed63e339592d8e9cfd284c62fcee905"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>pixel</b> (channel_t v0, channel_t v1, channel_t v2, channel_t v3, channel_t v4, channel_t v5)</td></tr>
|
|
<tr class="separator:aaed63e339592d8e9cfd284c62fcee905"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3539e565edb5b6575daba03680ff5015" id="r_a3539e565edb5b6575daba03680ff5015"><td class="memItemLeft" align="right" valign="top"><a id="a3539e565edb5b6575daba03680ff5015" name="a3539e565edb5b6575daba03680ff5015"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>pixel</b> (const <a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a> &p)</td></tr>
|
|
<tr class="separator:a3539e565edb5b6575daba03680ff5015"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaba4cc60fc817023197e2369e880757b" id="r_aaba4cc60fc817023197e2369e880757b"><td class="memItemLeft" align="right" valign="top"><a id="aaba4cc60fc817023197e2369e880757b" name="aaba4cc60fc817023197e2369e880757b"></a>
|
|
<a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a> const &p)</td></tr>
|
|
<tr class="separator:aaba4cc60fc817023197e2369e880757b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61332efa3f596341a1a36170c71033da" id="r_a61332efa3f596341a1a36170c71033da"><td class="memTemplParams" colspan="2"><a id="a61332efa3f596341a1a36170c71033da" name="a61332efa3f596341a1a36170c71033da"></a>
|
|
template<typename Pixel > </td></tr>
|
|
<tr class="memitem:a61332efa3f596341a1a36170c71033da"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><b>pixel</b> (Pixel const &p, typename std::enable_if< is_pixel< Pixel >::value >::type *=nullptr)</td></tr>
|
|
<tr class="separator:a61332efa3f596341a1a36170c71033da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a15cfac6204dd1824b96e74e2f70e6094" id="r_a15cfac6204dd1824b96e74e2f70e6094"><td class="memTemplParams" colspan="2"><a id="a15cfac6204dd1824b96e74e2f70e6094" name="a15cfac6204dd1824b96e74e2f70e6094"></a>
|
|
template<typename Pixel > </td></tr>
|
|
<tr class="memitem:a15cfac6204dd1824b96e74e2f70e6094"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a> & </td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (Pixel const &p)</td></tr>
|
|
<tr class="separator:a15cfac6204dd1824b96e74e2f70e6094"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ee168419936700a6db322af16b6fa56" id="r_a2ee168419936700a6db322af16b6fa56"><td class="memTemplParams" colspan="2"><a id="a2ee168419936700a6db322af16b6fa56" name="a2ee168419936700a6db322af16b6fa56"></a>
|
|
template<typename Pixel > </td></tr>
|
|
<tr class="memitem:a2ee168419936700a6db322af16b6fa56"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><b>operator==</b> (Pixel const &p) const</td></tr>
|
|
<tr class="separator:a2ee168419936700a6db322af16b6fa56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e84b33a61c27a8ca0d4cfd1d17a3ce7" id="r_a7e84b33a61c27a8ca0d4cfd1d17a3ce7"><td class="memTemplParams" colspan="2"><a id="a7e84b33a61c27a8ca0d4cfd1d17a3ce7" name="a7e84b33a61c27a8ca0d4cfd1d17a3ce7"></a>
|
|
template<typename Pixel > </td></tr>
|
|
<tr class="memitem:a7e84b33a61c27a8ca0d4cfd1d17a3ce7"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><b>operator!=</b> (Pixel const &p) const</td></tr>
|
|
<tr class="separator:a7e84b33a61c27a8ca0d4cfd1d17a3ce7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d0584a160b08831c9c683660767942d" id="r_a3d0584a160b08831c9c683660767942d"><td class="memItemLeft" align="right" valign="top"><a id="a3d0584a160b08831c9c683660767942d" name="a3d0584a160b08831c9c683660767942d"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>operator[]</b> (std::size_t index) -> typename channel_traits< channel_t >::reference</td></tr>
|
|
<tr class="separator:a3d0584a160b08831c9c683660767942d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c00c22fbadf618113641d4713b35d5d" id="r_a9c00c22fbadf618113641d4713b35d5d"><td class="memItemLeft" align="right" valign="top"><a id="a9c00c22fbadf618113641d4713b35d5d" name="a9c00c22fbadf618113641d4713b35d5d"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>operator[]</b> (std::size_t index) const -> typename channel_traits< channel_t >::const_reference</td></tr>
|
|
<tr class="separator:a9c00c22fbadf618113641d4713b35d5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af73a36e2c67bd60c063ce59966461003" id="r_af73a36e2c67bd60c063ce59966461003"><td class="memItemLeft" align="right" valign="top"><a id="af73a36e2c67bd60c063ce59966461003" name="af73a36e2c67bd60c063ce59966461003"></a>
|
|
<a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (channel_t channel)</td></tr>
|
|
<tr class="separator:af73a36e2c67bd60c063ce59966461003"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0459b5c8b1d192e54f0aa451d89dce42" id="r_a0459b5c8b1d192e54f0aa451d89dce42"><td class="memItemLeft" align="right" valign="top"><a id="a0459b5c8b1d192e54f0aa451d89dce42" name="a0459b5c8b1d192e54f0aa451d89dce42"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (channel_t channel) const</td></tr>
|
|
<tr class="separator:a0459b5c8b1d192e54f0aa451d89dce42"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
|
|
Static Public Attributes</h2></td></tr>
|
|
<tr class="memitem:ada04709db53ded2c170444a3f1c4e5d4" id="r_ada04709db53ded2c170444a3f1c4e5d4"><td class="memItemLeft" align="right" valign="top"><a id="ada04709db53ded2c170444a3f1c4e5d4" name="ada04709db53ded2c170444a3f1c4e5d4"></a>
|
|
static constexpr bool </td><td class="memItemRight" valign="bottom"><b>is_mutable</b> = channel_traits<channel_t>::is_mutable</td></tr>
|
|
<tr class="separator:ada04709db53ded2c170444a3f1c4e5d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<typename ChannelValue, typename Layout><br />
|
|
struct boost::gil::pixel< ChannelValue, Layout ></div><p>Represents a pixel value (a container of channels). Models: <a class="el" href="structboost_1_1gil_1_1_homogeneous_color_base_value_concept.html" title="Homogeneous color base that also has a default constructor. Refines Regular.">HomogeneousColorBaseValueConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_value_concept.html" title="Pixel concept that is a Regular type.">PixelValueConcept</a>, <a class="el" href="structboost_1_1gil_1_1_homogeneous_pixel_based_concept.html" title="Concept for homogeneous pixel-based GIL constructs.">HomogeneousPixelBasedConcept</a>. </p>
|
|
<p>A pixel is a set of channels defining the color at a given point in an image. Conceptually, a pixel is little more than a color base whose elements model <code><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></code>. The class <code>pixel</code> defines a simple, homogeneous pixel value. It is used to store the value of a color. The built-in C++ references to <code>pixel</code>, <code>pixel&</code> and <code>const</code> <code>pixel&</code> are used to represent a reference to a pixel inside an interleaved image view (a view in which all channels are together in memory). Similarly, built-in pointer types <code>pixel*</code> and <code>const</code> <code>pixel*</code> are used as the standard iterator over a row of interleaved homogeneous pixels.</p>
|
|
<p>Since <code>pixel</code> inherits the properties of color base, assigning, equality comparison and copy-construcion are allowed between compatible pixels. This means that an 8-bit RGB pixel may be assigned to an 8-bit BGR pixel, or to an 8-bit planar reference. The channels are properly paired semantically.</p>
|
|
<p>The single-channel (grayscale) instantiation of the class pixel, (i.e. <code>pixel<T,gray_layout_t></code>) is also convertible to/from a channel value. This allows grayscale pixels to be used in simpler expressions like *gray_pix1 = *gray_pix2 instead of more complicated at_c<0>(gray_pix1) = at_c<0>(gray_pix2) or get_color<gray_color_t>(gray_pix1) = get_color<gray_color_t>(gray_pix2)</p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">ChannelValue</td><td>TODO </td></tr>
|
|
<tr><td class="paramname">Layout</td><td>mp11::make_integer_sequence<int, ColorSpace::size> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
</div><hr/>The documentation for this struct was generated from the following files:<ul>
|
|
<li><a class="el" href="metafunctions_8hpp_source.html">metafunctions.hpp</a></li>
|
|
<li><a class="el" href="pixel_8hpp_source.html">pixel.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.9.8
|
|
</small>
|
|
</address>
|
|
</body>
|
|
</html>
|