Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 3ecf287d9fdc86ecfd01aafabc37cc2c71586a46 / . / www / api / transform.html
blob: 6bf30fd0d53421585bd3a6b2a619e419cf5aaf1c [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">
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>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]72 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
73</div>
74
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]75<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]76
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]77<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]78 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]80<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]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">
cristybb503372010-05-27 20:51:26 +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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]98 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]99</div>
100<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]101 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]102</div>
103<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]104 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]105</div>
106<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]107 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]108</div>
109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127</div>
128<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]129 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
131<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]132 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]133 </div>
134<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]135 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]137<div class="menu">
138 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
139</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]141 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]143<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]145 <a title="Search" href="../../www/search.html">Search</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">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]149 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +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>
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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]156 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]162<div class="sponsor">
cristyf9a6c462011-04-24 14:01:11 +0000[diff] [blame]163 <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201108010090 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: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
cristybe3c5be2011-03-05 17:35:07 +0000[diff] [blame]170</div>
171<div class="sponsor">
cristyf9a6c462011-04-24 14:01:11 +0000[diff] [blame]172 <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]173</div>
174<div class="sponsor">
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]175 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy5c4585b2010-11-11 00:13:57 +0000[diff] [blame]176</div>
177<div class="sponsor">
cristyf9a6c462011-04-24 14:01:11 +0000[diff] [blame]178 <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]179</div>
180<div class="sponsor">
cristyf9a6c462011-04-24 14:01:11 +0000[diff] [blame]181 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]182</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]183<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]184 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
185</div>
186<div class="sponsor">
cristy5ae0cc72011-04-24 15:34:24 +0000[diff] [blame]187 <a title="Sponsor: Autoteile Online Shop" href="http://www.autoteile-carparts.de">Autoteile Online Shop</a><!-- 2011070100030 autoteile-Carparts-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]188</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]189</div>
190</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]191</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]192
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]193<div class="eastbar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]194
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]195</div>
196
197<div class="main">
198
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]199<h1>Module transform Methods</h1>
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]200<p class="navigation-index">[<a href="#ChopImage">ChopImage</a> &bull; <a href="#CropImage">CropImage</a> &bull; <a href="#CropImageToTiles">CropImageToTiles</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="#to CropImageToTiles">to CropImageToTiles</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]201
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]202<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]203<div class="doc-section">
204
205<p>ChopImage() removes a region of an image and collapses the image to occupy the removed portion.</p>
206
207<p>The format of the ChopImage method is:</p>
208
209<pre class="code">
210 Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
211 ExceptionInfo *exception)
212</pre>
213
214<p>A description of each parameter follows:</p>
215
216<h5>image</h5>
217<p>the image.</p>
218
219<h5>chop_info</h5>
220<p>Define the region of the image to chop.</p>
221
222<h5>exception</h5>
223<p>return any errors or warnings in this structure.</p>
224
225 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]226<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]227<div class="doc-section">
228
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]229<p>CropImage() extracts a region of the image starting at the offset defined by geometry. Region must be fully defined, and no special handling of geometry flags is performed.</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]230
231<p>The format of the CropImage method is:</p>
232
233<pre class="code">
234 Image *CropImage(const Image *image,const RectangleInfo *geometry,
235 ExceptionInfo *exception)
236</pre>
237
238<p>A description of each parameter follows:</p>
239
240<h5>image</h5>
241<p>the image.</p>
242
243<h5>geometry</h5>
244<p>Define the region of the image to crop with members x, y, width, and height.</p>
245
246<h5>exception</h5>
247<p>return any errors or warnings in this structure.</p>
248
249 </div>
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]250<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="CropImageToTiles">CropImageToTiles</a></h2>
251<div class="doc-section">
252
253<p>CropImageToTiles() will crop a single image, into a posible list of tiles. This may include a single sub-region of the image. This basically applies all the normal geometry flags for Crop.</p>
254
255<p>Image *CropImageToTiles(const Image *image,const RectangleInfo *crop_geometry, ExceptionInfo *exception)</p>
256
257<p>A description of each parameter follows:</p>
258
259<h5>image</h5>
260<p>the image The transformed image is returned as this parameter.</p>
261
262<h5>crop_geometry</h5>
263<p>A crop geometry string.</p>
264
265<h5>exception</h5>
266<p>return any errors or warnings in this structure.</p>
267
268 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]269<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]270<div class="doc-section">
271
272<p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p>
273
274<p>The format of the ExcerptImage method is:</p>
275
276<pre class="code">
277 Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
278 ExceptionInfo *exception)
279</pre>
280
281<p>A description of each parameter follows:</p>
282
283<h5>image</h5>
284<p>the image.</p>
285
286<h5>geometry</h5>
287<p>Define the region of the image to extend with members x, y, width, and height.</p>
288
289<h5>exception</h5>
290<p>return any errors or warnings in this structure.</p>
291
292 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]293<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]294<div class="doc-section">
295
296<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>
297
298<p>The format of the ExtentImage method is:</p>
299
300<pre class="code">
301 Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
302 ExceptionInfo *exception)
303</pre>
304
305<p>A description of each parameter follows:</p>
306
307<h5>image</h5>
308<p>the image.</p>
309
310<h5>geometry</h5>
311<p>Define the region of the image to extend with members x, y, width, and height.</p>
312
313<h5>exception</h5>
314<p>return any errors or warnings in this structure.</p>
315
316 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]317<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]318<div class="doc-section">
319
320<p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p>
321
322<p>The format of the FlipImage method is:</p>
323
324<pre class="code">
325 Image *FlipImage(const Image *image,ExceptionInfo *exception)
326</pre>
327
328<p>A description of each parameter follows:</p>
329
330<h5>image</h5>
331<p>the image.</p>
332
333<h5>exception</h5>
334<p>return any errors or warnings in this structure.</p>
335
336 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]337<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]338<div class="doc-section">
339
340<p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p>
341
342<p>The format of the FlopImage method is:</p>
343
344<pre class="code">
345 Image *FlopImage(const Image *image,ExceptionInfo *exception)
346</pre>
347
348<p>A description of each parameter follows:</p>
349
350<h5>image</h5>
351<p>the image.</p>
352
353<h5>exception</h5>
354<p>return any errors or warnings in this structure.</p>
355
356 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]357<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]358<div class="doc-section">
359
360<p>RollImage() offsets an image as defined by x_offset and y_offset.</p>
361
362<p>The format of the RollImage method is:</p>
363
364<pre class="code">
365 Image *RollImage(const Image *image,const ssize_t x_offset,
366 const ssize_t y_offset,ExceptionInfo *exception)
367</pre>
368
369<p>A description of each parameter follows:</p>
370
371<h5>image</h5>
372<p>the image.</p>
373
374<h5>x_offset</h5>
375<p>the number of columns to roll in the horizontal direction.</p>
376
377<h5>y_offset</h5>
378<p>the number of rows to roll in the vertical direction.</p>
379
380<h5>exception</h5>
381<p>return any errors or warnings in this structure.</p>
382
383 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]384<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]385<div class="doc-section">
386
387<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>
388
389<p>The format of the ShaveImage method is:</p>
390
391<pre class="code">
392 Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
393 ExceptionInfo *exception)
394</pre>
395
396<p>A description of each parameter follows:</p>
397
398<h5>shave_image</h5>
399<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>
400
401<h5>image</h5>
402<p>the image.</p>
403
404<h5>shave_info</h5>
405<p>Specifies a pointer to a RectangleInfo which defines the region of the image to crop.</p>
406
407<h5>exception</h5>
408<p>return any errors or warnings in this structure.</p>
409
410 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]411<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]412<div class="doc-section">
413
414<p>SpliceImage() splices a solid color into the image as defined by the geometry.</p>
415
416<p>The format of the SpliceImage method is:</p>
417
418<pre class="code">
419 Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
420 ExceptionInfo *exception)
421</pre>
422
423<p>A description of each parameter follows:</p>
424
425<h5>image</h5>
426<p>the image.</p>
427
428<h5>geometry</h5>
429<p>Define the region of the image to splice with members x, y, width, and height.</p>
430
431<h5>exception</h5>
432<p>return any errors or warnings in this structure.</p>
433
434 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]435<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]436<div class="doc-section">
437
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]438<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 left as is.</p>
439
440<p>This should only be used for single images.</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]441
442<p>The format of the TransformImage method is:</p>
443
444<pre class="code">
445 MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
446 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>
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]461<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="to_CropImageToTiles">to CropImageToTiles</a></h2>
462<div class="doc-section">
463
464<p>to CropImageToTiles() or ResizeImage(), as appropriate.</p>
465
466 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]467<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]468<div class="doc-section">
469
470<p>TransformImages() calls TransformImage() on each image of a sequence.</p>
471
472<p>The format of the TransformImage method is:</p>
473
474<pre class="code">
475 MagickBooleanType TransformImages(Image **image,
476 const char *crop_geometry,const char *image_geometry)
477</pre>
478
479<p>A description of each parameter follows:</p>
480
481<h5>image</h5>
482<p>the image The transformed image is returned as this parameter.</p>
483
484<h5>crop_geometry</h5>
485<p>A crop geometry string. This geometry defines a subregion of the image to crop.</p>
486
487<h5>image_geometry</h5>
488<p>An image geometry string. This geometry defines the final size of the image.</p>
489
490 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]491<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]492<div class="doc-section">
493
494<p>TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.</p>
495
496<p>The format of the TransposeImage method is:</p>
497
498<pre class="code">
499 Image *TransposeImage(const Image *image,ExceptionInfo *exception)
500</pre>
501
502<p>A description of each parameter follows:</p>
503
504<h5>image</h5>
505<p>the image.</p>
506
507<h5>exception</h5>
508<p>return any errors or warnings in this structure.</p>
509
510 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]511<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]512<div class="doc-section">
513
514<p>TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.</p>
515
516<p>The format of the TransverseImage method is:</p>
517
518<pre class="code">
519 Image *TransverseImage(const Image *image,ExceptionInfo *exception)
520</pre>
521
522<p>A description of each parameter follows:</p>
523
524<h5>image</h5>
525<p>the image.</p>
526
527<h5>exception</h5>
528<p>return any errors or warnings in this structure.</p>
529
530 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]531<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]532<div class="doc-section">
533
534<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>
535
536<p>The format of the TrimImage method is:</p>
537
538<pre class="code">
539 Image *TrimImage(const Image *image,ExceptionInfo *exception)
540</pre>
541
542<p>A description of each parameter follows:</p>
543
544<h5>image</h5>
545<p>the image.</p>
546
547<h5>exception</h5>
548<p>return any errors or warnings in this structure.</p>
549
550 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]551
552</div>
553
554<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]555 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]556 <span id="linkbar-center">
557 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]558 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]559 </span>
560 <span id="linkbar-east">&nbsp;</span>
561 </div>
562 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]563 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]564 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
565 </div>
566 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]567 <script type="text/javascript">
568 var _gaq = _gaq || [];
569 _gaq.push(['_setAccount', 'UA-17690367-1']);
570 _gaq.push(['_trackPageview']);
571
572 (function() {
573 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
574 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
575 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
576 })();
577 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]578</body>
579</html>