Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 1efc1ab178a608af159af3038281939c727a11d2 / . / www / magick-core.html
blob: 0be9eed99c8f4fa41eee8bc458111d475b13ca77 [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"/>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame^]11 <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
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"/>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]31 <link rel="canonical" href="http://www.imagemagick.org" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]32 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]33 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame^]34 <link rel="stylesheet" type="text/css" href="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.css" media="screen" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]35 <style type="text/css" media="all">
36 @import url("../www/magick.css");
37 </style>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]38 <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame^]39 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"></script>
40 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.pack.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]41 <script type="text/javascript">
42 $(document).ready(function() {
43 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
44 'transitionIn' : 'elastic',
45 'transitionOut' : 'elastic',
46 'overlayShow' : false,
47 'opacity' : true
48 });
49 });
50 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]51</head>
52
53<body id="www-imagemagick-org">
54<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]55<div style="margin: 17px auto; float: left;">
56 <script type="text/javascript">
57 <!--
58 google_ad_client = "pub-3129977114552745";
59 google_ad_slot = "5439289906";
60 google_ad_width = 728;
61 google_ad_height = 90;
62 //-->
63 </script>
64 <script type="text/javascript"
65 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
66 </script>
67</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]68<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]69 <img src="../images/logo.jpg"
70 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]71 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]72<a href="../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]73 <img src="../images/sprite.jpg"
74 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]75 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
76</div>
77
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]78<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]79
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]80<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]81 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]83<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]84 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
85</div>
86<div class="sub">
87 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
88</div>
89<div class="sub">
90 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
91</div>
92<div class="sub">
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]93 <a title="Binary Release: iOS" href="../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]94</div>
95<div class="sub">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]96 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
97</div>
98<div class="sep"></div>
99<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
105<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]106 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
108<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]109 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110</div>
111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
114<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
117<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]118 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]119</div>
120<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]121 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122</div>
123<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]124 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]126<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]128 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]129</div>
130<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]131 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132</div>
133<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]134 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]135 </div>
136<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]137 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]138</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]139<div class="menu">
140 <a title="Architecture" href="../www/architecture.html">Architecture</a>
141</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]143 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]145<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]147 <a title="Search" href="../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]149<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]151 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]152</div>
153<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]154 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]156<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]157<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]158 <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]159
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]160<a href="http://www.networkredux.com">
161 <img src="../images/networkredux.png" alt="[sponsor]"
162 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]163<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]164<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]165 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
166</div>
167<div class="sponsor">
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame^]168 <a rel="follow" title="Sponsor: Autos part" href="http://www.pkwteile.de/autoteile">Autos part</a><!-- 201112010090s jr@pkwte... -->
169</div>
170<div class="sponsor">
cristy84134182011-06-15 22:59:00 +0000[diff] [blame]171 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
172</div>
173<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]174 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
175</div>
176<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]177 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
178</div>
179<div class="sponsor">
180 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
181</div>
182<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]183 <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]184</div>
185<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]186 <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]187</div>
188<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000[diff] [blame]189 <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]190</div>
191<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]192 <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]193</div>
194<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]195 <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]196</div>
197<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]198 <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]199</div>
200<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]201 <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]202</div>
203<div class="sponsor">
cristyd48f07c2011-07-09 23:09:26 +0000[diff] [blame]204 <a rel="follow" title="Sponsor: Kaffeemaschinen reparatur" href="http://www.kaffeemaschinen-reparatur.de">Kaffeemaschinen reparatur</a><!-- 2011090100060 Temurbas atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]205</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]206</div>
207</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]208</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]209
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]210<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]211 <div class="g-plusone" data-size="standard" data-count="false"></div>
212</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]213
214<div class="main">
215
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]216<h1>MagickCore C API</h1>
217
218<div class="doc-section">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]219
220<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>
221
222<ul>
223 <li><a href="../www/api/magick.html">Initialize or Destroy the ImageMagick Environment</a></li>
224 <li><a href="../www/api/constitute.html">Constitute an Image</a></li>
225 <li><a href="../www/api/composite.html">Composite an Image</a></li>
226 <li><a href="../www/api/image.html">Image Methods</a></li>
227 <li><a href="../www/api/color.html">Count the Colors in an Image</a></li>
cristy43d0f4d2009-09-17 19:35:37 +0000[diff] [blame]228 <li><a href="../www/api/colormap.html">Colormap Methods</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]229 <li><a href="../www/api/distort.html">Image Distortions</a></li>
230 <li><a href="../www/api/layer.html">Dealing with Image Layers</a></li>
231 <li><a href="../www/api/profile.html">Dealing with Image Profiles</a></li>
232 <li><a href="../www/api/quantize.html">Reduce the Number of Unique Colors in an Image</a></li>
233 <li><a href="../www/api/histogram.html">Image Histograms</a></li>
234 <li><a href="../www/api/segment.html">Segment an Image with Thresholding Fuzzy c-Means</a></li>
235 <li><a href="../www/api/resize.html">Resize an Image</a></li>
236 <li><a href="../www/api/transform.html">Transform an Image</a></li>
237 <li><a href="../www/api/shear.html">Shear or Rotate an Image by an Arbitrary Angle</a></li>
238 <li><a href="../www/api/enhance.html">Enhance an Image</a></li>
239 <li><a href="../www/api/effect.html">Add an Effect</a></li>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]240 <li><a href="../www/api/morphology.html">Morphological Erosions, Dilations, Openings, and Closings</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]241 <li><a href="../www/api/fx.html">Add a Special Effect</a></li>
242 <li><a href="../www/api/decorate.html">Decorate an Image</a></li>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]243 <li><a href="../www/api/attribute.html">Get/Set an Image Attribute</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]244 <li><a href="../www/api/property.html">Get/Set Image Properties</a></li>
cristy3e2860c2010-01-24 01:36:30 +0000[diff] [blame]245 <li><a href="../www/api/statistic.html">Get Image Statistics</a></li>
246 <li><a href="../www/api/feature.html">Get Image Features</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]247 <li><a href="../www/api/annotate.html">Annotate an Image</a></li>
248 <li><a href="../www/api/paint.html">Paint on an Image</a></li>
249 <li><a href="../www/api/draw.html">Draw on an Image</a></li>
250 <li><a href="../www/api/montage.html">Create an Image Thumbnail</a></li>
251 <li><a href="../www/api/fourier.html">Compute the discrete Fourier transform (DFT)</a></li>
252 <li><a href="../www/api/compare.html">Compare an Image to a Reconstructed Image</a></li>
253 <li><a href="../www/api/display.html">Interactively Display and Edit an Image</a></li>
254 <li><a href="../www/api/animate.html">Interactively Animate an Image Sequence</a></li>
255 <li><a href="../www/api/cipher.html">Convert to and from Cipher Pixels</a></li>
256 <li><a href="../www/api/list.html">Working with Image Lists</a></li>
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]257 <li><a href="../www/api/image-view.html">Image View Methods</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]258 <li><a href="../www/api/cache.html">Get or Set Image Pixels</a></li>
259 <li><a href="../www/api/cache-view.html">Working with Cache Views</a></li>
260 <li><a href="../www/api/stream.html">The Pixel FIFO</a></li>
261 <li><a href="../www/api/blob.html">Read or Write Binary Large OBjects</a></li>
262 <li><a href="../www/api/module.html">Loadable Modules</a></li>
263 <li><a href="../www/api/signature.html">Compute a Message Digest for an Image</a></li>
264 <li><a href="../www/api/registry.html">The Image Registry</a></li>
265 <li><a href="../www/api/exception.html">Dealing with Exceptions</a></li>
266 <li><a href="../www/api/memory.html">Memory Allocation</a></li>
267 <li><a href="../www/api/resource.html">Monitor or Limit Resource Consumption</a></li>
268 <li><a href="../www/api/monitor.html">Monitor the Progress of an Image Operation</a></li>
269 <li><a href="../www/api/version.html">Get the Version and Copyrights</a></li>
270 <li><a href="../www/api/deprecate.html">Deprecated Methods</a></li>
271 <li><a href="../www/exception.html">Error and Warning Codes</a></li>
272</ul>
273
274<p>After you write your MagickCore program, compile it like this:</p>
275
cristyd4d64ed2010-08-22 22:19:33 +0000[diff] [blame]276<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]277<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>
278
279<div class="viewport">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]280 #include &lt;stdio.h>
281 #include &lt;stdlib.h>
282 #include &lt;string.h>
283 #include &lt;time.h>
284 #include &lt;magick/MagickCore.h>
285
286 int main(int argc,char **argv)
287 {
288 ExceptionInfo
289 *exception;
290
291 Image
292 *image,
293 *images,
294 *resize_image,
295 *thumbnails;
296
297 ImageInfo
298 *image_info;
299
300 if (argc != 3)
301 {
302 (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
303 exit(0);
304 }
305 /*
306 Initialize the image info structure and read an image.
307 */
308 MagickCoreGenesis(*argv,MagickTrue);
309 exception=AcquireExceptionInfo();
310 image_info=CloneImageInfo((ImageInfo *) NULL);
311 (void) strcpy(image_info-&gt;filename,argv[1]);
312 images=ReadImage(image_info,exception);
313 if (exception-&gt;severity != UndefinedException)
314 CatchException(exception);
315 if (images == (Image *) NULL)
316 exit(1);
317 /*
318 Convert the image to a thumbnail.
319 */
320 thumbnails=NewImageList();
321 while ((image=RemoveFirstImageFromList(&amp;images)) != (Image *) NULL)
322 {
323 resize_image=ResizeImage(image,106,80,LanczosFilter,1.0,exception);
324 if (resize_image == (Image *) NULL)
325 MagickError(exception-&gt;severity,exception-&gt;reason,exception-&gt;description);
326 (void) AppendImageToList(&amp;thumbnails,resize_image);
327 DestroyImage(image);
328 }
329 /*
330 Write the image thumbnail.
331 */
332 (void) strcpy(thumbnails-&gt;filename,argv[2]);
333 WriteImage(image_info,thumbnails);
334 /*
335 Destroy the image thumbnail and exit.
336 */
337 thumbnails=DestroyImageList(thumbnails);
338 image_info=DestroyImageInfo(image_info);
339 exception=DestroyExceptionInfo(exception);
340 MagickCoreTerminus();
341 return(0);
342 }
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]343</div>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]344<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]345
346<div class="viewport">
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]347#include &lt;stdio.h>
348#include &lt;stdlib.h>
349#include &lt;math.h>
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]350#include &lt;magick/MagickCore.h>
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]351
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]352static MagickBooleanType SigmoidalContrast(ImageView *contrast_view,
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]353 const ssize_t y,const int id,void *context)
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]354{
355#define QuantumScale ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
356#define SigmoidalContrast(x) \
357 (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
358
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]359 RectangleInfo
360 extent;
361
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]362 register IndexPacket
363 *indexes;
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]364
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]365 register PixelPacket
366 *pixels;
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]367
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]368 register ssize_t
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]369 x;
370
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]371 extent=GetImageViewExtent(contrast_view);
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]372 pixels=GetImageViewAuthenticPixels(contrast_view);
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]373 for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]374 {
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]375 SetPixelRed(pixels,RoundToQuantum(SigmoidalContrast(GetPixelRed(pixels)));
376 SetPixelGreen(pixels,RoundToQuantum(SigmoidalContrast(GetPixelGreen(pixels)));
377 SetPixelBlue(pixels,RoundToQuantum(SigmoidalContrast(GetPixelBlue(pixels)));
378 SetPixelOpacity(pixels,RoundToQuantum(SigmoidalContrast(GetPixelOpacity(pixels)));
cristyacc04882011-05-04 23:03:43 +0000[diff] [blame]379 pixels++;
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]380 }
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]381 indexes=GetImageViewAuthenticIndexes(contrast_view);
382 if (indexes != (IndexPacket *) NULL)
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]383 for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]384 SetPixelIndex(indexes+x,RoundToQuantum(SigmoidalContrast(GetPixelIndex(indexes+x))));
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]385 return(MagickTrue);
386}
387
388int main(int argc,char **argv)
389{
390#define ThrowImageException(image) \
391{ \
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]392 \
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]393 CatchException(exception); \
394 if (contrast_image != (Image *) NULL) \
395 contrast_image=DestroyImage(contrast_image); \
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]396 exit(-1); \
397}
398#define ThrowViewException(view) \
399{ \
400 char \
401 *description; \
402 \
403 ExceptionType \
404 severity; \
405 \
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]406 description=GetImageViewException(view,&amp;severity); \
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]407 (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
408 description=DestroyString(description); \
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]409 exit(-1); \
410}
411
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]412 ExceptionInfo
413 *exception;
414
415 Image
416 *contrast_image;
417
418 ImageInfo
419 *image_info;
420
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]421 ImageView
422 *contrast_view;
423
424 MagickBooleanType
425 status;
426
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]427 if (argc != 3)
428 {
429 (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
430 exit(0);
431 }
432 /*
433 Read an image.
434 */
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]435 MagickCoreGenesis(*argv,MagickTrue);
436 image_info=AcquireImageInfo();
437 (void) CopyMagickString(image_info->filename,argv[1],MaxTextExtent);
438 exception=AcquireExceptionInfo();
439 contrast_image=ReadImage(image_info,exception);
440 if (contrast_image == (Image *) NULL)
441 ThrowImageException(contrast_image);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]442 /*
443 Sigmoidal non-linearity contrast control.
444 */
445 contrast_view=NewImageView(contrast_image);
446 if (contrast_view == (ImageView *) NULL)
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]447 ThrowImageException(contrast_image);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]448 status=UpdateImageViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
449 if (status == MagickFalse)
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]450 ThrowImageException(contrast_image);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]451 contrast_view=DestroyImageView(contrast_view);
452 /*
453 Write the image then destroy it.
454 */
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]455 status=WriteImages(image_info,contrast_image,argv[2],exception);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]456 if (status == MagickFalse)
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]457 ThrowImageException(contrast_image);
458 contrast_image=DestroyImage(contrast_image);
459 exception=DestroyExceptionInfo(exception);
460 image_info=DestroyImageInfo(image_info);
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]461 MagickCoreTerminus();
462 return(0);
463}
cristy10c87152010-06-26 16:12:21 +0000[diff] [blame]464</div>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]465</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]466
467</div>
468
469<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]470 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]471 <span id="linkbar-center">
472 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]473 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]474 </span>
475 <span id="linkbar-east">&nbsp;</span>
476 </div>
477 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +0000[diff] [blame]478 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]479 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
480 </div>
481 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]482 <script type="text/javascript">
483 var _gaq = _gaq || [];
484 _gaq.push(['_setAccount', 'UA-17690367-1']);
485 _gaq.push(['_trackPageview']);
486
487 (function() {
488 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
489 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
490 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
491 })();
492 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]493</body>
494</html>