Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / ec6b475b2dcc5fa0e8ecbdc6ffa261abf2e2c268 / . / www / magick++.html
blob: 24fdfb1313a72f314b87cccf21d32af75b2f0dc0 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
5<head>
6 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
7 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
8 <title>ImageMagick: Magick++, C++ API for ImageMagick</title>
9 <meta http-equiv="Content-Language" content="en-US"/>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
11 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
12 <meta name="Application-name" content="ImageMagick"/>
13 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
14 <meta name="Application-url" content="http://www.imagemagick.org"/>
15 <meta name="Generator" content="PHP"/>
16 <meta name="Keywords" content="magick++, c++, api, for, imagemagick, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
17 <meta name="Rating" content="GENERAL"/>
18 <meta name="Robots" content="INDEX, FOLLOW"/>
19 <meta name="Generator" content="ImageMagick Studio LLC"/>
20 <meta name="Author" content="ImageMagick Studio LLC"/>
21 <meta name="Revisit-after" content="2 DAYS"/>
22 <meta name="Resource-type" content="document"/>
23 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
24 <meta name="Distribution" content="Global"/>
25 <link rel="icon" href="../images/wand.png"/>
26 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
27 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
28 <style type="text/css" media="all">
29 @import url("../www/magick.css");
30 </style>
31 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]32 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]44</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../index.html">
49 <img src="../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../images/networkredux.png" alt="[sponsor]"
53 style="margin: 45px auto; border: 0px; float: left;" /></a>
54<a href="http://www.imagemagick.org/discourse-server/">
55 <img src="../images/logo.jpg" alt=""
56 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
57<a href="../index.html">
58 <img src="../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
62<div class="westbar">
63
64<div class="menu">
65 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
66</div>
67<div class="sep"></div>
68<div class="menu">
69 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
82 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
83</div>
84<div class="sub">
85 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
86</div>
87<div class="sub">
88 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
89</div>
90<div class="sub">
91 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
92</div>
93<div class="menu">
94 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
95</div>
96<div class="sub">
97 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
98</div>
99<div class="sub">
100 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
101</div>
102<div class="sub">
103 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
104</div>
105<div class="sub">
106 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
107</div>
108<div class="sep"></div>
109<div class="menu">
110 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
111</div>
112<div class="sub">
113 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
114</div>
115<div class="sub">
116 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
117 </div>
118<div class="menu">
119 <a title="Resources" href="../www/resources.html">Resources</a>
120</div>
121<div class="menu">
122 <a title="Architecture" href="../www/architecture.html">Architecture</a>
123</div>
124<div class="menu">
125 <a title="Download" href="../www/download.html">Download</a>
126</div>
127<div class="sep"></div>
128<div class="menu">
129 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
130</div>
131<div class="sep"></div>
132<div class="menu">
133 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
134</div>
135<div class="sub">
136 <a title="Site Map: Links" href="../www/links.html">Links</a>
137</div>
138<div class="sep"></div>
139<div class="menu">
140 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
141
142<div class="sponsbox">
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame^]143<div class="sponsor">
144 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.html">Web Hosting</a><!-- 201104010090 -->
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]145</div>
146<div class="sponsor">
147 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
148</div>
149<div class="sponsor">
150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame^]155<div class="sponsor">
156 <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011050100025 gabi.schulze-->
157</div>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]158</div>
159</div>
160</div>
161
162<div class="eastbar">
163 <script type="text/javascript">
164 <!--
165 google_ad_client = "pub-3129977114552745";
166 google_ad_slot = "0574824969";
167 google_ad_width = 160;
168 google_ad_height = 600;
169 //-->
170 </script>
171 <script type="text/javascript"
172 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
173 </script>
174</div>
175
176<div class="main">
177
178<h1>Magick++ C++ API</h1>
179<p class="navigation-index">[<a href="#intro">Introduction to Magick++</a> &bull; <a href="#documentation">Documentation</a> &bull; <a href="#get">Obtaining Magick++</a> &bull; <a href="#install">Installation</a> &bull; <a href="#bugs">Reporting Bugs</a>]</p>
180<div class="doc-section">
181<a id="intro"></a>
182<p>Magick++ is the object-oriented C++ API to the <A HREF="http://www.imagemagick.org/">ImageMagick</A> image-processing library.</p>
183<p>Magick++ supports an object model which is inspired by <A HREF="http://www.imagemagick.org/www/perl-magick.html">PerlMagick</A>.
184Images support implicit reference counting so that copy constructors
185and assignment incur almost no cost. The cost of actually copying an
186image (if necessary) is done just before modification and this copy
187is managed automagically by Magick++. De-referenced copies are
188automagically deleted. The image objects support value (rather than
189pointer) semantics so it is trivial to support multiple generations
190of an image in memory at one time.
191</p>
192<p>Magick++ provides integrated support for the <A HREF="http://www.sgi.com/tech/stl/">Standard
193Template Library</A> (STL) so that the powerful containers available
194(e.g. <A HREF="http://www.sgi.com/tech/stl/Deque.html">deque</A>,
195<A HREF="http://www.sgi.com/tech/stl/Vector.html">vector</A>, <A HREF="http://www.sgi.com/tech/stl/List.html">list</A>,
196and <A HREF="http://www.sgi.com/tech/stl/Map.html">map</A>)&nbsp; can
197be used to write programs similar to those possible with PERL &amp;
198PerlMagick. STL-compatible template versions of ImageMagick's
199list-style operations are provided so that operations may be
200performed on multiple images stored in STL containers.
201</p>
202</div>
203<h2>Documentation</h2>
204<div class="doc-section">
205<a id="documentation"></a>
206<p>Detailed <A HREF="../Magick++/Documentation.html">documentation</A> is
207provided for all Magick++ classes, class methods, and template
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]208functions which comprise the API. See a <a href="http://www.imagemagick.org/Magick++/tutorial/Magick++_tutorial.pdf"> Gentle Introduction to Magick++</a> for an introductory tutorial to Magick++. We include the <a href="http://www.imagemagick.org/Magick++/tutorial/Magick++_tutorial.odt" >source</a> if you want to correct, enhance, or expand the tutorial.</p>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]209</p>
210</div>
211<h2>Obtaining Magick++</h2>
212<a id="get"></a>
213<div class="doc-section">
214<p>Magick++ is included as part of <A HREF="../www/index.html">ImageMagick</A>
215source releases and may be retrieved via <A HREF="http://www.imagemagick.org/www/download.html">ftp</A>
216or <A HREF="http://www.imagemagick.org/www/subversion.html">Subversion</A>.
217</p>
218</div>
219<h2>Installation</h2>
220<div class="doc-section">
221<a id="install"></a>
222<p>Once you have the Magick++ sources available, follow these detailed
223<A HREF="../Magick++/Install.html">installation instructions</A> for UNIX and
224Windows.
225</p>
226<p>A helper script named <I>Magick++-config</I> is installed
227under Unix which assists with recalling compilation options required
228to compile and link programs which use Magick++. For example, the
229following command will compile and link the source file <I>demo.cpp</I>
230to produce the executable <I>demo</I> (notice that quotes are
231backward quotes):
232</p>
233<pre class="text">
234c++ `Magick++-config --cxxflags --cppflags` -O2 -o demo demo.cpp \
235 `Magick++-config --ldflags --libs`
236</pre>
237<p>Windows users may get started by manually editing a project file
238for one of the Magick++ demo programs.
239</p>
240<p>Note, under Windows (and possibly the Mac) it may be necessary to initialize the ImageMagick library prior to using the Magick++ library. This initialization is performed by passing the path to the ImageMagick DLLs (assumed to be in the same directory as your program) to the InitializeMagick() function call. This is commonly performed by providing the path to your program (argv[0]) as shown in the following example: </p>
241<pre class="text">
242int main( int argc, char ** argv) {
243 InitializeMagick(*argv);
244 ...
245</pre>
246<p>This initialization step is not required under Unix, Linux,
247Cygwin, or any other operating environment that supports the notion
248of <em>installing</em> ImageMagick in a known location.
249</p>
250</div>
251<h2>Reporting Bugs</h2>
252<div class="doc-section">
253<a id="bugs"></a>
254<p>Please report any bugs via the
255<A HREF="http://www.imagemagick.org/discourse-server/viewforum.html?f=3">Magick++ bug tracking forum</A>.
256Questions regarding usage should be directed to
257<A HREF="http://www.imagemagick.org/discourse-server/viewforum.html?f=1">Magick++ discussion forum</A>.
258</p>
259</div>
260
261</div>
262
263<div id="linkbar">
264 <span id="linkbar-west">&nbsp;</span>
265 <span id="linkbar-center">
266 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
267 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
268 </span>
269 <span id="linkbar-east">&nbsp;</span>
270 </div>
271 <div class="footer">
272 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
273 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
274 </div>
275 <div style="clear: both; margin: 0; width: 100%; "></div>
276 <script type="text/javascript">
277 var _gaq = _gaq || [];
278 _gaq.push(['_setAccount', 'UA-17690367-1']);
279 _gaq.push(['_trackPageview']);
280
281 (function() {
282 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
283 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
284 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
285 })();
286 </script>
287</body>
288</html>