Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 33e524b6b055cf3360d5b0b24e65baf7e9a0ba6a / . / www / magick++.html
blob: 6c5a4e9b475a2a5d4cceeac443cd7534cb4cc852 [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"/>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]11 <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]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"/>
cristye6e84152011-06-06 14:16:49 +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 automagically."/>
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"/>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]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, Image, Processing, Automagically"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]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"/>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]31 <link rel="canonical" href="http://www.imagemagick.org" />
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]32 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]33 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]34 <link rel="stylesheet" type="text/css" href="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.css" media="screen" />
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]35 <style type="text/css" media="all">
36 @import url("../www/magick.css");
37 </style>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]38 <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]39 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"></script>
40 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.pack.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]41 <script type="text/javascript">
42 $(document).ready(function() {
43 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
44 'transitionIn' : 'elastic',
45 'transitionOut' : 'elastic',
46 'overlayShow' : false,
47 'opacity' : true
48 });
49 });
50 </script>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]51</head>
52
53<body id="www-imagemagick-org">
54<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]55<div style="margin: 17px auto; float: left;">
56 <script type="text/javascript">
57 <!--
58 google_ad_client = "pub-3129977114552745";
59 google_ad_slot = "5439289906";
60 google_ad_width = 728;
61 google_ad_height = 90;
62 //-->
63 </script>
64 <script type="text/javascript"
65 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
66 </script>
67</div>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]68<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]69 <img src="../images/logo.jpg"
70 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]71 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]72<a href="../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]73 <img src="../images/sprite.jpg"
74 alt="ImageMagick Sprite"
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]75 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
76</div>
77
78<div class="westbar">
79
80<div class="menu">
81 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
82</div>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]83<div class="menu">
84 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
85</div>
86<div class="sub">
87 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
88</div>
89<div class="sub">
90 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
91</div>
92<div class="sub">
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]93 <a title="Binary Release: iOS" href="../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]94</div>
95<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]96 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
97</div>
98<div class="sep"></div>
99<div class="menu">
100 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
101</div>
102<div class="sub">
103 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
104</div>
105<div class="sub">
106 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
107</div>
108<div class="sub">
109 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
110</div>
111<div class="menu">
112 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
113</div>
114<div class="sub">
115 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
116</div>
117<div class="sub">
118 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
119</div>
120<div class="sub">
121 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
122</div>
123<div class="sub">
124 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
125</div>
126<div class="sep"></div>
127<div class="menu">
128 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
129</div>
130<div class="sub">
131 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
132</div>
133<div class="sub">
134 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
135 </div>
136<div class="menu">
137 <a title="Resources" href="../www/resources.html">Resources</a>
138</div>
139<div class="menu">
140 <a title="Architecture" href="../www/architecture.html">Architecture</a>
141</div>
142<div class="menu">
143 <a title="Download" href="../www/download.html">Download</a>
144</div>
145<div class="sep"></div>
146<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]147 <a title="Search" href="../www/search.html">Search</a>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]148</div>
149<div class="sep"></div>
150<div class="menu">
151 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
152</div>
153<div class="sub">
154 <a title="Site Map: Links" href="../www/links.html">Links</a>
155</div>
156<div class="sep"></div>
157<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]158 <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]159
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]160<a href="http://www.networkredux.com">
cristyaf894d72011-08-06 23:03:10 +0000[diff] [blame]161 <img src="../images/networkredux.png" width="140" height="31" alt="[sponsor]"
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]162 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]163<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]164<div class="sponsor">
cristyaf894d72011-08-06 23:03:10 +0000[diff] [blame]165 <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540s suvalj -->
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]166</div>
167<div class="sponsor">
cristyaf894d72011-08-06 23:03:10 +0000[diff] [blame]168 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]169</div>
170<div class="sponsor">
cristy84134182011-06-15 22:59:00 +0000[diff] [blame]171 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
172</div>
173<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]174 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
175</div>
176<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]177 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
178</div>
179<div class="sponsor">
cristyaf894d72011-08-06 23:03:10 +0000[diff] [blame]180 <a rel="follow" title="Sponsor: Autos part" href="http://www.pkwteile.de/autoteile">Autos part</a><!-- 201112010090s jr@pkwte... -->
181</div>
182<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]183 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
184</div>
185<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]186 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]187</div>
188<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]189 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000[diff] [blame]190</div>
191<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000[diff] [blame]192 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]193</div>
194<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]195 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]196</div>
197<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]198 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]199</div>
200<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]201 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]202</div>
203<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]204 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]205</div>
206<div class="sponsor">
cristy7c011e02011-08-12 17:28:55 +0000[diff] [blame]207 <a rel="follow" title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]208</div>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]209</div>
210</div>
211</div>
212
213<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]214 <div class="g-plusone" data-size="standard" data-count="false"></div>
215</div>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]216
217<div class="main">
218
219<h1>Magick++ C++ API</h1>
220<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>
221<div class="doc-section">
222<a id="intro"></a>
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]223<p>Magick++ is the object-oriented C++ API to the <a href="http://www.imagemagick.org/">ImageMagick</a> image-processing library.</p>
224<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]225Images support implicit reference counting so that copy constructors
226and assignment incur almost no cost. The cost of actually copying an
227image (if necessary) is done just before modification and this copy
228is managed automagically by Magick++. De-referenced copies are
229automagically deleted. The image objects support value (rather than
230pointer) semantics so it is trivial to support multiple generations
231of an image in memory at one time.
232</p>
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]233<p>Magick++ provides integrated support for the <a href="http://www.sgi.com/tech/stl/">Standard
234Template Library</a> (STL) so that the powerful containers available
235(e.g. <a href="http://www.sgi.com/tech/stl/Deque.html">deque</a>,
236<a href="http://www.sgi.com/tech/stl/Vector.html">vector</a>, <a href="http://www.sgi.com/tech/stl/List.html">list</a>,
237and <a href="http://www.sgi.com/tech/stl/Map.html">map</a>)&nbsp; can
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]238be used to write programs similar to those possible with PERL &amp;
239PerlMagick. STL-compatible template versions of ImageMagick's
240list-style operations are provided so that operations may be
241performed on multiple images stored in STL containers.
242</p>
243</div>
244<h2>Documentation</h2>
245<div class="doc-section">
246<a id="documentation"></a>
cristy6bcf48e2011-02-15 19:09:04 +0000[diff] [blame]247<p>Detailed <a href="../www/Magick++/Documentation.html">documentation</a> is
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]248provided for all Magick++ classes, class methods, and template
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]249functions 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]250</div>
251<h2>Obtaining Magick++</h2>
252<a id="get"></a>
253<div class="doc-section">
cristy6bcf48e2011-02-15 19:09:04 +0000[diff] [blame]254<p>Magick++ is included as part of <a href="../index.html">ImageMagick</a>
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]255source releases and may be retrieved via <a href="http://www.imagemagick.org/www/download.html">ftp</a>
256or <a href="http://www.imagemagick.org/www/subversion.html">Subversion</a>.
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]257</p>
258</div>
259<h2>Installation</h2>
260<div class="doc-section">
261<a id="install"></a>
262<p>Once you have the Magick++ sources available, follow these detailed
cristy6bcf48e2011-02-15 19:09:04 +0000[diff] [blame]263<a href="../www/Magick++/Install.html">installation instructions</a> for UNIX and
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]264Windows.
265</p>
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]266<p>A helper script named <kbd>Magick++-config</kbd> is installed
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]267under Unix which assists with recalling compilation options required
268to compile and link programs which use Magick++. For example, the
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]269following command will compile and link the source file <kbd>demo.cpp</kbd>
270to produce the executable <kbd>demo</kbd> (notice that quotes are
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]271backward quotes):
272</p>
273<pre class="text">
274c++ `Magick++-config --cxxflags --cppflags` -O2 -o demo demo.cpp \
275 `Magick++-config --ldflags --libs`
276</pre>
277<p>Windows users may get started by manually editing a project file
278for one of the Magick++ demo programs.
279</p>
280<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>
281<pre class="text">
282int main( int argc, char ** argv) {
283 InitializeMagick(*argv);
284 ...
285</pre>
286<p>This initialization step is not required under Unix, Linux,
287Cygwin, or any other operating environment that supports the notion
288of <em>installing</em> ImageMagick in a known location.
289</p>
290</div>
291<h2>Reporting Bugs</h2>
292<div class="doc-section">
293<a id="bugs"></a>
cristy2d67ddd2011-02-13 15:38:23 +0000[diff] [blame]294<p>Questions regarding usage should be directed to or to report any bugs go to
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]295<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]296</p>
297</div>
298
299</div>
300
301<div id="linkbar">
302 <span id="linkbar-west">&nbsp;</span>
303 <span id="linkbar-center">
304 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
305 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
306 </span>
307 <span id="linkbar-east">&nbsp;</span>
308 </div>
309 <div class="footer">
310 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
311 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
312 </div>
313 <div style="clear: both; margin: 0; width: 100%; "></div>
314 <script type="text/javascript">
315 var _gaq = _gaq || [];
316 _gaq.push(['_setAccount', 'UA-17690367-1']);
317 _gaq.push(['_trackPageview']);
318
319 (function() {
320 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
321 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
322 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
323 })();
324 </script>
325</body>
326</html>