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