PageRenderTime 34ms CodeModel.GetById 17ms app.highlight 11ms RepoModel.GetById 1ms app.codeStats 1ms

/Src/Dependencies/Boost/libs/gil/doc/html/g_i_l_0038.html

http://hadesmem.googlecode.com/
HTML | 156 lines | 107 code | 33 blank | 16 comment | 0 complexity | 3ae14f9779a8143350a33d50283bf9dd MD5 | raw file
  1<!-- Copyright 2008 Lubomir Bourdev and Hailin Jin
  2
  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)
  6  -->
  7
  8<!--
  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)
 12
 13    Some files are held under additional license.
 14    Please see "http://stlab.adobe.com/licenses.html" for more information.
 15-->
 16
 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">
 20
 21<head>
 22    <TITLE>Generic Image Library: 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"/>
 25</head>
 26<body>
 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> 
 35</div>
 36<!-- End Header -->
 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_0038.html">image</a>
 39  </div>
 40<div class="contents">
 41<h1>image Class Template Reference<br>
 42<small>
 43[<a class="el" href="g_i_l_0135.html">Models</a>,&nbsp;<a class="el" href="g_i_l_0182.html">Models</a>]</small>
 44</h1><!-- doxytag: class="boost::gil::image" --><code>#include &lt;<a class="el" href="g_i_l_0223.html">image.hpp</a>&gt;</code>
 45<p>
 46
 47<p>
 48<a href="g_i_l_0037.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
 49<h3>template&lt;typename Pixel, bool IsPlanar, typename Alloc = std::allocator&lt;unsigned char&gt;&gt;<br>
 50 class boost::gil::image&lt; Pixel, IsPlanar, Alloc &gt;</h3>
 51
 52container interface over <a class="el" href="g_i_l_0038.html" title="container interface over image view. Models ImageConcept, PixelBasedConcept">image</a> view. Models <a class="el" href="g_i_l_0306.html" title="2-dimensional image whose value type models PixelValueConcept">ImageConcept</a>, <a class="el" href="g_i_l_0344.html" title="Concept for all pixel-based GIL constructs, such as pixels, iterators, locators,...">PixelBasedConcept</a> 
 53<p>
 54A 2D container whose elements are pixels. It is templated over the <a class="el" href="g_i_l_0599.html" title="Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept...">pixel</a> type, a boolean indicating whether it should be planar, and an optional allocator.<p>
 55Note that its element type does not have to be a <a class="el" href="g_i_l_0599.html" title="Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept...">pixel</a>. <code><a class="el" href="g_i_l_0038.html" title="container interface over image view. Models ImageConcept, PixelBasedConcept">image</a></code> can be instantiated with any <a class="el" href="g_i_l_0376.html">Regular</a> element, in which case it models the weaker <a class="el" href="g_i_l_0364.html" title="2-dimensional container of values">RandomAccess2DImageConcept</a> and does not model <a class="el" href="g_i_l_0344.html" title="Concept for all pixel-based GIL constructs, such as pixels, iterators, locators,...">PixelBasedConcept</a> <table border="0" cellpadding="0" cellspacing="0">
 56<tr><td></td></tr>
 57<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
 58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23a97014299302e1ee96643dbaf3f608"></a><!-- doxytag: member="boost::gil::image::allocator_type" ref="23a97014299302e1ee96643dbaf3f608" args="" -->
 59typedef Alloc::template rebind<br>
 60&lt; unsigned char &gt;::other&nbsp;</td><td class="memItemRight" valign="bottom"><b>allocator_type</b></td></tr>
 61
 62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ce737b4613c456dfc955be0baa3580fb"></a><!-- doxytag: member="boost::gil::image::view_t" ref="ce737b4613c456dfc955be0baa3580fb" args="" -->
 63typedef <a class="el" href="g_i_l_0635.html">view_type_from_pixel</a><br>
 64&lt; Pixel, IsPlanar &gt;::type&nbsp;</td><td class="memItemRight" valign="bottom"><b>view_t</b></td></tr>
 65
 66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="06c555fc448b7f9c2aa28410f80452bb"></a><!-- doxytag: member="boost::gil::image::const_view_t" ref="06c555fc448b7f9c2aa28410f80452bb" args="" -->
 67typedef view_t::const_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_view_t</b></td></tr>
 68
 69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7e4745ceac24bead06763a3c017eba99"></a><!-- doxytag: member="boost::gil::image::point_t" ref="7e4745ceac24bead06763a3c017eba99" args="" -->
 70typedef view_t::point_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>point_t</b></td></tr>
 71
 72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd362058c9e6a8e0b327d9f424c217d1"></a><!-- doxytag: member="boost::gil::image::coord_t" ref="cd362058c9e6a8e0b327d9f424c217d1" args="" -->
 73typedef view_t::coord_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>coord_t</b></td></tr>
 74
 75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9b77b76051f0c45c6f2708063ca235db"></a><!-- doxytag: member="boost::gil::image::value_type" ref="9b77b76051f0c45c6f2708063ca235db" args="" -->
 76typedef view_t::value_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>value_type</b></td></tr>
 77
 78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d1e74f2234f644ee8413a0dbd4fa13c"></a><!-- doxytag: member="boost::gil::image::x_coord_t" ref="7d1e74f2234f644ee8413a0dbd4fa13c" args="" -->
 79typedef coord_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>x_coord_t</b></td></tr>
 80
 81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="22bd17e5b8a8a2d3642e80e2bab7e92e"></a><!-- doxytag: member="boost::gil::image::y_coord_t" ref="22bd17e5b8a8a2d3642e80e2bab7e92e" args="" -->
 82typedef coord_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>y_coord_t</b></td></tr>
 83
 84<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f723fb36aee62ac02924637371797b7a"></a><!-- doxytag: member="boost::gil::image::dimensions" ref="f723fb36aee62ac02924637371797b7a" args="() const " -->
 86const point_t &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensions</b> () const </td></tr>
 87
 88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="edb657636fdfa1645708f3beaad70d8d"></a><!-- doxytag: member="boost::gil::image::width" ref="edb657636fdfa1645708f3beaad70d8d" args="() const " -->
 89x_coord_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>width</b> () const </td></tr>
 90
 91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5d84f7f164c70ba5b617ffa1e69f71a1"></a><!-- doxytag: member="boost::gil::image::height" ref="5d84f7f164c70ba5b617ffa1e69f71a1" args="() const " -->
 92y_coord_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>height</b> () const </td></tr>
 93
 94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ceab6688d7bdc71b3118c91b81e39a7f"></a><!-- doxytag: member="boost::gil::image::image" ref="ceab6688d7bdc71b3118c91b81e39a7f" args="(std::size_t alignment=0, const Alloc alloc_in=Alloc())" -->
 95&nbsp;</td><td class="memItemRight" valign="bottom"><b>image</b> (std::size_t alignment=0, const Alloc alloc_in=Alloc())</td></tr>
 96
 97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d20ce07917c6be964611e2ab87fee52b"></a><!-- doxytag: member="boost::gil::image::image" ref="d20ce07917c6be964611e2ab87fee52b" args="(const point_t &amp;dimensions, std::size_t alignment=0, const Alloc alloc_in=Alloc())" -->
 98&nbsp;</td><td class="memItemRight" valign="bottom"><b>image</b> (const point_t &amp;dimensions, std::size_t alignment=0, const Alloc alloc_in=Alloc())</td></tr>
 99
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="348f4a910ac7d4e217b163874c9f12fd"></a><!-- doxytag: member="boost::gil::image::image" ref="348f4a910ac7d4e217b163874c9f12fd" args="(x_coord_t width, y_coord_t height, std::size_t alignment=0, const Alloc alloc_in=Alloc())" -->
101&nbsp;</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>
102
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9dffedcc688a0c662608dfb3eff21e1b"></a><!-- doxytag: member="boost::gil::image::image" ref="9dffedcc688a0c662608dfb3eff21e1b" args="(const point_t &amp;dimensions, const Pixel &amp;p_in, std::size_t alignment, const Alloc alloc_in=Alloc())" -->
104&nbsp;</td><td class="memItemRight" valign="bottom"><b>image</b> (const point_t &amp;dimensions, const Pixel &amp;p_in, std::size_t alignment, const Alloc alloc_in=Alloc())</td></tr>
105
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="66e1b2ce2346c2e23153924ee97c184c"></a><!-- doxytag: member="boost::gil::image::image" ref="66e1b2ce2346c2e23153924ee97c184c" args="(x_coord_t width, y_coord_t height, const Pixel &amp;p_in, std::size_t alignment, const Alloc alloc_in=Alloc())" -->
107&nbsp;</td><td class="memItemRight" valign="bottom"><b>image</b> (x_coord_t width, y_coord_t height, const Pixel &amp;p_in, std::size_t alignment, const Alloc alloc_in=Alloc())</td></tr>
108
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83f7f90e51d5d2fc0596f53dc1e13d74"></a><!-- doxytag: member="boost::gil::image::image" ref="83f7f90e51d5d2fc0596f53dc1e13d74" args="(const image &amp;img)" -->
110&nbsp;</td><td class="memItemRight" valign="bottom"><b>image</b> (const <a class="el" href="g_i_l_0038.html">image</a> &amp;img)</td></tr>
111
112<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="e60ca37cff7f115e2b18a03d9d2452d1"></a><!-- doxytag: member="boost::gil::image::image" ref="e60ca37cff7f115e2b18a03d9d2452d1" args="(const image&lt; P2, IP2, Alloc2 &gt; &amp;img)" -->
113template&lt;typename P2, bool IP2, typename Alloc2&gt; </td></tr>
114<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>image</b> (const <a class="el" href="g_i_l_0038.html">image</a>&lt; P2, IP2, Alloc2 &gt; &amp;img)</td></tr>
115
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5948ad79aad69674db60be93cd194766"></a><!-- doxytag: member="boost::gil::image::operator=" ref="5948ad79aad69674db60be93cd194766" args="(const image &amp;img)" -->
117<a class="el" href="g_i_l_0038.html">image</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="g_i_l_0038.html">image</a> &amp;img)</td></tr>
118
119<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="50c292f9397a0b41498d8c7a7b3677be"></a><!-- doxytag: member="boost::gil::image::operator=" ref="50c292f9397a0b41498d8c7a7b3677be" args="(const Img &amp;img)" -->
120template&lt;typename Img&gt; </td></tr>
121<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"><a class="el" href="g_i_l_0038.html">image</a> &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (const Img &amp;img)</td></tr>
122
123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="82dff19823db9c80dc337f1d6fc98620"></a><!-- doxytag: member="boost::gil::image::allocator" ref="82dff19823db9c80dc337f1d6fc98620" args="()" -->
124Alloc &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>allocator</b> ()</td></tr>
125
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f3455cee0edcdc28fdafaeb4d5b6b005"></a><!-- doxytag: member="boost::gil::image::allocator" ref="f3455cee0edcdc28fdafaeb4d5b6b005" args="() const " -->
127Alloc const &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>allocator</b> () const </td></tr>
128
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ecbe6d01103834f8178f73465a19d58c"></a><!-- doxytag: member="boost::gil::image::swap" ref="ecbe6d01103834f8178f73465a19d58c" args="(image &amp;img)" -->
130void&nbsp;</td><td class="memItemRight" valign="bottom"><b>swap</b> (<a class="el" href="g_i_l_0038.html">image</a> &amp;img)</td></tr>
131
132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="396c34b4aa20279b4768876a70a1e9d1"></a><!-- doxytag: member="boost::gil::image::recreate" ref="396c34b4aa20279b4768876a70a1e9d1" args="(const point_t &amp;dims, std::size_t alignment=0, const Alloc alloc_in=Alloc())" -->
133void&nbsp;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (const point_t &amp;dims, std::size_t alignment=0, const Alloc alloc_in=Alloc())</td></tr>
134
135<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a86afc772bc55b0cf9ecf698ddff3ad8"></a><!-- doxytag: member="boost::gil::image::recreate" ref="a86afc772bc55b0cf9ecf698ddff3ad8" args="(x_coord_t width, y_coord_t height, std::size_t alignment=0, const Alloc alloc_in=Alloc())" -->
136void&nbsp;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (x_coord_t width, y_coord_t height, std::size_t alignment=0, const Alloc alloc_in=Alloc())</td></tr>
137
138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bbdcce789d20e4b698c28d29ced681c3"></a><!-- doxytag: member="boost::gil::image::recreate" ref="bbdcce789d20e4b698c28d29ced681c3" args="(const point_t &amp;dims, const Pixel &amp;p_in, std::size_t alignment, const Alloc alloc_in=Alloc())" -->
139void&nbsp;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (const point_t &amp;dims, const Pixel &amp;p_in, std::size_t alignment, const Alloc alloc_in=Alloc())</td></tr>
140
141<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b1db1b2b44cb8585d29d220ddfca7665"></a><!-- doxytag: member="boost::gil::image::recreate" ref="b1db1b2b44cb8585d29d220ddfca7665" args="(x_coord_t width, y_coord_t height, const Pixel &amp;p_in, std::size_t alignment, const Alloc alloc_in=Alloc())" -->
142void&nbsp;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (x_coord_t width, y_coord_t height, const Pixel &amp;p_in, std::size_t alignment, const Alloc alloc_in=Alloc())</td></tr>
143
144<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
145<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f0b0c4c1267ee1f0ec635a4b2d00ec98"></a><!-- doxytag: member="boost::gil::image::_view" ref="f0b0c4c1267ee1f0ec635a4b2d00ec98" args="" -->
146view_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>_view</b></td></tr>
147
148</table>
149<hr>The documentation for this class was generated from the following file:<ul>
150<li><a class="el" href="g_i_l_0223.html">image.hpp</a></ul>
151</div>
152<hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:18 2009 for Generic Image Library by&nbsp;
153<a href="http://www.doxygen.org/index.html">
154<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
155</body>
156</html>