boost/gil
2
0
Fork 0
mirror of https://github.com/boostorg/gil.git synced 2026-01-23 05:32:12 +00:00
Code Issues Projects Releases Wiki Activity
Files
gh-pages
gil/develop/doc/html/reference/group___image_model.html
github-actions[bot] 3b73200ee1 deploy: 49d9276706
2025-04-04 16:28:54 +00:00

155 lines
11 KiB
HTML
Raw Permalink Blame History

<!-- 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: Models</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> </div>
<div class="headertitle"><div class="title">Models<div class="ingroups"><a class="el" href="group___image.html">Image</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Image models.
<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_1image.html">image&lt; Pixel, IsPlanar, Alloc &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">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><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_1any__image.html">any_image&lt; Images &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a run-time specified image. Note it does NOT model <a class="el" href="structboost_1_1gil_1_1_image_concept.html" title="2-dimensional image whose value type models PixelValueConcept">ImageConcept</a>. <a href="classboost_1_1gil_1_1any__image.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">view, const_view</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>Get an image view from a run-time instantiated image </p>
</td></tr>
<tr class="memitem:ga11e52868409ba2d52a93213ee39f4fde" id="r_ga11e52868409ba2d52a93213ee39f4fde"><td class="memTemplParams" colspan="2"><a id="ga11e52868409ba2d52a93213ee39f4fde" name="ga11e52868409ba2d52a93213ee39f4fde"></a>
template&lt;typename Pixel , bool IsPlanar, typename Alloc &gt; </td></tr>
<tr class="memitem:ga11e52868409ba2d52a93213ee39f4fde"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>view</b> (<a class="el" href="classboost_1_1gil_1_1image.html">image</a>&lt; Pixel, IsPlanar, Alloc &gt; &amp;img) -&gt; typename <a class="el" href="classboost_1_1gil_1_1image.html">image</a>&lt; Pixel, IsPlanar, Alloc &gt;::view_t const &amp;</td></tr>
<tr class="memdesc:ga11e52868409ba2d52a93213ee39f4fde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the non-constant-pixel view of an image. <br /></td></tr>
<tr class="separator:ga11e52868409ba2d52a93213ee39f4fde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga383d207978a4de85116c20d9a87ea960" id="r_ga383d207978a4de85116c20d9a87ea960"><td class="memTemplParams" colspan="2">template&lt;typename ... Images&gt; </td></tr>
<tr class="memitem:ga383d207978a4de85116c20d9a87ea960"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_model.html#ga383d207978a4de85116c20d9a87ea960">view</a> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Images... &gt; &amp;img) -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Images... &gt;::view_t</td></tr>
<tr class="memdesc:ga383d207978a4de85116c20d9a87ea960"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the non-constant-pixel view of any image. The returned view is any view. <br /></td></tr>
<tr class="separator:ga383d207978a4de85116c20d9a87ea960"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga26419694704d5f71f8f95911e77463a1" id="r_ga26419694704d5f71f8f95911e77463a1"><td class="memTemplParams" colspan="2">template&lt;typename ... Images&gt; </td></tr>
<tr class="memitem:ga26419694704d5f71f8f95911e77463a1"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_model.html#ga26419694704d5f71f8f95911e77463a1">const_view</a> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Images... &gt; const &amp;img) -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Images... &gt;::const_view_t</td></tr>
<tr class="memdesc:ga26419694704d5f71f8f95911e77463a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the constant-pixel view of any image. The returned view is any view. <br /></td></tr>
<tr class="separator:ga26419694704d5f71f8f95911e77463a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab9e7381cd1eac42c5abcf2d883c8e86e" id="r_gab9e7381cd1eac42c5abcf2d883c8e86e"><td class="memTemplParams" colspan="2"><a id="gab9e7381cd1eac42c5abcf2d883c8e86e" name="gab9e7381cd1eac42c5abcf2d883c8e86e"></a>
template&lt;typename Pixel , bool IsPlanar, typename Alloc &gt; </td></tr>
<tr class="memitem:gab9e7381cd1eac42c5abcf2d883c8e86e"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>const_view</b> (const <a class="el" href="classboost_1_1gil_1_1image.html">image</a>&lt; Pixel, IsPlanar, Alloc &gt; &amp;img) -&gt; typename <a class="el" href="classboost_1_1gil_1_1image.html">image</a>&lt; Pixel, IsPlanar, Alloc &gt;::const_view_t const</td></tr>
<tr class="memdesc:gab9e7381cd1eac42c5abcf2d883c8e86e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the constant-pixel view of an image. <br /></td></tr>
<tr class="separator:gab9e7381cd1eac42c5abcf2d883c8e86e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Image models. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga26419694704d5f71f8f95911e77463a1" name="ga26419694704d5f71f8f95911e77463a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga26419694704d5f71f8f95911e77463a1">&#9670;&#160;</a></span>const_view()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ... Images&gt; </div>
<table class="memname">
<tr>
<td class="memname">BOOST_FORCEINLINE auto const_view </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Images... &gt; const &amp;&#160;</td>
<td class="paramname"><em>img</em></td><td>)</td>
<td> -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt;Images...&gt;::const_view_t
</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the constant-pixel view of any image. The returned view is any view. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Types</td><td>Models ImageVectorConcept </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga383d207978a4de85116c20d9a87ea960" name="ga383d207978a4de85116c20d9a87ea960"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga383d207978a4de85116c20d9a87ea960">&#9670;&#160;</a></span>view()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ... Images&gt; </div>
<table class="memname">
<tr>
<td class="memname">BOOST_FORCEINLINE auto view </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Images... &gt; &amp;&#160;</td>
<td class="paramname"><em>img</em></td><td>)</td>
<td> -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt;Images...&gt;::view_t
</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the non-constant-pixel view of any image. The returned view is any view. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Images</td><td>Models ImageVectorConcept </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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>
Reference in New Issue View Git Blame Copy Permalink