mirror of
https://github.com/boostorg/gil.git
synced 2026-02-11 11:52:12 +00:00
198 lines
19 KiB
HTML
198 lines
19 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.11"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Generic Image Library: image< Pixel, IsPlanar, Alloc > Class 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.11 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</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="classboost_1_1gil_1_1image.html">image</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-attribs">Public Attributes</a> |
|
|
<a href="classboost_1_1gil_1_1image-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">image< Pixel, IsPlanar, Alloc > Class Template Reference<div class="ingroups"><a class="el" href="group___image.html">Image</a> » <a class="el" href="group___image_model.html">Models</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>container interface over image view. Models <a class="el" href="structboost_1_1gil_1_1_image_concept.html" title="2-dimensional image whose value type models PixelValueConcept ">ImageConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs. ">PixelBasedConcept</a>
|
|
<a href="classboost_1_1gil_1_1image.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="image_8hpp_source.html">image.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a3638c9d581a358b25c4f675367ce023f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3638c9d581a358b25c4f675367ce023f"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>allocator_type</b> = typename std::allocator_traits< Alloc >::template rebind_alloc< unsigned char ></td></tr>
|
|
<tr class="separator:a3638c9d581a358b25c4f675367ce023f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a036604f03e8badb4465c65270d8e3d22"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a036604f03e8badb4465c65270d8e3d22"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>view_t</b> = typename <a class="el" href="structboost_1_1gil_1_1view__type__from__pixel.html">view_type_from_pixel</a>< Pixel, IsPlanar >::type</td></tr>
|
|
<tr class="separator:a036604f03e8badb4465c65270d8e3d22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af22de4cd1c084c288216682b1a04416a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af22de4cd1c084c288216682b1a04416a"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>const_view_t</b> = typename view_t::const_t</td></tr>
|
|
<tr class="separator:af22de4cd1c084c288216682b1a04416a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfe36fdedc6e90f870ef4fd0bf18b22a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adfe36fdedc6e90f870ef4fd0bf18b22a"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>point_t</b> = typename view_t::point_t</td></tr>
|
|
<tr class="separator:adfe36fdedc6e90f870ef4fd0bf18b22a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a568300af26fec4a23b5f280209f1ad14"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a568300af26fec4a23b5f280209f1ad14"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>coord_t</b> = typename view_t::coord_t</td></tr>
|
|
<tr class="separator:a568300af26fec4a23b5f280209f1ad14"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a470418f083aa6040ac1983dc22e94d76"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a470418f083aa6040ac1983dc22e94d76"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>value_type</b> = typename view_t::value_type</td></tr>
|
|
<tr class="separator:a470418f083aa6040ac1983dc22e94d76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e1d4e6abecb43f99a7d66c8479f15c3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e1d4e6abecb43f99a7d66c8479f15c3"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>x_coord_t</b> = coord_t</td></tr>
|
|
<tr class="separator:a7e1d4e6abecb43f99a7d66c8479f15c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2c71b4976bdece620245109800e843f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2c71b4976bdece620245109800e843f"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>y_coord_t</b> = coord_t</td></tr>
|
|
<tr class="separator:ab2c71b4976bdece620245109800e843f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:af723fb36aee62ac02924637371797b7a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af723fb36aee62ac02924637371797b7a"></a>
|
|
const point_t & </td><td class="memItemRight" valign="bottom"><b>dimensions</b> () const </td></tr>
|
|
<tr class="separator:af723fb36aee62ac02924637371797b7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aedb657636fdfa1645708f3beaad70d8d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedb657636fdfa1645708f3beaad70d8d"></a>
|
|
x_coord_t </td><td class="memItemRight" valign="bottom"><b>width</b> () const </td></tr>
|
|
<tr class="separator:aedb657636fdfa1645708f3beaad70d8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d84f7f164c70ba5b617ffa1e69f71a1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d84f7f164c70ba5b617ffa1e69f71a1"></a>
|
|
y_coord_t </td><td class="memItemRight" valign="bottom"><b>height</b> () const </td></tr>
|
|
<tr class="separator:a5d84f7f164c70ba5b617ffa1e69f71a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aceab6688d7bdc71b3118c91b81e39a7f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aceab6688d7bdc71b3118c91b81e39a7f"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>image</b> (std::size_t alignment=0, const Alloc alloc_in=Alloc())</td></tr>
|
|
<tr class="separator:aceab6688d7bdc71b3118c91b81e39a7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad20ce07917c6be964611e2ab87fee52b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad20ce07917c6be964611e2ab87fee52b"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>image</b> (const point_t &dimensions, std::size_t alignment=0, const Alloc alloc_in=Alloc())</td></tr>
|
|
<tr class="separator:ad20ce07917c6be964611e2ab87fee52b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a348f4a910ac7d4e217b163874c9f12fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a348f4a910ac7d4e217b163874c9f12fd"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>image</b> (x_coord_t width, y_coord_t height, std::size_t alignment=0, const Alloc alloc_in=Alloc())</td></tr>
|
|
<tr class="separator:a348f4a910ac7d4e217b163874c9f12fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9dffedcc688a0c662608dfb3eff21e1b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9dffedcc688a0c662608dfb3eff21e1b"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>image</b> (const point_t &dimensions, const Pixel &p_in, std::size_t alignment, const Alloc alloc_in=Alloc())</td></tr>
|
|
<tr class="separator:a9dffedcc688a0c662608dfb3eff21e1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2338d4efa4194f32afa2778c00d5c84"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2338d4efa4194f32afa2778c00d5c84"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>image</b> (x_coord_t width, y_coord_t height, const Pixel &p_in, std::size_t alignment=0, const Alloc alloc_in=Alloc())</td></tr>
|
|
<tr class="separator:ab2338d4efa4194f32afa2778c00d5c84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83f7f90e51d5d2fc0596f53dc1e13d74"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83f7f90e51d5d2fc0596f53dc1e13d74"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>image</b> (const <a class="el" href="classboost_1_1gil_1_1image.html">image</a> &img)</td></tr>
|
|
<tr class="separator:a83f7f90e51d5d2fc0596f53dc1e13d74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6d6ac2d80d5065dceff2137d5b2a6ea8"><td class="memTemplParams" colspan="2"><a class="anchor" id="a6d6ac2d80d5065dceff2137d5b2a6ea8"></a>
|
|
template<typename P2 , bool IP2, typename Alloc2 > </td></tr>
|
|
<tr class="memitem:a6d6ac2d80d5065dceff2137d5b2a6ea8"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><b>image</b> (const <a class="el" href="classboost_1_1gil_1_1image.html">image</a>< P2, IP2, Alloc2 > &img)</td></tr>
|
|
<tr class="separator:a6d6ac2d80d5065dceff2137d5b2a6ea8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5948ad79aad69674db60be93cd194766"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5948ad79aad69674db60be93cd194766"></a>
|
|
<a class="el" href="classboost_1_1gil_1_1image.html">image</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classboost_1_1gil_1_1image.html">image</a> &img)</td></tr>
|
|
<tr class="separator:a5948ad79aad69674db60be93cd194766"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3f3eb7c7e02bd538fa830c35fe97f6a"><td class="memTemplParams" colspan="2"><a class="anchor" id="ac3f3eb7c7e02bd538fa830c35fe97f6a"></a>
|
|
template<typename Img > </td></tr>
|
|
<tr class="memitem:ac3f3eb7c7e02bd538fa830c35fe97f6a"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1gil_1_1image.html">image</a> & </td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (const Img &img)</td></tr>
|
|
<tr class="separator:ac3f3eb7c7e02bd538fa830c35fe97f6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82dff19823db9c80dc337f1d6fc98620"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82dff19823db9c80dc337f1d6fc98620"></a>
|
|
Alloc & </td><td class="memItemRight" valign="bottom"><b>allocator</b> ()</td></tr>
|
|
<tr class="separator:a82dff19823db9c80dc337f1d6fc98620"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3455cee0edcdc28fdafaeb4d5b6b005"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3455cee0edcdc28fdafaeb4d5b6b005"></a>
|
|
Alloc const & </td><td class="memItemRight" valign="bottom"><b>allocator</b> () const </td></tr>
|
|
<tr class="separator:af3455cee0edcdc28fdafaeb4d5b6b005"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aecbe6d01103834f8178f73465a19d58c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aecbe6d01103834f8178f73465a19d58c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>swap</b> (<a class="el" href="classboost_1_1gil_1_1image.html">image</a> &img)</td></tr>
|
|
<tr class="separator:aecbe6d01103834f8178f73465a19d58c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa5e9d00645607b9d19ab7759906c008"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa5e9d00645607b9d19ab7759906c008"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>recreate</b> (const point_t &dims, std::size_t alignment=0)</td></tr>
|
|
<tr class="separator:aaa5e9d00645607b9d19ab7759906c008"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89c3892dbcc482526ac4fd6a6a045cdb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89c3892dbcc482526ac4fd6a6a045cdb"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>recreate</b> (x_coord_t width, y_coord_t height, std::size_t alignment=0)</td></tr>
|
|
<tr class="separator:a89c3892dbcc482526ac4fd6a6a045cdb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a30a1cc855b2419cb00ef5ebe35b2e43a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a30a1cc855b2419cb00ef5ebe35b2e43a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>recreate</b> (const point_t &dims, const Pixel &p_in, std::size_t alignment=0)</td></tr>
|
|
<tr class="separator:a30a1cc855b2419cb00ef5ebe35b2e43a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeab1806c92d01e28d9438aefaaf7b9ff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeab1806c92d01e28d9438aefaaf7b9ff"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>recreate</b> (x_coord_t width, y_coord_t height, const Pixel &p_in, std::size_t alignment=0)</td></tr>
|
|
<tr class="separator:aeab1806c92d01e28d9438aefaaf7b9ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab697a973cba2c84716ddbd587bab91ec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab697a973cba2c84716ddbd587bab91ec"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>recreate</b> (const point_t &dims, std::size_t alignment, const Alloc alloc_in)</td></tr>
|
|
<tr class="separator:ab697a973cba2c84716ddbd587bab91ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24624398dfcd12e2a9fb445a6dc6f053"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24624398dfcd12e2a9fb445a6dc6f053"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>recreate</b> (x_coord_t width, y_coord_t height, std::size_t alignment, const Alloc alloc_in)</td></tr>
|
|
<tr class="separator:a24624398dfcd12e2a9fb445a6dc6f053"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4ea3606ec6084a66c3d8a68d5d92c93"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4ea3606ec6084a66c3d8a68d5d92c93"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>recreate</b> (const point_t &dims, const Pixel &p_in, std::size_t alignment, const Alloc alloc_in)</td></tr>
|
|
<tr class="separator:aa4ea3606ec6084a66c3d8a68d5d92c93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a887ee56b29eff6cd896cecd30b957a91"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a887ee56b29eff6cd896cecd30b957a91"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>recreate</b> (x_coord_t width, y_coord_t height, const Pixel &p_in, std::size_t alignment, const Alloc alloc_in)</td></tr>
|
|
<tr class="separator:a887ee56b29eff6cd896cecd30b957a91"><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:af0b0c4c1267ee1f0ec635a4b2d00ec98"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0b0c4c1267ee1f0ec635a4b2d00ec98"></a>
|
|
view_t </td><td class="memItemRight" valign="bottom"><b>_view</b></td></tr>
|
|
<tr class="separator:af0b0c4c1267ee1f0ec635a4b2d00ec98"><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 Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>><br />
|
|
class boost::gil::image< Pixel, IsPlanar, Alloc ></h3>
|
|
|
|
<p>container interface over image view. Models <a class="el" href="structboost_1_1gil_1_1_image_concept.html" title="2-dimensional image whose value type models PixelValueConcept ">ImageConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs. ">PixelBasedConcept</a> </p>
|
|
<p>A 2D container whose elements are pixels. It is templated over the pixel type, a boolean indicating whether it should be planar, and an optional allocator.</p>
|
|
<p>Note that its element type does not have to be a pixel. <code>image</code> can be instantiated with any <a class="el" href="structboost_1_1gil_1_1_regular.html" title="Concept for type regularity requirement. ">Regular</a> element, in which case it models the weaker <a class="el" href="structboost_1_1gil_1_1_random_access2_d_image_concept.html" title="2-dimensional container of values ">RandomAccess2DImageConcept</a> and does not model <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs. ">PixelBasedConcept</a></p>
|
|
<p>When recreating an image of the same or smaller size the memory will be reused if possible. </p>
|
|
</div><hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="image_8hpp_source.html">image.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.11
|
|
</small>
|
|
</address>
|
|
</body>
|
|
</html>
|