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