Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 64337ffa810a396d7988072f4e6b9edc0c705774 / . / www / magick-core.html
blob: f77aecf2034afac8c52a5aaa85d9d38340f33101 [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">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]164 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
165</div>
166<div class="sponsor">
cristy84134182011-06-15 22:59:00 +0000[diff] [blame]167 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
168</div>
169<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]170 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
171</div>
172<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]173 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
174</div>
175<div class="sponsor">
176 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
177</div>
178<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]179 <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]180</div>
181<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]182 <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]183</div>
184<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000[diff] [blame]185 <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]186</div>
187<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]188 <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]189</div>
190<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]191 <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]192</div>
193<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]194 <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]195</div>
196<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]197 <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]198</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]199<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]200 <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]201</div>
202<div class="sponsor">
cristy9be3b602011-06-16 01:35:51 +0000[diff] [blame]203 <a rel="follow" title="Sponsor: Notebook Reparatur" href="http://www.atlasmultimedia.de">Notebook Reparatur</a><!-- 2011100100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]204</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]205</div>
206</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]207</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]208
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]209<div class="eastbar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]210
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]211</div>
212
213<div class="main">
214
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]215<h1>MagickCore C API</h1>
216
217<div class="doc-section">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]218
219<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>
220
221<ul>
222 <li><a href="../www/api/magick.html">Initialize or Destroy the ImageMagick Environment</a></li>
223 <li><a href="../www/api/constitute.html">Constitute an Image</a></li>
224 <li><a href="../www/api/composite.html">Composite an Image</a></li>
225 <li><a href="../www/api/image.html">Image Methods</a></li>
226 <li><a href="../www/api/color.html">Count the Colors in an Image</a></li>
cristy43d0f4d2009-09-17 19:35:37 +0000[diff] [blame]227 <li><a href="../www/api/colormap.html">Colormap Methods</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]228 <li><a href="../www/api/distort.html">Image Distortions</a></li>
229 <li><a href="../www/api/layer.html">Dealing with Image Layers</a></li>
230 <li><a href="../www/api/profile.html">Dealing with Image Profiles</a></li>
231 <li><a href="../www/api/quantize.html">Reduce the Number of Unique Colors in an Image</a></li>
232 <li><a href="../www/api/histogram.html">Image Histograms</a></li>
233 <li><a href="../www/api/segment.html">Segment an Image with Thresholding Fuzzy c-Means</a></li>
234 <li><a href="../www/api/resize.html">Resize an Image</a></li>
235 <li><a href="../www/api/transform.html">Transform an Image</a></li>
236 <li><a href="../www/api/shear.html">Shear or Rotate an Image by an Arbitrary Angle</a></li>
237 <li><a href="../www/api/enhance.html">Enhance an Image</a></li>
238 <li><a href="../www/api/effect.html">Add an Effect</a></li>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]239 <li><a href="../www/api/morphology.html">Morphological Erosions, Dilations, Openings, and Closings</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]240 <li><a href="../www/api/fx.html">Add a Special Effect</a></li>
241 <li><a href="../www/api/decorate.html">Decorate an Image</a></li>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]242 <li><a href="../www/api/attribute.html">Get/Set an Image Attribute</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]243 <li><a href="../www/api/property.html">Get/Set Image Properties</a></li>
cristy3e2860c2010-01-24 01:36:30 +0000[diff] [blame]244 <li><a href="../www/api/statistic.html">Get Image Statistics</a></li>
245 <li><a href="../www/api/feature.html">Get Image Features</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]246 <li><a href="../www/api/annotate.html">Annotate an Image</a></li>
247 <li><a href="../www/api/paint.html">Paint on an Image</a></li>
248 <li><a href="../www/api/draw.html">Draw on an Image</a></li>
249 <li><a href="../www/api/montage.html">Create an Image Thumbnail</a></li>
250 <li><a href="../www/api/fourier.html">Compute the discrete Fourier transform (DFT)</a></li>
251 <li><a href="../www/api/compare.html">Compare an Image to a Reconstructed Image</a></li>
252 <li><a href="../www/api/display.html">Interactively Display and Edit an Image</a></li>
253 <li><a href="../www/api/animate.html">Interactively Animate an Image Sequence</a></li>
254 <li><a href="../www/api/cipher.html">Convert to and from Cipher Pixels</a></li>
255 <li><a href="../www/api/list.html">Working with Image Lists</a></li>
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]256 <li><a href="../www/api/image-view.html">Image View Methods</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]257 <li><a href="../www/api/cache.html">Get or Set Image Pixels</a></li>
258 <li><a href="../www/api/cache-view.html">Working with Cache Views</a></li>
259 <li><a href="../www/api/stream.html">The Pixel FIFO</a></li>
260 <li><a href="../www/api/blob.html">Read or Write Binary Large OBjects</a></li>
261 <li><a href="../www/api/module.html">Loadable Modules</a></li>
262 <li><a href="../www/api/signature.html">Compute a Message Digest for an Image</a></li>
263 <li><a href="../www/api/registry.html">The Image Registry</a></li>
264 <li><a href="../www/api/exception.html">Dealing with Exceptions</a></li>
265 <li><a href="../www/api/memory.html">Memory Allocation</a></li>
266 <li><a href="../www/api/resource.html">Monitor or Limit Resource Consumption</a></li>
267 <li><a href="../www/api/monitor.html">Monitor the Progress of an Image Operation</a></li>
268 <li><a href="../www/api/version.html">Get the Version and Copyrights</a></li>
269 <li><a href="../www/api/deprecate.html">Deprecated Methods</a></li>
270 <li><a href="../www/exception.html">Error and Warning Codes</a></li>
271</ul>
272
273<p>After you write your MagickCore program, compile it like this:</p>
274
cristyd4d64ed2010-08-22 22:19:33 +0000[diff] [blame]275<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]276<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>
277
278<div class="viewport">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]279 #include &lt;stdio.h>
280 #include &lt;stdlib.h>
281 #include &lt;string.h>
282 #include &lt;time.h>
283 #include &lt;magick/MagickCore.h>
284
285 int main(int argc,char **argv)
286 {
287 ExceptionInfo
288 *exception;
289
290 Image
291 *image,
292 *images,
293 *resize_image,
294 *thumbnails;
295
296 ImageInfo
297 *image_info;
298
299 if (argc != 3)
300 {
301 (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
302 exit(0);
303 }
304 /*
305 Initialize the image info structure and read an image.
306 */
307 MagickCoreGenesis(*argv,MagickTrue);
308 exception=AcquireExceptionInfo();
309 image_info=CloneImageInfo((ImageInfo *) NULL);
310 (void) strcpy(image_info-&gt;filename,argv[1]);
311 images=ReadImage(image_info,exception);
312 if (exception-&gt;severity != UndefinedException)
313 CatchException(exception);
314 if (images == (Image *) NULL)
315 exit(1);
316 /*
317 Convert the image to a thumbnail.
318 */
319 thumbnails=NewImageList();
320 while ((image=RemoveFirstImageFromList(&amp;images)) != (Image *) NULL)
321 {
322 resize_image=ResizeImage(image,106,80,LanczosFilter,1.0,exception);
323 if (resize_image == (Image *) NULL)
324 MagickError(exception-&gt;severity,exception-&gt;reason,exception-&gt;description);
325 (void) AppendImageToList(&amp;thumbnails,resize_image);
326 DestroyImage(image);
327 }
328 /*
329 Write the image thumbnail.
330 */
331 (void) strcpy(thumbnails-&gt;filename,argv[2]);
332 WriteImage(image_info,thumbnails);
333 /*
334 Destroy the image thumbnail and exit.
335 */
336 thumbnails=DestroyImageList(thumbnails);
337 image_info=DestroyImageInfo(image_info);
338 exception=DestroyExceptionInfo(exception);
339 MagickCoreTerminus();
340 return(0);
341 }
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]342</div>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]343<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]344
345<div class="viewport">
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]346#include &lt;stdio.h>
347#include &lt;stdlib.h>
348#include &lt;math.h>
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]349#include &lt;magick/MagickCore.h>
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]350
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]351static MagickBooleanType SigmoidalContrast(ImageView *contrast_view,
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]352 const ssize_t y,const int id,void *context)
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]353{
354#define QuantumScale ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
355#define SigmoidalContrast(x) \
356 (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
357
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]358 RectangleInfo
359 extent;
360
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]361 register IndexPacket
362 *indexes;
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]363
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]364 register PixelPacket
365 *pixels;
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]366
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]367 register ssize_t
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]368 x;
369
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]370 extent=GetImageViewExtent(contrast_view);
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]371 pixels=GetImageViewAuthenticPixels(contrast_view);
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]372 for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]373 {
cristyacc04882011-05-04 23:03:43 +0000[diff] [blame]374 SetRedPixelComponent(pixels,RoundToQuantum(SigmoidalContrast(
375 GetRedPixelComponent(pixels)));
376 SetGreenPixelComponent(pixels,RoundToQuantum(SigmoidalContrast(
377 GetGreenPixelComponent(pixels)));
378 SetBluePixelComponent(pixels,RoundToQuantum(SigmoidalContrast(
379 GetBluePixelComponent(pixels)));
380 SetOpacityPixelComponent(pixels,RoundToQuantum(SigmoidalContrast(
381 GetOpacityPixelComponent(pixels)));
382 pixels++;
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]383 }
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]384 indexes=GetImageViewAuthenticIndexes(contrast_view);
385 if (indexes != (IndexPacket *) NULL)
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]386 for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
cristyacc04882011-05-04 23:03:43 +0000[diff] [blame]387 SetIndexPixelComponent(indexes+x,RoundToQuantum(SigmoidalContrast(
388 GetIndexPixelComponent(indexes+x))));
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]389 return(MagickTrue);
390}
391
392int main(int argc,char **argv)
393{
394#define ThrowImageException(image) \
395{ \
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]396 \
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]397 CatchException(exception); \
398 if (contrast_image != (Image *) NULL) \
399 contrast_image=DestroyImage(contrast_image); \
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]400 exit(-1); \
401}
402#define ThrowViewException(view) \
403{ \
404 char \
405 *description; \
406 \
407 ExceptionType \
408 severity; \
409 \
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]410 description=GetImageViewException(view,&amp;severity); \
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]411 (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
412 description=DestroyString(description); \
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]413 exit(-1); \
414}
415
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]416 ExceptionInfo
417 *exception;
418
419 Image
420 *contrast_image;
421
422 ImageInfo
423 *image_info;
424
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]425 ImageView
426 *contrast_view;
427
428 MagickBooleanType
429 status;
430
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]431 if (argc != 3)
432 {
433 (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
434 exit(0);
435 }
436 /*
437 Read an image.
438 */
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]439 MagickCoreGenesis(*argv,MagickTrue);
440 image_info=AcquireImageInfo();
441 (void) CopyMagickString(image_info->filename,argv[1],MaxTextExtent);
442 exception=AcquireExceptionInfo();
443 contrast_image=ReadImage(image_info,exception);
444 if (contrast_image == (Image *) NULL)
445 ThrowImageException(contrast_image);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]446 /*
447 Sigmoidal non-linearity contrast control.
448 */
449 contrast_view=NewImageView(contrast_image);
450 if (contrast_view == (ImageView *) NULL)
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]451 ThrowImageException(contrast_image);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]452 status=UpdateImageViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
453 if (status == MagickFalse)
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]454 ThrowImageException(contrast_image);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]455 contrast_view=DestroyImageView(contrast_view);
456 /*
457 Write the image then destroy it.
458 */
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]459 status=WriteImages(image_info,contrast_image,argv[2],exception);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]460 if (status == MagickFalse)
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]461 ThrowImageException(contrast_image);
462 contrast_image=DestroyImage(contrast_image);
463 exception=DestroyExceptionInfo(exception);
464 image_info=DestroyImageInfo(image_info);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]465 MagickCoreTerminus();
466 return(0);
467}
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]468</div>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]469</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]470
471</div>
472
473<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]474 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]475 <span id="linkbar-center">
476 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]477 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]478 </span>
479 <span id="linkbar-east">&nbsp;</span>
480 </div>
481 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +0000[diff] [blame]482 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]483 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
484 </div>
485 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]486 <script type="text/javascript">
487 var _gaq = _gaq || [];
488 _gaq.push(['_setAccount', 'UA-17690367-1']);
489 _gaq.push(['_trackPageview']);
490
491 (function() {
492 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
493 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
494 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
495 })();
496 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]497</body>
498</html>