Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / da16f16767eb31921af855f17bda465fffc4e000 / . / www / api / transform.html
blob: 859263d8a9ca3c73b3b56d6adbd5a2a48daf68e7 [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">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]8<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]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: MagickCore, C API for ImageMagick: Transform an Image</title>
cristy3ed852e2009-09-05 21:47:34 +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"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]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."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]17 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]18 <meta name="Generator" content="PHP"/>
19 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, transform, an, image, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy3ed852e2009-09-05 21:47:34 +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"/>
cristy3c98a4f2010-08-13 20:09:41 +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" />
cristy3c98a4f2010-08-13 20:09:41 +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>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]48</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
52<a href="../../index.html">
53 <img src="../../images/script.png" alt="[ImageMagick]"
54 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
55<a href="http://www.networkredux.com">
56 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]57 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]58<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]59 <img src="../../images/logo.jpg"
60 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]61 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]62<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]63 <img src="../../images/sprite.jpg"
64 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
66</div>
67
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]68<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]70<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]73<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]74<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]75 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
79</div>
80<div class="sub">
81 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
82</div>
83<div class="sub">
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame^]84 <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
85</div>
86<div class="sub">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]87 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
88</div>
89<div class="sep"></div>
90<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92</div>
93<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</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="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</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="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</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="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
114<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]115 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]122 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
124<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126 </div>
127<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]128 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]129</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]130<div class="menu">
131 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
132</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]133<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]134 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]135</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]136<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]138 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]140<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]142 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
144<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]145 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]149 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150
151<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]152<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]153 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
154</div>
155<div class="sponsor">
156 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
157</div>
158<div class="sponsor">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]159 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]160</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]161<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]162 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy5c4585b2010-11-11 00:13:57 +0000[diff] [blame]163</div>
164<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]165 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
166</div>
167<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]168 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
169</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]170<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]171 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
172</div>
173<div class="sponsor">
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame^]174 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011050100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]175</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]176</div>
177</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]178</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]179
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]180<div class="eastbar">
181 <script type="text/javascript">
182 <!--
183 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]184 google_ad_slot = "0574824969";
185 google_ad_width = 160;
186 google_ad_height = 600;
187 //-->
188 </script>
189 <script type="text/javascript"
190 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
191 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]192</div>
193
194<div class="main">
195
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]196<h1>Module transform Methods</h1>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]197<p class="navigation-index">[<a href="#ChopImage">ChopImage</a> &bull; <a href="#CropImage">CropImage</a> &bull; <a href="#ExcerptImage">ExcerptImage</a> &bull; <a href="#ExtentImage">ExtentImage</a> &bull; <a href="#FlipImage">FlipImage</a> &bull; <a href="#FlopImage">FlopImage</a> &bull; <a href="#RollImage">RollImage</a> &bull; <a href="#ShaveImage">ShaveImage</a> &bull; <a href="#SpliceImage">SpliceImage</a> &bull; <a href="#TransformImage">TransformImage</a> &bull; <a href="#TransformImages">TransformImages</a> &bull; <a href="#TransposeImage">TransposeImage</a> &bull; <a href="#TransverseImage">TransverseImage</a> &bull; <a href="#TrimImage">TrimImage</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]198
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]199<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ChopImage">ChopImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]200<div class="doc-section">
201
202<p>ChopImage() removes a region of an image and collapses the image to occupy the removed portion.</p>
203
204<p>The format of the ChopImage method is:</p>
205
206<pre class="code">
207 Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
208 ExceptionInfo *exception)
209</pre>
210
211<p>A description of each parameter follows:</p>
212
213<h5>image</h5>
214<p>the image.</p>
215
216<h5>chop_info</h5>
217<p>Define the region of the image to chop.</p>
218
219<h5>exception</h5>
220<p>return any errors or warnings in this structure.</p>
221
222 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]223<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="CropImage">CropImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]224<div class="doc-section">
225
226<p>CropImage() extracts a region of the image starting at the offset defined by geometry.</p>
227
228<p>The format of the CropImage method is:</p>
229
230<pre class="code">
231 Image *CropImage(const Image *image,const RectangleInfo *geometry,
232 ExceptionInfo *exception)
233</pre>
234
235<p>A description of each parameter follows:</p>
236
237<h5>image</h5>
238<p>the image.</p>
239
240<h5>geometry</h5>
241<p>Define the region of the image to crop with members x, y, width, and height.</p>
242
243<h5>exception</h5>
244<p>return any errors or warnings in this structure.</p>
245
246 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]247<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ExcerptImage">ExcerptImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]248<div class="doc-section">
249
250<p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p>
251
252<p>The format of the ExcerptImage method is:</p>
253
254<pre class="code">
255 Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
256 ExceptionInfo *exception)
257</pre>
258
259<p>A description of each parameter follows:</p>
260
261<h5>image</h5>
262<p>the image.</p>
263
264<h5>geometry</h5>
265<p>Define the region of the image to extend with members x, y, width, and height.</p>
266
267<h5>exception</h5>
268<p>return any errors or warnings in this structure.</p>
269
270 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]271<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ExtentImage">ExtentImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]272<div class="doc-section">
273
274<p>ExtentImage() extends the image as defined by the geometry, gravity, and image background color. Set the (x,y) offset of the geometry to move the original image relative to the extended image.</p>
275
276<p>The format of the ExtentImage method is:</p>
277
278<pre class="code">
279 Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
280 ExceptionInfo *exception)
281</pre>
282
283<p>A description of each parameter follows:</p>
284
285<h5>image</h5>
286<p>the image.</p>
287
288<h5>geometry</h5>
289<p>Define the region of the image to extend with members x, y, width, and height.</p>
290
291<h5>exception</h5>
292<p>return any errors or warnings in this structure.</p>
293
294 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]295<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="FlipImage">FlipImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]296<div class="doc-section">
297
298<p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p>
299
300<p>The format of the FlipImage method is:</p>
301
302<pre class="code">
303 Image *FlipImage(const Image *image,ExceptionInfo *exception)
304</pre>
305
306<p>A description of each parameter follows:</p>
307
308<h5>image</h5>
309<p>the image.</p>
310
311<h5>exception</h5>
312<p>return any errors or warnings in this structure.</p>
313
314 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]315<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="FlopImage">FlopImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]316<div class="doc-section">
317
318<p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p>
319
320<p>The format of the FlopImage method is:</p>
321
322<pre class="code">
323 Image *FlopImage(const Image *image,ExceptionInfo *exception)
324</pre>
325
326<p>A description of each parameter follows:</p>
327
328<h5>image</h5>
329<p>the image.</p>
330
331<h5>exception</h5>
332<p>return any errors or warnings in this structure.</p>
333
334 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]335<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="RollImage">RollImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]336<div class="doc-section">
337
338<p>RollImage() offsets an image as defined by x_offset and y_offset.</p>
339
340<p>The format of the RollImage method is:</p>
341
342<pre class="code">
343 Image *RollImage(const Image *image,const ssize_t x_offset,
344 const ssize_t y_offset,ExceptionInfo *exception)
345</pre>
346
347<p>A description of each parameter follows:</p>
348
349<h5>image</h5>
350<p>the image.</p>
351
352<h5>x_offset</h5>
353<p>the number of columns to roll in the horizontal direction.</p>
354
355<h5>y_offset</h5>
356<p>the number of rows to roll in the vertical direction.</p>
357
358<h5>exception</h5>
359<p>return any errors or warnings in this structure.</p>
360
361 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]362<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ShaveImage">ShaveImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]363<div class="doc-section">
364
365<p>ShaveImage() shaves pixels from the image edges. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.</p>
366
367<p>The format of the ShaveImage method is:</p>
368
369<pre class="code">
370 Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
371 ExceptionInfo *exception)
372</pre>
373
374<p>A description of each parameter follows:</p>
375
376<h5>shave_image</h5>
377<p>Method ShaveImage returns a pointer to the shaved image. A null image is returned if there is a memory shortage or if the image width or height is zero.</p>
378
379<h5>image</h5>
380<p>the image.</p>
381
382<h5>shave_info</h5>
383<p>Specifies a pointer to a RectangleInfo which defines the region of the image to crop.</p>
384
385<h5>exception</h5>
386<p>return any errors or warnings in this structure.</p>
387
388 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]389<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="SpliceImage">SpliceImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]390<div class="doc-section">
391
392<p>SpliceImage() splices a solid color into the image as defined by the geometry.</p>
393
394<p>The format of the SpliceImage method is:</p>
395
396<pre class="code">
397 Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
398 ExceptionInfo *exception)
399</pre>
400
401<p>A description of each parameter follows:</p>
402
403<h5>image</h5>
404<p>the image.</p>
405
406<h5>geometry</h5>
407<p>Define the region of the image to splice with members x, y, width, and height.</p>
408
409<h5>exception</h5>
410<p>return any errors or warnings in this structure.</p>
411
412 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]413<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransformImage">TransformImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]414<div class="doc-section">
415
416<p>TransformImage() is a convenience method that behaves like ResizeImage() or CropImage() but accepts scaling and/or cropping information as a region geometry specification. If the operation fails, the original image handle is returned.</p>
417
418<p>The format of the TransformImage method is:</p>
419
420<pre class="code">
421 MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
422 const char *image_geometry)
423</pre>
424
425<p>A description of each parameter follows:</p>
426
427<h5>image</h5>
428<p>the image The transformed image is returned as this parameter.</p>
429
430<h5>crop_geometry</h5>
431<p>A crop geometry string. This geometry defines a subregion of the image to crop.</p>
432
433<h5>image_geometry</h5>
434<p>An image geometry string. This geometry defines the final size of the image.</p>
435
436 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]437<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransformImages">TransformImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]438<div class="doc-section">
439
440<p>TransformImages() calls TransformImage() on each image of a sequence.</p>
441
442<p>The format of the TransformImage method is:</p>
443
444<pre class="code">
445 MagickBooleanType TransformImages(Image **image,
446 const char *crop_geometry,const char *image_geometry)
447</pre>
448
449<p>A description of each parameter follows:</p>
450
451<h5>image</h5>
452<p>the image The transformed image is returned as this parameter.</p>
453
454<h5>crop_geometry</h5>
455<p>A crop geometry string. This geometry defines a subregion of the image to crop.</p>
456
457<h5>image_geometry</h5>
458<p>An image geometry string. This geometry defines the final size of the image.</p>
459
460 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]461<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransposeImage">TransposeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]462<div class="doc-section">
463
464<p>TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.</p>
465
466<p>The format of the TransposeImage method is:</p>
467
468<pre class="code">
469 Image *TransposeImage(const Image *image,ExceptionInfo *exception)
470</pre>
471
472<p>A description of each parameter follows:</p>
473
474<h5>image</h5>
475<p>the image.</p>
476
477<h5>exception</h5>
478<p>return any errors or warnings in this structure.</p>
479
480 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]481<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransverseImage">TransverseImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]482<div class="doc-section">
483
484<p>TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.</p>
485
486<p>The format of the TransverseImage method is:</p>
487
488<pre class="code">
489 Image *TransverseImage(const Image *image,ExceptionInfo *exception)
490</pre>
491
492<p>A description of each parameter follows:</p>
493
494<h5>image</h5>
495<p>the image.</p>
496
497<h5>exception</h5>
498<p>return any errors or warnings in this structure.</p>
499
500 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]501<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TrimImage">TrimImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]502<div class="doc-section">
503
504<p>TrimImage() trims pixels from the image edges. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.</p>
505
506<p>The format of the TrimImage method is:</p>
507
508<pre class="code">
509 Image *TrimImage(const Image *image,ExceptionInfo *exception)
510</pre>
511
512<p>A description of each parameter follows:</p>
513
514<h5>image</h5>
515<p>the image.</p>
516
517<h5>exception</h5>
518<p>return any errors or warnings in this structure.</p>
519
520 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]521
522</div>
523
524<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]525 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]526 <span id="linkbar-center">
527 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]528 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]529 </span>
530 <span id="linkbar-east">&nbsp;</span>
531 </div>
532 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]533 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]534 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
535 </div>
536 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]537 <script type="text/javascript">
538 var _gaq = _gaq || [];
539 _gaq.push(['_setAccount', 'UA-17690367-1']);
540 _gaq.push(['_trackPageview']);
541
542 (function() {
543 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
544 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
545 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
546 })();
547 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]548</body>
549</html>