Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 7a40ba8d8dae1086103297305d7cd8825ea59fa9 / . / www / api / transform.html
blob: dfe69f84671b4357768cc3086ee4387b940dfa7a [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]"
53 style="margin: 45px auto; border: 0px; float: left;" /></a>
54<a href="http://www.imagemagick.org/discourse-server/">
55 <img src="../../images/logo.jpg" alt=""
56 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]129 <a title="Search" href="../http://www.imagemagick.org/script/search.php">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">
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]143<div class="sponsor">
144 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.html">Web Hosting</a><!-- 201104010090 -->
cristy5c4585b2010-11-11 00:13:57 +0000[diff] [blame]145</div>
146<div class="sponsor">
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]147 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +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">
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]156 <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011050100025 gabi.schulze-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]157</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]158</div>
159</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]160</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]161
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]162<div class="eastbar">
163 <script type="text/javascript">
164 <!--
165 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]166 google_ad_slot = "0574824969";
167 google_ad_width = 160;
168 google_ad_height = 600;
169 //-->
170 </script>
171 <script type="text/javascript"
172 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
173 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]174</div>
175
176<div class="main">
177
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]178<h1>Module transform
179 Methods</h1>
cristyf1196bb2010-02-13 21:18:03 +0000[diff] [blame]180<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]181
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]182<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
183_8c.html" id="ChopImage">ChopImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]184<div class="doc-section">
185
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]186<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]187
188<p>The format of the ChopImage method is:</p>
189
190<pre class="code">
191 Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
192 ExceptionInfo *exception)
193</pre>
194
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]195<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]196
197<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]198<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]199
200<h5>chop_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]201<p>Define the region of the image to chop.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]202
203<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]204<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]205
206 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]207<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
208_8c.html" id="CropImage">CropImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]209<div class="doc-section">
210
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]211<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]212
213<p>The format of the CropImage method is:</p>
214
215<pre class="code">
216 Image *CropImage(const Image *image,const RectangleInfo *geometry,
217 ExceptionInfo *exception)
218</pre>
219
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]220<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]221
222<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]223<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]224
225<h5>geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]226<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]227
228<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]229<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]230
231 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]232<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
233_8c.html" id="ExcerptImage">ExcerptImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]234<div class="doc-section">
235
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]236<p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]237
238<p>The format of the ExcerptImage method is:</p>
239
240<pre class="code">
241 Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
242 ExceptionInfo *exception)
243</pre>
244
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]245<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]246
247<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]248<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]249
250<h5>geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]251<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]252
253<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]254<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]255
256 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]257<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
258_8c.html" id="ExtentImage">ExtentImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]259<div class="doc-section">
260
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]261<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]262
263<p>The format of the ExtentImage method is:</p>
264
265<pre class="code">
266 Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
267 ExceptionInfo *exception)
268</pre>
269
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]270<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]271
272<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]273<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]274
275<h5>geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]276<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]277
278<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]279<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]280
281 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]282<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
283_8c.html" id="FlipImage">FlipImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]284<div class="doc-section">
285
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]286<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]287
288<p>The format of the FlipImage method is:</p>
289
290<pre class="code">
291 Image *FlipImage(const Image *image,ExceptionInfo *exception)
292</pre>
293
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]294<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]295
296<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]297<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]298
299<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]300<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]301
302 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]303<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
304_8c.html" id="FlopImage">FlopImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]305<div class="doc-section">
306
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]307<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]308
309<p>The format of the FlopImage method is:</p>
310
311<pre class="code">
312 Image *FlopImage(const Image *image,ExceptionInfo *exception)
313</pre>
314
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]315<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]316
317<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]318<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]319
320<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]321<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]322
323 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]324<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
325_8c.html" id="RollImage">RollImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]326<div class="doc-section">
327
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]328<p>RollImage() offsets an image as defined by x_offset and y_offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]329
330<p>The format of the RollImage method is:</p>
331
332<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]333 Image *RollImage(const Image *image,const ssize_t x_offset,
334 const ssize_t y_offset,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]335</pre>
336
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]337<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]338
339<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]340<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]341
342<h5>x_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]343<p>the number of columns to roll in the horizontal direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]344
345<h5>y_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]346<p>the number of rows to roll in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]347
348<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]349<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]350
351 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]352<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
353_8c.html" id="ShaveImage">ShaveImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]354<div class="doc-section">
355
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]356<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]357
358<p>The format of the ShaveImage method is:</p>
359
360<pre class="code">
361 Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
362 ExceptionInfo *exception)
363</pre>
364
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]365<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]366
367<h5>shave_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]368<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]369
370<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]371<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]372
373<h5>shave_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]374<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]375
376<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]377<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]378
379 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]380<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
381_8c.html" id="SpliceImage">SpliceImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]382<div class="doc-section">
383
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]384<p>SpliceImage() splices a solid color into the image as defined by the geometry.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]385
386<p>The format of the SpliceImage method is:</p>
387
388<pre class="code">
389 Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
390 ExceptionInfo *exception)
391</pre>
392
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]393<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]394
395<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]396<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]397
398<h5>geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]399<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]400
401<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]402<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]403
404 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]405<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
406_8c.html" id="TransformImage">TransformImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]407<div class="doc-section">
408
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]409<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]410
411<p>The format of the TransformImage method is:</p>
412
413<pre class="code">
414 MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
415 const char *image_geometry)
416</pre>
417
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]418<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]419
420<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]421<p>the image The transformed image is returned as this parameter.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]422
423<h5>crop_geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]424<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]425
426<h5>image_geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]427<p>An image geometry string. This geometry defines the final size of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]428
429 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]430<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
431_8c.html" id="TransformImages">TransformImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]432<div class="doc-section">
433
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]434<p>TransformImages() calls TransformImage() on each image of a sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]435
436<p>The format of the TransformImage method is:</p>
437
438<pre class="code">
439 MagickBooleanType TransformImages(Image **image,
440 const char *crop_geometry,const char *image_geometry)
441</pre>
442
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]443<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]444
445<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]446<p>the image The transformed image is returned as this parameter.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]447
448<h5>crop_geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]449<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]450
451<h5>image_geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]452<p>An image geometry string. This geometry defines the final size of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]453
454 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]455<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
456_8c.html" id="TransposeImage">TransposeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]457<div class="doc-section">
458
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]459<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]460
461<p>The format of the TransposeImage method is:</p>
462
463<pre class="code">
464 Image *TransposeImage(const Image *image,ExceptionInfo *exception)
465</pre>
466
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]467<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]468
469<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]470<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]471
472<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]473<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]474
475 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]476<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
477_8c.html" id="TransverseImage">TransverseImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]478<div class="doc-section">
479
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]480<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]481
482<p>The format of the TransverseImage method is:</p>
483
484<pre class="code">
485 Image *TransverseImage(const Image *image,ExceptionInfo *exception)
486</pre>
487
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]488<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]489
490<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]491<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]492
493<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]494<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]495
496 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]497<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/transform
498_8c.html" id="TrimImage">TrimImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]499<div class="doc-section">
500
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]501<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]502
503<p>The format of the TrimImage method is:</p>
504
505<pre class="code">
506 Image *TrimImage(const Image *image,ExceptionInfo *exception)
507</pre>
508
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]509<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]510
511<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]512<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]513
514<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]515<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]516
517 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]518
519</div>
520
521<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]522 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]523 <span id="linkbar-center">
524 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]525 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]526 </span>
527 <span id="linkbar-east">&nbsp;</span>
528 </div>
529 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]530 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]531 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
532 </div>
533 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]534 <script type="text/javascript">
535 var _gaq = _gaq || [];
536 _gaq.push(['_setAccount', 'UA-17690367-1']);
537 _gaq.push(['_trackPageview']);
538
539 (function() {
540 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
541 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
542 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
543 })();
544 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]545</body>
546</html>