1 <!-- Copyright 2008 Lubomir Bourdev and Hailin Jin
3 Distributed under the Boost Software License, Version 1.0.
4 (See accompanying file LICENSE_1_0.txt or copy at
5 http://www.boost.org/LICENSE_1_0.txt)
9 Copyright 2005-2007 Adobe Systems Incorporated
10 Distributed under the MIT License (see accompanying file LICENSE_1_0_0.txt
11 or a copy at http://stlab.adobe.com/licenses.html)
13 Some files are held under additional license.
14 Please see "http://stlab.adobe.com/licenses.html" for more information.
17 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN"
18 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
19 <html xmlns=
"http://www.w3.org/1999/xhtml" lang=
"en" xml:
lang=
"en">
22 <TITLE>Generic Image Library: any_image Class Template Reference
</TITLE>
23 <META HTTP-EQUIV=
"content-type" CONTENT=
"text/html;charset=ISO-8859-1"/>
24 <LINK TYPE=
"text/css" REL=
"stylesheet" HREF=
"adobe_source.css"/>
27 <table border=
"0" cellspacing=
"0" cellpadding=
"0" style='width:
100%; margin:
0; padding:
0'
><tr>
28 <td width=
"100%" valign=
"top" style='padding-left:
10px; padding-right:
10px; padding-bottom:
10px'
>
29 <div class=
"qindex"><a class=
"qindex" href=
"index.html">Modules
</a>
30 |
<a class=
"qindex" href=
"classes.html">Alphabetical List
</a>
31 |
<a class=
"qindex" href=
"annotated.html">Class List
</a>
32 |
<a class=
"qindex" href=
"dirs.html">Directories
</a>
33 |
<a class=
"qindex" href=
"files.html">File List
</a>
34 |
<a class=
"qindex" href=
"../index.html">GIL Home Page
</a>
37 <!-- Generated by Doxygen 1.5.6 -->
38 <div class=
"navpath"><a class=
"el" href=
"namespaceboost.html">boost
</a>::
<b>gil
</b>::
<a class=
"el" href=
"g_i_l_0018.html">any_image
</a>
40 <div class=
"contents">
41 <h1>any_image Class Template Reference
<br>
43 [
<a class=
"el" href=
"g_i_l_0135.html">Models
</a>]
</small>
44 </h1><!-- doxytag: class="boost::gil::any_image" --><!-- doxytag: inherits="variant< ImageTypes >" --><code>#include
<<a class=
"el" href=
"g_i_l_0002.html">any_image.hpp
</a>></code>
46 <div class=
"dynheader">
47 Inheritance diagram for any_image:
</div>
48 <div class=
"dynsection">
50 <p><center><img src=
"g_i_l_0001.png" usemap=
"#any_image_map" border=
"0" alt=
""></center>
51 <map name=
"any_image_map">
52 <area href=
"g_i_l_0062.html" alt=
"variant< ImageTypes >" shape=
"rect" coords=
"0,0,142,24">
57 <a href=
"g_i_l_0017.html">List of all members.
</a><hr><a name=
"_details"></a><h2>Detailed Description
</h2>
58 <h3>template
<typename ImageTypes
><br>
59 class boost::gil::any_image
< ImageTypes
></h3>
61 Represents a run-time specified
<a class=
"el" href=
"g_i_l_0038.html" title=
"container interface over image view. Models ImageConcept, PixelBasedConcept">image
</a>. Note it does NOT model
<a class=
"el" href=
"g_i_l_0306.html" title=
"2-dimensional image whose value type models PixelValueConcept">ImageConcept
</a>.
63 Represents an
<a class=
"el" href=
"g_i_l_0038.html" title=
"container interface over image view. Models ImageConcept, PixelBasedConcept">image
</a> whose type (color space,
<a class=
"el" href=
"g_i_l_0567.html" title=
"Represents a color space and ordering of channels in memory.">layout
</a>, planar/interleaved organization, etc) can be specified at run time. It is the runtime equivalent of
<code><a class=
"el" href=
"g_i_l_0038.html" title=
"container interface over image view. Models ImageConcept, PixelBasedConcept">image
</a></code>. Some of the requirements of
<a class=
"el" href=
"g_i_l_0306.html" title=
"2-dimensional image whose value type models PixelValueConcept">ImageConcept
</a>, such as the
<code>value_type
</code> typedef 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=
"g_i_l_0018.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=
"g_i_l_0306.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=
"g_i_l_0020.html" title=
"Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCo...">any_image_view
</a></code>, which does not fully model
<a class=
"el" href=
"g_i_l_0308.html" title=
"GIL's 2-dimensional view over immutable GIL pixels.">ImageViewConcept
</a>. See
<code><a class=
"el" href=
"g_i_l_0020.html" title=
"Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCo...">any_image_view
</a></code> for more.
<table border=
"0" cellpadding=
"0" cellspacing=
"0">
65 <tr><td colspan=
"2"><br><h2>Public Types
</h2></td></tr>
66 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"2acd50477b4c80241d1a9a360b9920ff"></a><!-- doxytag: member="boost::gil::any_image::const_view_t" ref="2acd50477b4c80241d1a9a360b9920ff" args="" -->
67 typedef
<a class=
"el" href=
"g_i_l_0020.html">any_image_view
</a><br>
69 detail::images_get_const_views_t
<br>
70 < ImageTypes
>::type
> </td><td class=
"memItemRight" valign=
"bottom"><b>const_view_t
</b></td></tr>
72 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"0e6b59952cd0e8904070f04b5e1fb51f"></a><!-- doxytag: member="boost::gil::any_image::view_t" ref="0e6b59952cd0e8904070f04b5e1fb51f" args="" -->
73 typedef
<a class=
"el" href=
"g_i_l_0020.html">any_image_view
</a><br>
75 detail::images_get_views_t
<br>
76 < ImageTypes
>::type
> </td><td class=
"memItemRight" valign=
"bottom"><b>view_t
</b></td></tr>
78 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"5396c00a891ea52bd233a307bdaf6a64"></a><!-- doxytag: member="boost::gil::any_image::x_coord_t" ref="5396c00a891ea52bd233a307bdaf6a64" args="" -->
79 typedef std::ptrdiff_t
</td><td class=
"memItemRight" valign=
"bottom"><b>x_coord_t
</b></td></tr>
81 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"e21c9a09689df0e5118fd07840e055bb"></a><!-- doxytag: member="boost::gil::any_image::y_coord_t" ref="e21c9a09689df0e5118fd07840e055bb" args="" -->
82 typedef std::ptrdiff_t
</td><td class=
"memItemRight" valign=
"bottom"><b>y_coord_t
</b></td></tr>
84 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"ce54a5224e10a07eb7fc9d9c78c259a0"></a><!-- doxytag: member="boost::gil::any_image::point_t" ref="ce54a5224e10a07eb7fc9d9c78c259a0" args="" -->
85 typedef
<a class=
"el" href=
"g_i_l_0060.html">point2
</a>< std::ptrdiff_t
> </td><td class=
"memItemRight" valign=
"bottom"><b>point_t
</b></td></tr>
87 <tr><td colspan=
"2"><br><h2>Public Member Functions
</h2></td></tr>
88 <tr><td class=
"memTemplParams" nowrap
colspan=
"2"><a class=
"anchor" name=
"b2ab8889c140ac3d25adb661014847db"></a><!-- doxytag: member="boost::gil::any_image::any_image" ref="b2ab8889c140ac3d25adb661014847db" args="(const T &obj)" -->
89 template
<typename T
> </td></tr>
90 <tr><td class=
"memTemplItemLeft" nowrap
align=
"right" valign=
"top"> </td><td class=
"memTemplItemRight" valign=
"bottom"><b>any_image
</b> (const T
&obj)
</td></tr>
92 <tr><td class=
"memTemplParams" nowrap
colspan=
"2"><a class=
"anchor" name=
"6f15d1d344d00eeddf06aaa45815c935"></a><!-- doxytag: member="boost::gil::any_image::any_image" ref="6f15d1d344d00eeddf06aaa45815c935" args="(T &obj, bool do_swap)" -->
93 template
<typename T
> </td></tr>
94 <tr><td class=
"memTemplItemLeft" nowrap
align=
"right" valign=
"top"> </td><td class=
"memTemplItemRight" valign=
"bottom"><b>any_image
</b> (T
&obj, bool do_swap)
</td></tr>
96 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"ac20cb95fc50f10db76f90a3032f6c22"></a><!-- doxytag: member="boost::gil::any_image::any_image" ref="ac20cb95fc50f10db76f90a3032f6c22" args="(const any_image &v)" -->
97 </td><td class=
"memItemRight" valign=
"bottom"><b>any_image
</b> (const
<a class=
"el" href=
"g_i_l_0018.html">any_image
</a> &v)
</td></tr>
99 <tr><td class=
"memTemplParams" nowrap
colspan=
"2"><a class=
"anchor" name=
"2eb3e62b2bb5bc11817a3235d026ed7f"></a><!-- doxytag: member="boost::gil::any_image::operator=" ref="2eb3e62b2bb5bc11817a3235d026ed7f" args="(const T &obj)" -->
100 template
<typename T
> </td></tr>
101 <tr><td class=
"memTemplItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"el" href=
"g_i_l_0018.html">any_image
</a> & </td><td class=
"memTemplItemRight" valign=
"bottom"><b>operator=
</b> (const T
&obj)
</td></tr>
103 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"f1a9aed5bd8bd9f5649a7c7adc9db08c"></a><!-- doxytag: member="boost::gil::any_image::operator=" ref="f1a9aed5bd8bd9f5649a7c7adc9db08c" args="(const any_image &v)" -->
104 <a class=
"el" href=
"g_i_l_0018.html">any_image
</a> & </td><td class=
"memItemRight" valign=
"bottom"><b>operator=
</b> (const
<a class=
"el" href=
"g_i_l_0018.html">any_image
</a> &v)
</td></tr>
106 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"7625c48852788be3463d7320b5ea50e5"></a><!-- doxytag: member="boost::gil::any_image::recreate" ref="7625c48852788be3463d7320b5ea50e5" args="(const point_t &dims, unsigned alignment=1)" -->
107 void
</td><td class=
"memItemRight" valign=
"bottom"><b>recreate
</b> (const
<a class=
"el" href=
"g_i_l_0060.html">point_t
</a> &dims, unsigned alignment=
1)
</td></tr>
109 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"31a2d04ff9175ac5ddc7a82cde18d8c2"></a><!-- doxytag: member="boost::gil::any_image::recreate" ref="31a2d04ff9175ac5ddc7a82cde18d8c2" args="(x_coord_t width, y_coord_t height, unsigned alignment=1)" -->
110 void
</td><td class=
"memItemRight" valign=
"bottom"><b>recreate
</b> (x_coord_t width, y_coord_t height, unsigned alignment=
1)
</td></tr>
112 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"7e7336b5e1b9d3674e5bb27d4adbb46a"></a><!-- doxytag: member="boost::gil::any_image::num_channels" ref="7e7336b5e1b9d3674e5bb27d4adbb46a" args="() const " -->
113 std::size_t
</td><td class=
"memItemRight" valign=
"bottom"><b>num_channels
</b> () const
</td></tr>
115 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"d72453f8233186957b5274e32b593006"></a><!-- doxytag: member="boost::gil::any_image::dimensions" ref="d72453f8233186957b5274e32b593006" args="() const " -->
116 <a class=
"el" href=
"g_i_l_0060.html">point_t
</a> </td><td class=
"memItemRight" valign=
"bottom"><b>dimensions
</b> () const
</td></tr>
118 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"edb657636fdfa1645708f3beaad70d8d"></a><!-- doxytag: member="boost::gil::any_image::width" ref="edb657636fdfa1645708f3beaad70d8d" args="() const " -->
119 x_coord_t
</td><td class=
"memItemRight" valign=
"bottom"><b>width
</b> () const
</td></tr>
121 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"5d84f7f164c70ba5b617ffa1e69f71a1"></a><!-- doxytag: member="boost::gil::any_image::height" ref="5d84f7f164c70ba5b617ffa1e69f71a1" args="() const " -->
122 y_coord_t
</td><td class=
"memItemRight" valign=
"bottom"><b>height
</b> () const
</td></tr>
125 <hr>The documentation for this class was generated from the following file:
<ul>
126 <li><a class=
"el" href=
"g_i_l_0002.html">any_image.hpp
</a></ul>
128 <hr size=
"1"><address style=
"text-align: right;"><small>Generated on Sat May
2 13:
50:
18 2009 for Generic Image Library by
129 <a href=
"http://www.doxygen.org/index.html">
130 <img src=
"doxygen.png" alt=
"doxygen" align=
"middle" border=
"0"></a> 1.5.6 </small></address>