1 <!-- HTML header for doxygen 1.8.13-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.15"/>
8 <meta name="viewport" content="width=device-width, initial-scale=1"/>
9 <title>Generic Image Library: any_image< Images > Class Template Reference</title>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="dynsections.js"></script>
13 <link href="doxygen.css" rel="stylesheet" type="text/css" />
14 <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
17 <div class="boost-header">
18 <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
20 <td valign="top" width="300">
21 <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
23 <td ><h1 align="center"><a href="../index.html"></a></h1></td>
29 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
30 <!-- Generated by Doxygen 1.8.15 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
36 initMenu('',false,false,'search.php','Search');
38 /* @license-end */</script>
39 <div id="main-nav"></div>
40 <div id="nav-path" class="navpath">
42 <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_1any__image.html">any_image</a></li> </ul>
47 <a href="#pub-types">Public Types</a> |
48 <a href="#pub-methods">Public Member Functions</a> |
49 <a href="classboost_1_1gil_1_1any__image-members.html">List of all members</a> </div>
50 <div class="headertitle">
51 <div class="title">any_image< Images > 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></div></div> </div>
53 <div class="contents">
55 <p>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>.
56 <a href="classboost_1_1gil_1_1any__image.html#details">More...</a></p>
58 <p><code>#include <<a class="el" href="any__image_8hpp_source.html">any_image.hpp</a>></code></p>
60 <p>Inherits type< Images >.</p>
61 <table class="memberdecls">
62 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
63 Public Types</h2></td></tr>
64 <tr class="memitem:aa5b7e5ecbb766bc33411683b334f471b"><td class="memItemLeft" align="right" valign="top"><a id="aa5b7e5ecbb766bc33411683b334f471b"></a>
65 using </td><td class="memItemRight" valign="bottom"><b>view_t</b> = <a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a>< detail::images_get_views_t< Images > ></td></tr>
66 <tr class="separator:aa5b7e5ecbb766bc33411683b334f471b"><td class="memSeparator" colspan="2"> </td></tr>
67 <tr class="memitem:ae708c7e232a3ee4d89aecb744dfdcf26"><td class="memItemLeft" align="right" valign="top"><a id="ae708c7e232a3ee4d89aecb744dfdcf26"></a>
68 using </td><td class="memItemRight" valign="bottom"><b>const_view_t</b> = <a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a>< detail::images_get_const_views_t< Images > ></td></tr>
69 <tr class="separator:ae708c7e232a3ee4d89aecb744dfdcf26"><td class="memSeparator" colspan="2"> </td></tr>
70 <tr class="memitem:a2f1a92adcae3b10cbad7fe560a94d1b1"><td class="memItemLeft" align="right" valign="top"><a id="a2f1a92adcae3b10cbad7fe560a94d1b1"></a>
71 using </td><td class="memItemRight" valign="bottom"><b>x_coord_t</b> = std::ptrdiff_t</td></tr>
72 <tr class="separator:a2f1a92adcae3b10cbad7fe560a94d1b1"><td class="memSeparator" colspan="2"> </td></tr>
73 <tr class="memitem:a13938895b1e20b12d10f76329d47dc4a"><td class="memItemLeft" align="right" valign="top"><a id="a13938895b1e20b12d10f76329d47dc4a"></a>
74 using </td><td class="memItemRight" valign="bottom"><b>y_coord_t</b> = std::ptrdiff_t</td></tr>
75 <tr class="separator:a13938895b1e20b12d10f76329d47dc4a"><td class="memSeparator" colspan="2"> </td></tr>
76 <tr class="memitem:addc40a18340d115ea17a7ab120debe08"><td class="memItemLeft" align="right" valign="top"><a id="addc40a18340d115ea17a7ab120debe08"></a>
77 using </td><td class="memItemRight" valign="bottom"><b>point_t</b> = <a class="el" href="classboost_1_1gil_1_1point.html">point</a>< std::ptrdiff_t ></td></tr>
78 <tr class="separator:addc40a18340d115ea17a7ab120debe08"><td class="memSeparator" colspan="2"> </td></tr>
79 </table><table class="memberdecls">
80 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
81 Public Member Functions</h2></td></tr>
82 <tr class="memitem:a501be2950a656e5774d0eb5ebd88b7e0"><td class="memItemLeft" align="right" valign="top"><a id="a501be2950a656e5774d0eb5ebd88b7e0"></a>
83  </td><td class="memItemRight" valign="bottom"><b>any_image</b> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a> const &img)</td></tr>
84 <tr class="separator:a501be2950a656e5774d0eb5ebd88b7e0"><td class="memSeparator" colspan="2"> </td></tr>
85 <tr class="memitem:a0f81201cd238bc60c4107826bc72b405"><td class="memTemplParams" colspan="2"><a id="a0f81201cd238bc60c4107826bc72b405"></a>
86 template<typename Image > </td></tr>
87 <tr class="memitem:a0f81201cd238bc60c4107826bc72b405"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><b>any_image</b> (Image const &img)</td></tr>
88 <tr class="separator:a0f81201cd238bc60c4107826bc72b405"><td class="memSeparator" colspan="2"> </td></tr>
89 <tr class="memitem:a6adb3b7be63a7e1e99f41c5d27b3017a"><td class="memTemplParams" colspan="2"><a id="a6adb3b7be63a7e1e99f41c5d27b3017a"></a>
90 template<typename Image > </td></tr>
91 <tr class="memitem:a6adb3b7be63a7e1e99f41c5d27b3017a"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><b>any_image</b> (Image &img, bool do_swap)</td></tr>
92 <tr class="separator:a6adb3b7be63a7e1e99f41c5d27b3017a"><td class="memSeparator" colspan="2"> </td></tr>
93 <tr class="memitem:a32308751fc5e34ccfc42b368bbf86c73"><td class="memTemplParams" colspan="2"><a id="a32308751fc5e34ccfc42b368bbf86c73"></a>
94 template<typename OtherImages > </td></tr>
95 <tr class="memitem:a32308751fc5e34ccfc42b368bbf86c73"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><b>any_image</b> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>< OtherImages > const &img)</td></tr>
96 <tr class="separator:a32308751fc5e34ccfc42b368bbf86c73"><td class="memSeparator" colspan="2"> </td></tr>
97 <tr class="memitem:aba2e458291892f9f796c00582a2facaf"><td class="memItemLeft" align="right" valign="top"><a id="aba2e458291892f9f796c00582a2facaf"></a>
98 <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a> const &img)</td></tr>
99 <tr class="separator:aba2e458291892f9f796c00582a2facaf"><td class="memSeparator" colspan="2"> </td></tr>
100 <tr class="memitem:aa1d6ed6e77e895e39fd9bc37f34e7902"><td class="memTemplParams" colspan="2"><a id="aa1d6ed6e77e895e39fd9bc37f34e7902"></a>
101 template<typename Image > </td></tr>
102 <tr class="memitem:aa1d6ed6e77e895e39fd9bc37f34e7902"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a> & </td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (Image const &img)</td></tr>
103 <tr class="separator:aa1d6ed6e77e895e39fd9bc37f34e7902"><td class="memSeparator" colspan="2"> </td></tr>
104 <tr class="memitem:a31ee6077b443a1eb297792d7dea83e7f"><td class="memTemplParams" colspan="2"><a id="a31ee6077b443a1eb297792d7dea83e7f"></a>
105 template<typename OtherImages > </td></tr>
106 <tr class="memitem:a31ee6077b443a1eb297792d7dea83e7f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a> & </td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>< OtherImages > const &img)</td></tr>
107 <tr class="separator:a31ee6077b443a1eb297792d7dea83e7f"><td class="memSeparator" colspan="2"> </td></tr>
108 <tr class="memitem:a7625c48852788be3463d7320b5ea50e5"><td class="memItemLeft" align="right" valign="top"><a id="a7625c48852788be3463d7320b5ea50e5"></a>
109 void </td><td class="memItemRight" valign="bottom"><b>recreate</b> (const <a class="el" href="classboost_1_1gil_1_1point.html">point_t</a> &dims, unsigned alignment=1)</td></tr>
110 <tr class="separator:a7625c48852788be3463d7320b5ea50e5"><td class="memSeparator" colspan="2"> </td></tr>
111 <tr class="memitem:a31a2d04ff9175ac5ddc7a82cde18d8c2"><td class="memItemLeft" align="right" valign="top"><a id="a31a2d04ff9175ac5ddc7a82cde18d8c2"></a>
112 void </td><td class="memItemRight" valign="bottom"><b>recreate</b> (x_coord_t width, y_coord_t height, unsigned alignment=1)</td></tr>
113 <tr class="separator:a31a2d04ff9175ac5ddc7a82cde18d8c2"><td class="memSeparator" colspan="2"> </td></tr>
114 <tr class="memitem:a01929e1ce958f3b0258d24a6cfe90bee"><td class="memItemLeft" align="right" valign="top"><a id="a01929e1ce958f3b0258d24a6cfe90bee"></a>
115 std::size_t </td><td class="memItemRight" valign="bottom"><b>num_channels</b> () const</td></tr>
116 <tr class="separator:a01929e1ce958f3b0258d24a6cfe90bee"><td class="memSeparator" colspan="2"> </td></tr>
117 <tr class="memitem:ae8ab598c540ffef16daf364f7aa87c21"><td class="memItemLeft" align="right" valign="top"><a id="ae8ab598c540ffef16daf364f7aa87c21"></a>
118 <a class="el" href="classboost_1_1gil_1_1point.html">point_t</a> </td><td class="memItemRight" valign="bottom"><b>dimensions</b> () const</td></tr>
119 <tr class="separator:ae8ab598c540ffef16daf364f7aa87c21"><td class="memSeparator" colspan="2"> </td></tr>
120 <tr class="memitem:add9c490d2545adf2d1f85b84958c167c"><td class="memItemLeft" align="right" valign="top"><a id="add9c490d2545adf2d1f85b84958c167c"></a>
121 x_coord_t </td><td class="memItemRight" valign="bottom"><b>width</b> () const</td></tr>
122 <tr class="separator:add9c490d2545adf2d1f85b84958c167c"><td class="memSeparator" colspan="2"> </td></tr>
123 <tr class="memitem:a7dd7e3c9d94dc1ab42b6d04b39ab1201"><td class="memItemLeft" align="right" valign="top"><a id="a7dd7e3c9d94dc1ab42b6d04b39ab1201"></a>
124 y_coord_t </td><td class="memItemRight" valign="bottom"><b>height</b> () const</td></tr>
125 <tr class="separator:a7dd7e3c9d94dc1ab42b6d04b39ab1201"><td class="memSeparator" colspan="2"> </td></tr>
127 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
128 <div class="textblock"><h3>template<typename Images><br />
129 class boost::gil::any_image< Images ></h3>
131 <p>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>. </p>
132 <p>Represents an image whose type (color space, layout, planar/interleaved organization, etc) can be specified at run time. It is the runtime equivalent of <code>image</code>. Some of the requirements of <a class="el" href="structboost_1_1gil_1_1_image_concept.html" title="2-dimensional image whose value type models PixelValueConcept">ImageConcept</a>, such as the <code>value_type</code> alias cannot be fulfilled, since the language does not allow runtime type specification. Other requirements, such as access to the pixels, would be inefficient to provide. Thus <code><a class="el" href="classboost_1_1gil_1_1any__image.html" title="Represents a run-time specified image. Note it does NOT model ImageConcept.">any_image</a></code> does not fully model <a class="el" href="structboost_1_1gil_1_1_image_concept.html" title="2-dimensional image whose value type models PixelValueConcept">ImageConcept</a>. In particular, its <code>view</code> and <code>const_view</code> methods return <code><a class="el" href="classboost_1_1gil_1_1any__image__view.html" title="Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCon...">any_image_view</a></code>, which does not fully model <a class="el" href="structboost_1_1gil_1_1_image_view_concept.html" title="GIL's 2-dimensional view over immutable GIL pixels.">ImageViewConcept</a>. See <code><a class="el" href="classboost_1_1gil_1_1any__image__view.html" title="Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCon...">any_image_view</a></code> for more. </p>
133 </div><hr/>The documentation for this class was generated from the following file:<ul>
134 <li><a class="el" href="any__image_8hpp_source.html">any_image.hpp</a></li>
136 </div><!-- contents -->
137 <!-- HTML footer for doxygen 1.8.13-->
138 <!-- start footer part -->
140 <address class="footer">
142 Generated by  <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15