blob: 4bbd0cc19506fdb10ca24c1321b698d8a5629137 [file] [log] [blame]
cristyad41c0c2012-10-31 00:49:28 +00001
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
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">
9<head>
10 <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
cristy8ee7f242013-06-20 16:08:44 +000011 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"/>
cristydcca3fa2010-12-29 21:50:07 +000012 <title>ImageMagick: Magick++, C++ API for ImageMagick</title>
cristy751980d2012-06-03 23:18:35 +000013 <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"/>
cristy8ee7f242013-06-20 16:08:44 +000017 <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition, resize, rotate, shear, distort or transform images automagically."/>
cristy751980d2012-06-03 23:18:35 +000018 <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, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
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"/>
cristy8ee7f242013-06-20 16:08:44 +000027 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
cristy751980d2012-06-03 23:18:35 +000028 <meta name="distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000029 <link rel="icon" href="../images/wand.png"/>
30 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
cristyad41c0c2012-10-31 00:49:28 +000031 <link rel="canonical" href="http://www.imagemagick.org" />
32 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy8ee7f242013-06-20 16:08:44 +000033
cristyad41c0c2012-10-31 00:49:28 +000034 <!-- Add jQuery library -->
cristy8ee7f242013-06-20 16:08:44 +000035 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
cristyad41c0c2012-10-31 00:49:28 +000036
cristy8ee7f242013-06-20 16:08:44 +000037 <!-- Add mousewheel plugin (this is optional) -->
38 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
cristyad41c0c2012-10-31 00:49:28 +000039
40 <!-- Add fancyBox -->
cristy8ee7f242013-06-20 16:08:44 +000041 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen" />
42 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
cristyad41c0c2012-10-31 00:49:28 +000043
cristy8ee7f242013-06-20 16:08:44 +000044 <!-- Optionally add helpers - button, thumbnail and/or media -->
45 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen" />
46 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
47 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
cristyad41c0c2012-10-31 00:49:28 +000048
cristy8ee7f242013-06-20 16:08:44 +000049 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen" />
50 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
51
cristyad41c0c2012-10-31 00:49:28 +000052 <script type="text/javascript">
53 $(document).ready(function() {
54 $(".fancybox").fancybox();
55 });
56 </script>
cristy8ee7f242013-06-20 16:08:44 +000057
cristyad41c0c2012-10-31 00:49:28 +000058 <!-- ImageMagick style -->
cristyad41c0c2012-10-31 00:49:28 +000059 <style type="text/css" media="all">
60 @import url("../www/magick.css");
61 </style>
62</head>
63
64<body id="www-imagemagick-org">
cristy8ee7f242013-06-20 16:08:44 +000065
66<script>
67 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
68 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
69 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
70 })(window,document,'offline-script','//127.0.0.1/analytics.js','ga');
71
72 ga('create', 'UA-40133312-1', 'imagemagick.org');
73 ga('send', 'pageview');
74</script>
75
cristyad41c0c2012-10-31 00:49:28 +000076<div class="titlebar">
77<div style="margin: 17px auto; float: left;">
78 <script type="text/javascript">
79 <!--
80 google_ad_client = "pub-3129977114552745";
81 google_ad_slot = "5439289906";
82 google_ad_width = 728;
83 google_ad_height = 90;
84 //-->
85 </script>
86 <script type="text/javascript"
cristy8ee7f242013-06-20 16:08:44 +000087 src="http://127.0.0.1/pagead/show_ads.js">
cristyad41c0c2012-10-31 00:49:28 +000088 </script>
89</div>
cristy8ee7f242013-06-20 16:08:44 +000090<a href="http://www.imagemagick.org/discourse-server/">
cristyad41c0c2012-10-31 00:49:28 +000091 <img src="../images/logo.jpg"
92 alt="ImageMagick Logo"
93 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
94<a href="../index.html">
95 <img src="../images/sprite.jpg"
96 alt="ImageMagick Sprite"
97 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
98</div>
99
100<div class="westbar">
101
cristydcca3fa2010-12-29 21:50:07 +0000102<div class="menu">
103 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
104</div>
cristydcca3fa2010-12-29 21:50:07 +0000105<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000106 <a title="Binary Releases" href="binary-releases.html">Binary Releases</a>
cristydcca3fa2010-12-29 21:50:07 +0000107</div>
108<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000109 <a title="Binary Release: Unix" href="binary-releases.html#unix">Unix</a>
cristydcca3fa2010-12-29 21:50:07 +0000110</div>
111<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000112 <a title="Binary Release: MacOS X" href="binary-releases.html#macosx">Mac OS X</a>
cristydcca3fa2010-12-29 21:50:07 +0000113</div>
114<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000115 <a title="Binary Release: iOS" href="binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000116</div>
117<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000118 <a title="Binary Release: Windows" href="binary-releases.html#windows">Windows</a>
cristydcca3fa2010-12-29 21:50:07 +0000119</div>
cristyad41c0c2012-10-31 00:49:28 +0000120<div class="sep"></div>
cristydcca3fa2010-12-29 21:50:07 +0000121<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000122 <a title="Command-line Tools" href="command-line-tools.html">Command-line Tools</a>
cristydcca3fa2010-12-29 21:50:07 +0000123</div>
124<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000125 <a title="Command-line Tools: Processing" href="command-line-processing.html">Processing</a>
cristydcca3fa2010-12-29 21:50:07 +0000126</div>
127<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000128 <a title="Command-line Tools: Options" href="command-line-options.html">Options</a>
cristydcca3fa2010-12-29 21:50:07 +0000129</div>
130<div class="sub">
131 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
132</div>
133<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000134 <a title="Program Interfaces" href="api.html">Program Interfaces</a>
cristydcca3fa2010-12-29 21:50:07 +0000135</div>
136<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000137 <a title="Program Interface: MagickWand" href="magick-wand.html">MagickWand</a>
cristydcca3fa2010-12-29 21:50:07 +0000138</div>
139<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000140 <a title="Program Interface: MagickCore" href="magick-core.html">MagickCore</a>
cristydcca3fa2010-12-29 21:50:07 +0000141</div>
142<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000143 <a title="Program Interface: PerlMagick" href="perl-magick.html">PerlMagick</a>
cristydcca3fa2010-12-29 21:50:07 +0000144</div>
145<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000146 <a title="Program Interface: Magick++" href="magick++.html">Magick++</a>
cristydcca3fa2010-12-29 21:50:07 +0000147</div>
cristyad41c0c2012-10-31 00:49:28 +0000148<div class="sep"></div>
cristydcca3fa2010-12-29 21:50:07 +0000149<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000150 <a title="Install from Source" href="install-source.html">Install from Source</a>
cristydcca3fa2010-12-29 21:50:07 +0000151</div>
152<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000153 <a title="Install from Source: Unix" href="install-source.html#unix">Unix</a>
cristydcca3fa2010-12-29 21:50:07 +0000154</div>
155<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000156 <a title="Install from Source: Windows" href="install-source.html#windows">Windows</a>
cristydcca3fa2010-12-29 21:50:07 +0000157 </div>
158<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000159 <a title="Resources" href="resources.html">Resources</a>
cristydcca3fa2010-12-29 21:50:07 +0000160</div>
161<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000162 <a title="Architecture" href="architecture.html">Architecture</a>
cristydcca3fa2010-12-29 21:50:07 +0000163</div>
164<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000165 <a title="Download" href="download.html">Download</a>
cristydcca3fa2010-12-29 21:50:07 +0000166</div>
cristyad41c0c2012-10-31 00:49:28 +0000167<div class="sep"></div>
cristydcca3fa2010-12-29 21:50:07 +0000168<div class="menu">
cristy8ee7f242013-06-20 16:08:44 +0000169 <a title="Search" href="search.html">Search</a>
cristydcca3fa2010-12-29 21:50:07 +0000170</div>
cristyad41c0c2012-10-31 00:49:28 +0000171<div class="sep"></div>
cristydcca3fa2010-12-29 21:50:07 +0000172<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000173 <a title="Site Map" href="sitemap.html">Site Map</a>
cristydcca3fa2010-12-29 21:50:07 +0000174</div>
175<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000176 <a title="Site Map: Links" href="links.html">Links</a>
cristydcca3fa2010-12-29 21:50:07 +0000177</div>
cristyad41c0c2012-10-31 00:49:28 +0000178<div class="sep"></div>
cristyeed6cb62012-01-28 19:38:34 +0000179<div class="menu">
cristy8ee7f242013-06-20 16:08:44 +0000180 <a title="Support ImageMagick Development" href="support.html">Support ImageMagick Development</a>
cristydcca3fa2010-12-29 21:50:07 +0000181</div>
cristyad41c0c2012-10-31 00:49:28 +0000182</div>
183
184<div class="eastbar">
cristyad41c0c2012-10-31 00:49:28 +0000185 <script type="text/javascript">
cristy8ee7f242013-06-20 16:08:44 +0000186 /* <![CDATA[ */
cristyad41c0c2012-10-31 00:49:28 +0000187 (function() {
cristy8ee7f242013-06-20 16:08:44 +0000188 var po = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
189 po.type = 'text/javascript';
190 po.async = true;
191 po.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
192 var script = document.getElementsByTagName('offline-script')[0];
193 script.parentNode.insertBefore(po, script);
cristyad41c0c2012-10-31 00:49:28 +0000194 })();
cristy8ee7f242013-06-20 16:08:44 +0000195 /* ]]> */
cristyad41c0c2012-10-31 00:49:28 +0000196 </script>
cristy8ee7f242013-06-20 16:08:44 +0000197 <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://www.imagemagick.org/"></a></div>
198 <noscript>
199 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
200 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0" /></a>
201 </noscript>
202 <div class="g-plusone" id="gplusone"></div>
203 <script type="text/javascript">
204 /* <![CDATA[ */
205 window.___gcfg = {
206 lang: 'en-US'
207 };
208
209 (function() {
210 var po = document.createElement('offline-script');
211 po.type = 'text/javascript';
212 po.async = true;
213 po.src = 'https://127.0.0.1/js/plusone.js';
214 var script = document.getElementsByTagName('offline-script')[0];
215 script.parentNode.insertBefore(po, script);
216 })();
217 var gplusone = document.getElementById("gplusone");
218 gplusone.setAttribute("data-size","medium");
219 gplusone.setAttribute("data-count","true");
220 /* ]]> */
221 </script>
cristyad41c0c2012-10-31 00:49:28 +0000222</div>
223
224<div class="main">
225
cristydcca3fa2010-12-29 21:50:07 +0000226<h1>Magick++ C++ API</h1>
cristydba8f1d2013-07-28 13:49:24 +0000227<p class="navigation-index">[<a href="magick++.html#intro">Introduction to Magick++</a> &#8226; <a href="magick++.html#documentation">Documentation</a> &#8226; <a href="magick++.html#get">Obtaining Magick++</a> &#8226; <a href="magick++.html#install">Installation</a> &#8226; <a href="magick++.html#bugs">Reporting Bugs</a>]</p>
cristydcca3fa2010-12-29 21:50:07 +0000228<div class="doc-section">
229<a id="intro"></a>
cristy8ee7f242013-06-20 16:08:44 +0000230<p><a href="../api/Magick++/index.html">Magick++ API</a> is the object-oriented C++ API to the <a href="http://www.imagemagick.org/">ImageMagick</a> image-processing library.</p>
231<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 +0000232Images support implicit reference counting so that copy constructors
233and assignment incur almost no cost. The cost of actually copying an
234image (if necessary) is done just before modification and this copy
235is managed automagically by Magick++. De-referenced copies are
236automagically deleted. The image objects support value (rather than
237pointer) semantics so it is trivial to support multiple generations
238of an image in memory at one time.
239</p>
cristy2bd2a982011-02-15 00:52:58 +0000240<p>Magick++ provides integrated support for the <a href="http://www.sgi.com/tech/stl/">Standard
241Template Library</a> (STL) so that the powerful containers available
242(e.g. <a href="http://www.sgi.com/tech/stl/Deque.html">deque</a>,
243<a href="http://www.sgi.com/tech/stl/Vector.html">vector</a>, <a href="http://www.sgi.com/tech/stl/List.html">list</a>,
cristyac1b4322013-07-28 13:58:06 +0000244and <a href="http://www.sgi.com/tech/stl/Map.html">map</a>) can
cristydcca3fa2010-12-29 21:50:07 +0000245be used to write programs similar to those possible with PERL &amp;
246PerlMagick. STL-compatible template versions of ImageMagick's
247list-style operations are provided so that operations may be
248performed on multiple images stored in STL containers.
249</p>
250</div>
251<h2>Documentation</h2>
252<div class="doc-section">
253<a id="documentation"></a>
cristy8ee7f242013-06-20 16:08:44 +0000254<p>Detailed <a href="../api/magick++-classes.html">documentation</a> is
cristydcca3fa2010-12-29 21:50:07 +0000255provided for all Magick++ classes, class methods, and template
cristy361f4662010-12-31 23:02:52 +0000256functions 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 +0000257</div>
258<h2>Obtaining Magick++</h2>
259<a id="get"></a>
260<div class="doc-section">
cristy6bcf48e2011-02-15 19:09:04 +0000261<p>Magick++ is included as part of <a href="../index.html">ImageMagick</a>
cristy8ee7f242013-06-20 16:08:44 +0000262source releases and may be retrieved via <a href="http://www.imagemagick.org/www/download.html">ftp</a>
263or <a href="http://www.imagemagick.org/www/subversion.html">Subversion</a>.
cristydcca3fa2010-12-29 21:50:07 +0000264</p>
265</div>
266<h2>Installation</h2>
267<div class="doc-section">
268<a id="install"></a>
269<p>Once you have the Magick++ sources available, follow these detailed
cristy8ee7f242013-06-20 16:08:44 +0000270<a href="../Magick++/Install.html">installation instructions</a> for UNIX and
cristydcca3fa2010-12-29 21:50:07 +0000271Windows.
272</p>
cristy751980d2012-06-03 23:18:35 +0000273</div>
274<h2>Usage</h2>
275<div class="doc-section">
cristy8ee7f242013-06-20 16:08:44 +0000276<p>A helper script named <code>Magick++-config</code> is installed
cristydcca3fa2010-12-29 21:50:07 +0000277under Unix which assists with recalling compilation options required
278to compile and link programs which use Magick++. For example, the
cristy8ee7f242013-06-20 16:08:44 +0000279following command will compile and link the source file <code>demo.cpp</code>
280to produce the executable <code>demo</code> (notice that quotes are
cristydcca3fa2010-12-29 21:50:07 +0000281backward quotes):
282</p>
283<pre class="text">
284c++ `Magick++-config --cxxflags --cppflags` -O2 -o demo demo.cpp \
285 `Magick++-config --ldflags --libs`
286</pre>
287<p>Windows users may get started by manually editing a project file
288for one of the Magick++ demo programs.
289</p>
290<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>
291<pre class="text">
292int main( int argc, char ** argv) {
293 InitializeMagick(*argv);
294 ...
295</pre>
296<p>This initialization step is not required under Unix, Linux,
297Cygwin, or any other operating environment that supports the notion
298of <em>installing</em> ImageMagick in a known location.
299</p>
300</div>
301<h2>Reporting Bugs</h2>
302<div class="doc-section">
303<a id="bugs"></a>
cristy2d67ddd2011-02-13 15:38:23 +0000304<p>Questions regarding usage should be directed to or to report any bugs go to
cristy6ad765e2013-02-24 22:14:01 +0000305<a href="http://www.imagemagick.org/discourse-server/viewforum.html?f=23">Magick++ bug tracking forum</a>.
cristydcca3fa2010-12-29 21:50:07 +0000306</p>
307</div>
cristyad41c0c2012-10-31 00:49:28 +0000308
309</div>
310
311<div id="linkbar">
cristyac1b4322013-07-28 13:58:06 +0000312 <span id="linkbar-west"> </span>
cristy8ee7f242013-06-20 16:08:44 +0000313
cristyad41c0c2012-10-31 00:49:28 +0000314 <span id="linkbar-center">
cristydba8f1d2013-07-28 13:49:24 +0000315 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &#8226;
316 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> &#8226;
cristy8ee7f242013-06-20 16:08:44 +0000317 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
cristyad41c0c2012-10-31 00:49:28 +0000318 </span>
cristyac1b4322013-07-28 13:58:06 +0000319 <span id="linkbar-east"> </span>
cristyad41c0c2012-10-31 00:49:28 +0000320 </div>
321 <div class="footer">
cristyac1b4322013-07-28 13:58:06 +0000322 <span id="footer-west">© 1999-2013 ImageMagick Studio LLC</span>
cristyad41c0c2012-10-31 00:49:28 +0000323 <span id="footer-east"> <a href="contact.html">Contact the Wizards</a></span>
324 </div>
325 <div style="clear: both; margin: 0; width: 100%; "></div>
cristyad41c0c2012-10-31 00:49:28 +0000326</body>
327</html>