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