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