Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / f7964270f2b6d810576a32f8240fca73a352c51a / . / www / api / transform.html
blob: 151d2330c9324de610a26b36274467f41fc18a8d [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">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Transform an Image</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <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]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]27 <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]28 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]31 <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]32 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]44</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]53 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]54<a href="http://www.imagemagick.org/discourse-server/">
55 <img src="../../images/logo.jpg" alt=""
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]56 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]57<a href="../../index.html">
58 <img src="../../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]62<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]63
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]67<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]69 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]82 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]83</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]85 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]86</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]88 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]89</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</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="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</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="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]106 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Install from Source" href="../../www/install-source.html">Install from Source</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="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</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="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]121<div class="menu">
122 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]129 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]133 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]136 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]140 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141
142<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]143<div class="sponsor">
144 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
145</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]146<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]147 <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]148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]155<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]156 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
157</div>
158<div class="sponsor">
cristyf7964272011-01-30 03:49:12 +0000[diff] [blame^]159 <a title="Sponsor: Custom T-Shirts" href="http://www.ooshirts.com">Custom T-Shirts</a><!-- 2011050100030 ooshirts.com-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]160</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161</div>
162</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]163</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]164
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]165<div class="eastbar">
166 <script type="text/javascript">
167 <!--
168 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]169 google_ad_slot = "0574824969";
170 google_ad_width = 160;
171 google_ad_height = 600;
172 //-->
173 </script>
174 <script type="text/javascript"
175 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
176 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]177</div>
178
179<div class="main">
180
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]181<h1>Module transform
182 Methods</h1>
cristyf1196bb2010-02-13 21:18:03 +0000[diff] [blame]183<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]184
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]185<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
186_8c.html" id="ChopImage">ChopImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]187<div class="doc-section">
188
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]189<p>ChopImage() removes a region of an image and collapses the image to occupy the removed portion.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]190
191<p>The format of the ChopImage method is:</p>
192
193<pre class="code">
194 Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
195 ExceptionInfo *exception)
196</pre>
197
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]198<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]199
200<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]201<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]202
203<h5>chop_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]204<p>Define the region of the image to chop.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]205
206<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]207<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]208
209 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]210<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
211_8c.html" id="CropImage">CropImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]212<div class="doc-section">
213
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]214<p>CropImage() extracts a region of the image starting at the offset defined by geometry.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]215
216<p>The format of the CropImage method is:</p>
217
218<pre class="code">
219 Image *CropImage(const Image *image,const RectangleInfo *geometry,
220 ExceptionInfo *exception)
221</pre>
222
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]223<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]224
225<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]226<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]227
228<h5>geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]229<p>Define the region of the image to crop with members x, y, width, and height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]230
231<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]232<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]233
234 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]235<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
236_8c.html" id="ExcerptImage">ExcerptImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]237<div class="doc-section">
238
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]239<p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]240
241<p>The format of the ExcerptImage method is:</p>
242
243<pre class="code">
244 Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
245 ExceptionInfo *exception)
246</pre>
247
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]248<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]249
250<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]251<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]252
253<h5>geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]254<p>Define the region of the image to extend with members x, y, width, and height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]255
256<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]257<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]258
259 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]260<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
261_8c.html" id="ExtentImage">ExtentImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]262<div class="doc-section">
263
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]264<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]265
266<p>The format of the ExtentImage method is:</p>
267
268<pre class="code">
269 Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
270 ExceptionInfo *exception)
271</pre>
272
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]273<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]274
275<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]276<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]277
278<h5>geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]279<p>Define the region of the image to extend with members x, y, width, and height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]280
281<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]282<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]283
284 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]285<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
286_8c.html" id="FlipImage">FlipImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]287<div class="doc-section">
288
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]289<p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]290
291<p>The format of the FlipImage method is:</p>
292
293<pre class="code">
294 Image *FlipImage(const Image *image,ExceptionInfo *exception)
295</pre>
296
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]297<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]298
299<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]300<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]301
302<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]303<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]304
305 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]306<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
307_8c.html" id="FlopImage">FlopImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]308<div class="doc-section">
309
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]310<p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]311
312<p>The format of the FlopImage method is:</p>
313
314<pre class="code">
315 Image *FlopImage(const Image *image,ExceptionInfo *exception)
316</pre>
317
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]318<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]319
320<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]321<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]322
323<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]324<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]325
326 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]327<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
328_8c.html" id="RollImage">RollImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]329<div class="doc-section">
330
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]331<p>RollImage() offsets an image as defined by x_offset and y_offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]332
333<p>The format of the RollImage method is:</p>
334
335<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]336 Image *RollImage(const Image *image,const ssize_t x_offset,
337 const ssize_t y_offset,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]338</pre>
339
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]340<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]341
342<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]343<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]344
345<h5>x_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]346<p>the number of columns to roll in the horizontal direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]347
348<h5>y_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]349<p>the number of rows to roll in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]350
351<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]352<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]353
354 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]355<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
356_8c.html" id="ShaveImage">ShaveImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]357<div class="doc-section">
358
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]359<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]360
361<p>The format of the ShaveImage method is:</p>
362
363<pre class="code">
364 Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
365 ExceptionInfo *exception)
366</pre>
367
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]368<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]369
370<h5>shave_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]371<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]372
373<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]374<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]375
376<h5>shave_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]377<p>Specifies a pointer to a RectangleInfo which defines the region of the image to crop.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]378
379<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]380<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]381
382 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]383<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
384_8c.html" id="SpliceImage">SpliceImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]385<div class="doc-section">
386
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]387<p>SpliceImage() splices a solid color into the image as defined by the geometry.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]388
389<p>The format of the SpliceImage method is:</p>
390
391<pre class="code">
392 Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
393 ExceptionInfo *exception)
394</pre>
395
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]396<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]397
398<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]399<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]400
401<h5>geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]402<p>Define the region of the image to splice with members x, y, width, and height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]403
404<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]405<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]406
407 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]408<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
409_8c.html" id="TransformImage">TransformImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]410<div class="doc-section">
411
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]412<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]413
414<p>The format of the TransformImage method is:</p>
415
416<pre class="code">
417 MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
418 const char *image_geometry)
419</pre>
420
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]421<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]422
423<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]424<p>the image The transformed image is returned as this parameter.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]425
426<h5>crop_geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]427<p>A crop geometry string. This geometry defines a subregion of the image to crop.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]428
429<h5>image_geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]430<p>An image geometry string. This geometry defines the final size of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]431
432 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]433<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
434_8c.html" id="TransformImages">TransformImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]435<div class="doc-section">
436
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]437<p>TransformImages() calls TransformImage() on each image of a sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]438
439<p>The format of the TransformImage method is:</p>
440
441<pre class="code">
442 MagickBooleanType TransformImages(Image **image,
443 const char *crop_geometry,const char *image_geometry)
444</pre>
445
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]446<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]447
448<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]449<p>the image The transformed image is returned as this parameter.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]450
451<h5>crop_geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]452<p>A crop geometry string. This geometry defines a subregion of the image to crop.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]453
454<h5>image_geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]455<p>An image geometry string. This geometry defines the final size of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]456
457 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]458<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
459_8c.html" id="TransposeImage">TransposeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]460<div class="doc-section">
461
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]462<p>TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]463
464<p>The format of the TransposeImage method is:</p>
465
466<pre class="code">
467 Image *TransposeImage(const Image *image,ExceptionInfo *exception)
468</pre>
469
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]470<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]471
472<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]473<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]474
475<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]476<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]477
478 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]479<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
480_8c.html" id="TransverseImage">TransverseImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]481<div class="doc-section">
482
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]483<p>TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]484
485<p>The format of the TransverseImage method is:</p>
486
487<pre class="code">
488 Image *TransverseImage(const Image *image,ExceptionInfo *exception)
489</pre>
490
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]491<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]492
493<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]494<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]495
496<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]497<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]498
499 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]500<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
501_8c.html" id="TrimImage">TrimImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]502<div class="doc-section">
503
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]512<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]513
514<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]515<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]516
517<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]518<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>