Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / e6e8415823c09ed129e481e0a3bc678324b38c99 / . / www / magick-core.html
blob: 27172c370eee3756bc17293fb536b25666d01cb5 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]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">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]9<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]10 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
11 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]12 <title>ImageMagick: MagickCore, Low-level C API for ImageMagick</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]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."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]18 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]19 <meta name="Generator" content="PHP"/>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame^]20 <meta name="Keywords" content="magickcore, low-level, c, api, for, imagemagick, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Image, Processing, Automagically"/>
cristy3ed852e2009-09-05 21:47:34 +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"/>
cristy7e41fe82010-12-04 23:12:08 +0000[diff] [blame]27 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]28 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]29 <link rel="icon" href="../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]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" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]33 <style type="text/css" media="all">
34 @import url("../www/magick.css");
35 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]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>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]73 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
74</div>
75
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]76<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]77
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]79 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]80</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]81<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]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">
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame^]92 <a title="Binary Release: iOS" href="../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]93</div>
94<div class="sub">
cristybb503372010-05-27 20:51:26 +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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
113<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]114 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115</div>
116<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]117 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118</div>
119<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]120 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121</div>
122<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]123 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]125<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128</div>
129<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]131</div>
132<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134 </div>
135<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]138<div class="menu">
139 <a title="Architecture" href="../www/architecture.html">Architecture</a>
140</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]146 <a title="Search" href="../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]148<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]149<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]150 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]151</div>
152<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]153 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]154</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]155<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]156<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]157 <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]162<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]163<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]164 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
165</div>
166<div class="sponsor">
167 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
168</div>
169<div class="sponsor">
170 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
171</div>
172<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]173 <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]174</div>
175<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]176 <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]177</div>
178<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000[diff] [blame]179 <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]180</div>
181<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]182 <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]183</div>
184<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]185 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]186</div>
187<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]188 <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]189</div>
190<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]191 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]192</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]193<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]194 <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]195</div>
196<div class="sponsor">
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame^]197 <a rel="follow" title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]198</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]199</div>
200</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]201</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]202
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]203<div class="eastbar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]204
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]205</div>
206
207<div class="main">
208
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]209<h1>MagickCore C API</h1>
210
211<div class="doc-section">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]212
213<p>The <a href="../www/api/MagickCore/index.html">MagickCore API</a> is a low-level interface between the C programming language and the ImageMagick image processing libraries and is recommended for wizard-level programmers only. Unlike the <a href="../www/magick-wand.html">MagickWand</a> C API which uses only a few opaque types and accessors, with MagickCore you almost exlusively access the structure members directly. A description of the MagickCore public methods are found here:</p>
214
215<ul>
216 <li><a href="../www/api/magick.html">Initialize or Destroy the ImageMagick Environment</a></li>
217 <li><a href="../www/api/constitute.html">Constitute an Image</a></li>
218 <li><a href="../www/api/composite.html">Composite an Image</a></li>
219 <li><a href="../www/api/image.html">Image Methods</a></li>
220 <li><a href="../www/api/color.html">Count the Colors in an Image</a></li>
cristy43d0f4d2009-09-17 19:35:37 +0000[diff] [blame]221 <li><a href="../www/api/colormap.html">Colormap Methods</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]222 <li><a href="../www/api/distort.html">Image Distortions</a></li>
223 <li><a href="../www/api/layer.html">Dealing with Image Layers</a></li>
224 <li><a href="../www/api/profile.html">Dealing with Image Profiles</a></li>
225 <li><a href="../www/api/quantize.html">Reduce the Number of Unique Colors in an Image</a></li>
226 <li><a href="../www/api/histogram.html">Image Histograms</a></li>
227 <li><a href="../www/api/segment.html">Segment an Image with Thresholding Fuzzy c-Means</a></li>
228 <li><a href="../www/api/resize.html">Resize an Image</a></li>
229 <li><a href="../www/api/transform.html">Transform an Image</a></li>
230 <li><a href="../www/api/shear.html">Shear or Rotate an Image by an Arbitrary Angle</a></li>
231 <li><a href="../www/api/enhance.html">Enhance an Image</a></li>
232 <li><a href="../www/api/effect.html">Add an Effect</a></li>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]233 <li><a href="../www/api/morphology.html">Morphological Erosions, Dilations, Openings, and Closings</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]234 <li><a href="../www/api/fx.html">Add a Special Effect</a></li>
235 <li><a href="../www/api/decorate.html">Decorate an Image</a></li>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]236 <li><a href="../www/api/attribute.html">Get/Set an Image Attribute</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]237 <li><a href="../www/api/property.html">Get/Set Image Properties</a></li>
cristy3e2860c2010-01-24 01:36:30 +0000[diff] [blame]238 <li><a href="../www/api/statistic.html">Get Image Statistics</a></li>
239 <li><a href="../www/api/feature.html">Get Image Features</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]240 <li><a href="../www/api/annotate.html">Annotate an Image</a></li>
241 <li><a href="../www/api/paint.html">Paint on an Image</a></li>
242 <li><a href="../www/api/draw.html">Draw on an Image</a></li>
243 <li><a href="../www/api/montage.html">Create an Image Thumbnail</a></li>
244 <li><a href="../www/api/fourier.html">Compute the discrete Fourier transform (DFT)</a></li>
245 <li><a href="../www/api/compare.html">Compare an Image to a Reconstructed Image</a></li>
246 <li><a href="../www/api/display.html">Interactively Display and Edit an Image</a></li>
247 <li><a href="../www/api/animate.html">Interactively Animate an Image Sequence</a></li>
248 <li><a href="../www/api/cipher.html">Convert to and from Cipher Pixels</a></li>
249 <li><a href="../www/api/list.html">Working with Image Lists</a></li>
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]250 <li><a href="../www/api/image-view.html">Image View Methods</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]251 <li><a href="../www/api/cache.html">Get or Set Image Pixels</a></li>
252 <li><a href="../www/api/cache-view.html">Working with Cache Views</a></li>
253 <li><a href="../www/api/stream.html">The Pixel FIFO</a></li>
254 <li><a href="../www/api/blob.html">Read or Write Binary Large OBjects</a></li>
255 <li><a href="../www/api/module.html">Loadable Modules</a></li>
256 <li><a href="../www/api/signature.html">Compute a Message Digest for an Image</a></li>
257 <li><a href="../www/api/registry.html">The Image Registry</a></li>
258 <li><a href="../www/api/exception.html">Dealing with Exceptions</a></li>
259 <li><a href="../www/api/memory.html">Memory Allocation</a></li>
260 <li><a href="../www/api/resource.html">Monitor or Limit Resource Consumption</a></li>
261 <li><a href="../www/api/monitor.html">Monitor the Progress of an Image Operation</a></li>
262 <li><a href="../www/api/version.html">Get the Version and Copyrights</a></li>
263 <li><a href="../www/api/deprecate.html">Deprecated Methods</a></li>
264 <li><a href="../www/exception.html">Error and Warning Codes</a></li>
265</ul>
266
267<p>After you write your MagickCore program, compile it like this:</p>
268
cristyd4d64ed2010-08-22 22:19:33 +0000[diff] [blame]269<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>cc `MagickCore-config --cflags --cppflags` -O2 core.c \ <br/> `MagickCore-config --ldflags --libs`</span></p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]270<p>Here is a example program that utilizes the MagickCore API to get you started, <a href="../www/source/core.c">core.c</a>. It reads a GIF image, creates a thumbnail, and writes it to disk in the PNG image format.</p>
271
272<div class="viewport">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]273 #include &lt;stdio.h>
274 #include &lt;stdlib.h>
275 #include &lt;string.h>
276 #include &lt;time.h>
277 #include &lt;magick/MagickCore.h>
278
279 int main(int argc,char **argv)
280 {
281 ExceptionInfo
282 *exception;
283
284 Image
285 *image,
286 *images,
287 *resize_image,
288 *thumbnails;
289
290 ImageInfo
291 *image_info;
292
293 if (argc != 3)
294 {
295 (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
296 exit(0);
297 }
298 /*
299 Initialize the image info structure and read an image.
300 */
301 MagickCoreGenesis(*argv,MagickTrue);
302 exception=AcquireExceptionInfo();
303 image_info=CloneImageInfo((ImageInfo *) NULL);
304 (void) strcpy(image_info-&gt;filename,argv[1]);
305 images=ReadImage(image_info,exception);
306 if (exception-&gt;severity != UndefinedException)
307 CatchException(exception);
308 if (images == (Image *) NULL)
309 exit(1);
310 /*
311 Convert the image to a thumbnail.
312 */
313 thumbnails=NewImageList();
314 while ((image=RemoveFirstImageFromList(&amp;images)) != (Image *) NULL)
315 {
316 resize_image=ResizeImage(image,106,80,LanczosFilter,1.0,exception);
317 if (resize_image == (Image *) NULL)
318 MagickError(exception-&gt;severity,exception-&gt;reason,exception-&gt;description);
319 (void) AppendImageToList(&amp;thumbnails,resize_image);
320 DestroyImage(image);
321 }
322 /*
323 Write the image thumbnail.
324 */
325 (void) strcpy(thumbnails-&gt;filename,argv[2]);
326 WriteImage(image_info,thumbnails);
327 /*
328 Destroy the image thumbnail and exit.
329 */
330 thumbnails=DestroyImageList(thumbnails);
331 image_info=DestroyImageInfo(image_info);
332 exception=DestroyExceptionInfo(exception);
333 MagickCoreTerminus();
334 return(0);
335 }
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]336</div>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]337<p><a id="image-view"></a>Now lets perform the same contrast enhancement while taking advantage of our dual or quad-core processing system by running the algorithm in parallel utilizing wand views. The <a href="../www/source/core/sigmoidal-contrast.c">sigmoidal-contrast.c</a> module reads an image, applies sigmoidal non-linearity contrast control, and writes the result to disk just like the previous contrast enhancement program, but now it does its work in parallel (assumes ImageMagick is built with OpenMP support).</p>
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]338
339<div class="viewport">
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]340#include &lt;stdio.h>
341#include &lt;stdlib.h>
342#include &lt;math.h>
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]343#include &lt;magick/MagickCore.h>
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]344
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]345static MagickBooleanType SigmoidalContrast(ImageView *contrast_view,
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]346 const ssize_t y,const int id,void *context)
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]347{
348#define QuantumScale ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
349#define SigmoidalContrast(x) \
350 (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
351
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]352 RectangleInfo
353 extent;
354
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]355 register IndexPacket
356 *indexes;
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]357
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]358 register PixelPacket
359 *pixels;
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]360
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]361 register ssize_t
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]362 x;
363
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]364 extent=GetImageViewExtent(contrast_view);
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]365 pixels=GetImageViewAuthenticPixels(contrast_view);
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]366 for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]367 {
cristyacc04882011-05-04 23:03:43 +0000[diff] [blame]368 SetRedPixelComponent(pixels,RoundToQuantum(SigmoidalContrast(
369 GetRedPixelComponent(pixels)));
370 SetGreenPixelComponent(pixels,RoundToQuantum(SigmoidalContrast(
371 GetGreenPixelComponent(pixels)));
372 SetBluePixelComponent(pixels,RoundToQuantum(SigmoidalContrast(
373 GetBluePixelComponent(pixels)));
374 SetOpacityPixelComponent(pixels,RoundToQuantum(SigmoidalContrast(
375 GetOpacityPixelComponent(pixels)));
376 pixels++;
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]377 }
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]378 indexes=GetImageViewAuthenticIndexes(contrast_view);
379 if (indexes != (IndexPacket *) NULL)
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]380 for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
cristyacc04882011-05-04 23:03:43 +0000[diff] [blame]381 SetIndexPixelComponent(indexes+x,RoundToQuantum(SigmoidalContrast(
382 GetIndexPixelComponent(indexes+x))));
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]383 return(MagickTrue);
384}
385
386int main(int argc,char **argv)
387{
388#define ThrowImageException(image) \
389{ \
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]390 \
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]391 CatchException(exception); \
392 if (contrast_image != (Image *) NULL) \
393 contrast_image=DestroyImage(contrast_image); \
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]394 exit(-1); \
395}
396#define ThrowViewException(view) \
397{ \
398 char \
399 *description; \
400 \
401 ExceptionType \
402 severity; \
403 \
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]404 description=GetImageViewException(view,&amp;severity); \
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]405 (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
406 description=DestroyString(description); \
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]407 exit(-1); \
408}
409
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]410 ExceptionInfo
411 *exception;
412
413 Image
414 *contrast_image;
415
416 ImageInfo
417 *image_info;
418
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]419 ImageView
420 *contrast_view;
421
422 MagickBooleanType
423 status;
424
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]425 if (argc != 3)
426 {
427 (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
428 exit(0);
429 }
430 /*
431 Read an image.
432 */
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]433 MagickCoreGenesis(*argv,MagickTrue);
434 image_info=AcquireImageInfo();
435 (void) CopyMagickString(image_info->filename,argv[1],MaxTextExtent);
436 exception=AcquireExceptionInfo();
437 contrast_image=ReadImage(image_info,exception);
438 if (contrast_image == (Image *) NULL)
439 ThrowImageException(contrast_image);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]440 /*
441 Sigmoidal non-linearity contrast control.
442 */
443 contrast_view=NewImageView(contrast_image);
444 if (contrast_view == (ImageView *) NULL)
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]445 ThrowImageException(contrast_image);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]446 status=UpdateImageViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
447 if (status == MagickFalse)
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]448 ThrowImageException(contrast_image);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]449 contrast_view=DestroyImageView(contrast_view);
450 /*
451 Write the image then destroy it.
452 */
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]453 status=WriteImages(image_info,contrast_image,argv[2],exception);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]454 if (status == MagickFalse)
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]455 ThrowImageException(contrast_image);
456 contrast_image=DestroyImage(contrast_image);
457 exception=DestroyExceptionInfo(exception);
458 image_info=DestroyImageInfo(image_info);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]459 MagickCoreTerminus();
460 return(0);
461}
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]462</div>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]463</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]464
465</div>
466
467<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]468 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]469 <span id="linkbar-center">
470 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]471 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]472 </span>
473 <span id="linkbar-east">&nbsp;</span>
474 </div>
475 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +0000[diff] [blame]476 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]477 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
478 </div>
479 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]480 <script type="text/javascript">
481 var _gaq = _gaq || [];
482 _gaq.push(['_setAccount', 'UA-17690367-1']);
483 _gaq.push(['_trackPageview']);
484
485 (function() {
486 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
487 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
488 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
489 })();
490 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]491</body>
492</html>