Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / acc048888a55306d4d40f866563c11fa148af415 / . / www / api / mogrify.html
blob: 23339ecda9857361a759bc6c250ef29089806787 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]3<html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]8<head>
9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]11 <title>ImageMagick: MagickWand, C API for ImageMagick: Command-line Interface</title>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]12 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
15 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]16 <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."/>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]17 <meta name="Application-url" content="http://www.imagemagick.org"/>
18 <meta name="Generator" content="PHP"/>
19 <meta name="Keywords" content="magickwc, api, for, imagemagick:, command-line, interface, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
20 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]26 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]27 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]28 <link rel="icon" href="../../images/wand.png"/>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]31 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]32 <style type="text/css" media="all">
33 @import url("../../www/magick.css");
34 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]35 <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]36 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
38 <script type="text/javascript">
39 $(document).ready(function() {
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
41 'transitionIn' : 'elastic',
42 'transitionOut' : 'elastic',
43 'overlayShow' : false,
44 'opacity' : true
45 });
46 });
47 </script>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]48</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]52<div style="margin: 17px auto; float: left;">
53 <script type="text/javascript">
54 <!--
55 google_ad_client = "pub-3129977114552745";
56 google_ad_slot = "5439289906";
57 google_ad_width = 728;
58 google_ad_height = 90;
59 //-->
60 </script>
61 <script type="text/javascript"
62 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
63 </script>
64</div>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]65<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]66 <img src="../../images/logo.jpg"
67 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]68 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]69<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]70 <img src="../../images/sprite.jpg"
71 alt="ImageMagick Sprite"
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]72 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
73</div>
74
75<div class="westbar">
76
77<div class="menu">
78 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
82 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
83</div>
84<div class="sub">
85 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
89</div>
90<div class="sub">
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]91 <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
92</div>
93<div class="sub">
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]94 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
95</div>
96<div class="sep"></div>
97<div class="menu">
98 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
99</div>
100<div class="sub">
101 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
102</div>
103<div class="sub">
104 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
105</div>
106<div class="sub">
107 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
108</div>
109<div class="menu">
110 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
111</div>
112<div class="sub">
113 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
114</div>
115<div class="sub">
116 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
117</div>
118<div class="sub">
119 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
120</div>
121<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]122 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]123</div>
124<div class="sep"></div>
125<div class="menu">
126 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
127</div>
128<div class="sub">
129 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
130</div>
131<div class="sub">
132 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
133 </div>
134<div class="menu">
135 <a title="Resources" href="../../www/resources.html">Resources</a>
136</div>
137<div class="menu">
138 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
139</div>
140<div class="menu">
141 <a title="Download" href="../../www/download.html">Download</a>
142</div>
143<div class="sep"></div>
144<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]145 <a title="Search" href="../../www/search.html">Search</a>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]146</div>
147<div class="sep"></div>
148<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]149 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]150</div>
151<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]152 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]153</div>
154<div class="sep"></div>
155<div class="menu">
156 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
157
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]158<a href="http://www.networkredux.com">
159 <img src="../../images/networkredux.png" alt="[sponsor]"
160 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]161<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]162<div class="sponsor">
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]163 <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201109010090 alexanian media -->
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]164</div>
165<div class="sponsor">
cristy4c54bbb2011-03-17 13:53:13 +0000[diff] [blame]166 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
167</div>
168<div class="sponsor">
cristyf9a6c462011-04-24 14:01:11 +0000[diff] [blame]169 <a 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]170</div>
171<div class="sponsor">
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]172 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristya6d7cf72010-11-07 15:58:34 +0000[diff] [blame]173</div>
174<div class="sponsor">
cristyf9a6c462011-04-24 14:01:11 +0000[diff] [blame]175 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]176</div>
177<div class="sponsor">
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]178 <a title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]179</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]180<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]181 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
182</div>
183<div class="sponsor">
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]184 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
185</div>
186<div class="sponsor">
cristyacc04882011-05-04 23:03:43 +0000[diff] [blame^]187 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]188</div>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]189</div>
190</div>
191</div>
192
193<div class="eastbar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]194
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]195</div>
196
197<div class="main">
198
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]199<h1>Module mogrify Methods</h1>
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]200<p class="navigation-index">[<a href="#MagickCommandGenesis">MagickCommandGenesis</a> &bull; <a href="#** GetImageCache">** GetImageCache</a> &bull; <a href="#** SparseColorOption">** SparseColorOption</a>]</p>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]201
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]202<h2><a href="http://www.imagemagick.org/api/MagickWand/mogrify_8c.html" id="MagickCommandGenesis">MagickCommandGenesis</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]203<div class="doc-section">
204
205<p>MagickCommandGenesis() applies image processing options to an image as prescribed by command line options.</p>
206
207<p>The format of the MagickCommandGenesis method is:</p>
208
209<pre class="code">
210 MagickBooleanType MagickCommandGenesis(ImageInfo *image_info,
211 MagickCommand command,int argc,char **argv,char **metadata,
212 ExceptionInfo *exception)
213</pre>
214
215<p>A description of each parameter follows:</p>
216
217<h5>image_info</h5>
218<p>the image info.</p>
219
220<h5>command</h5>
221<p>Choose from ConvertImageCommand, IdentifyImageCommand, MogrifyImageCommand, CompositeImageCommand, CompareImageCommand, ConjureImageCommand, StreamImageCommand, ImportImageCommand, DisplayImageCommand, or AnimateImageCommand.</p>
222
223<h5>argc</h5>
224<p>Specifies a pointer to an integer describing the number of elements in the argument vector.</p>
225
226<h5>argv</h5>
227<p>Specifies a pointer to a text array containing the command line arguments.</p>
228
229<h5>metadata</h5>
230<p>any metadata is returned here.</p>
231
232<h5>exception</h5>
233<p>return any errors or warnings in this structure.</p>
234
235 </div>
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]236<h2><a href="http://www.imagemagick.org/api/MagickWand/mogrify_8c.html" id="**_GetImageCache">** GetImageCache</a></h2>
237<div class="doc-section">
238
239<p>** GetImageCache() will read an image into a image cache if not already ** present then return the image that is in the cache under that filename. </p>
240 </div>
241<h2><a href="http://www.imagemagick.org/api/MagickWand/mogrify_8c.html" id="**_SparseColorOption">** SparseColorOption</a></h2>
242<div class="doc-section">
243
cristyacc04882011-05-04 23:03:43 +0000[diff] [blame^]244<p>** SparseColorOption() parses the complex -sparse-color argument into an ** an array of floating point values then calls SparseColorImage(). ** Argument is a complex mix of floating-point pixel coodinates, and color ** specifications (or direct floating point numbers). The number of floats ** needed to represent a color varies depending on the current channel ** setting. </p>
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]245 </div>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]246
247</div>
248
249<div id="linkbar">
250 <span id="linkbar-west">&nbsp;</span>
251 <span id="linkbar-center">
252 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
253 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
254 </span>
255 <span id="linkbar-east">&nbsp;</span>
256 </div>
257 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]258 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]259 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
260 </div>
261 <div style="clear: both; margin: 0; width: 100%; "></div>
262 <script type="text/javascript">
263 var _gaq = _gaq || [];
264 _gaq.push(['_setAccount', 'UA-17690367-1']);
265 _gaq.push(['_trackPageview']);
266
267 (function() {
268 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
269 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
270 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
271 })();
272 </script>
273</body>
274</html>