Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 44cbd482f15fae6544c7382473a346af1c0b868f / . / www / api / transform.html
blob: c0a7618997ed39b1ae5888c417bd16d5b55b0435 [file] [log] [blame]
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="-//W3C//DTD XHTML 1.1//EN" xml:lang="en" xsi:schemaLocation="http://www.w3.org/1999/xhtml http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]3<head>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]4 <meta http-equiv="content-type" content="text/html; charset=UTF-8"></meta>
5 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"></meta>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]6 <title>ImageMagick: MagickCore, C API for ImageMagick: Transform an Image</title>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]7 <meta http-equiv="content-language" content="en-US"></meta>
8 <meta http-equiv="content-type" content="text/html; charset=utf-8"></meta>
9 <meta http-equiv="reply-to" content="magick-users@imagemagick.org"></meta>
10 <meta name="application-name" content="ImageMagick"></meta>
11 <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition, resize, rotate, shear, distort or transform images automagically."></meta>
12 <meta name="application-url" content="http://www.imagemagick.org"></meta>
13 <meta name="generator" content="PHP"></meta>
14 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, transform, an, image, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"></meta>
15 <meta name="rating" content="GENERAL"></meta>
16 <meta name="robots" content="INDEX, FOLLOW"></meta>
17 <meta name="generator" content="ImageMagick Studio LLC"></meta>
18 <meta name="author" content="ImageMagick Studio LLC"></meta>
19 <meta name="revisit-after" content="2 DAYS"></meta>
20 <meta name="resource-type" content="document"></meta>
21 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"></meta>
22 <meta name="distribution" content="Global"></meta>
23 <link rel="icon" href="../../images/wand.png"></link>
24 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"></link>
25 <link rel="canonical" href="../../index.html"></link>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]27
28 <!-- Add jQuery library -->
29 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
30
31 <!-- Add mousewheel plugin (this is optional) -->
32 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
33
34 <!-- Add fancyBox -->
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]35 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]36 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
37
38 <!-- Optionally add helpers - button, thumbnail and/or media -->
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]39 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]40 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
41 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
42
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]43 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]44 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
45
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]46 <script type="text/javascript">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]47 $(document).ready(function() {
48 $(".fancybox").fancybox();
49 });
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]50 </script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]51
52 <!-- ImageMagick style -->
53 <style type="text/css" media="all">
54 @import url("../../www/magick.css");
55 </style>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]56</head>
57
58<body id="www-imagemagick-org">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]59
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]60
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]61
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]62<div class="titlebar">
63<div style="margin: 17px auto; float: left;">
64 <script type="text/javascript">
65 <!--
66 google_ad_client = "pub-3129977114552745";
67 google_ad_slot = "5439289906";
68 google_ad_width = 728;
69 google_ad_height = 90;
70 //-->
71 </script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]72
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]73</div>
cristy417eeb12013-07-28 18:48:22 +0000[diff] [blame]74<a href="../../discourse-server">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]75 <img src="../../images/logo.jpg" alt="ImageMagick Logo" style="width: 123px; height: 118px; border: 0px; float: right;"></img></a>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]76<a href="../../index.html">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]77 <img src="../../images/sprite.jpg" alt="ImageMagick Sprite" style="width: 114px; height: 118px; border: 0px; float: right;"></img></a>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]78</div>
79
80<div class="westbar">
81
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]83 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]85<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]86 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]87</div>
88<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]89 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]90</div>
91<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]92 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]93</div>
94<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]95 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]96</div>
97<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]98 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]99</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]100<div class="sep"></div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]101<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]102 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]105 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]108 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
110<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
113<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]114 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115</div>
116<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]117 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118</div>
119<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]120 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121</div>
122<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]123 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124</div>
125<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]126 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]128<div class="sep"></div>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]129<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]130 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]131</div>
132<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]133 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]136 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137 </div>
138<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]139 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]141<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]142 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]143</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]145 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristy3dfa2192013-02-24 22:46:05 +0000[diff] [blame]149 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]151<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]152<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]153 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]154</div>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]155<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]156 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]157</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]158<div class="sep"></div>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]159<div class="menu">
160 <a title="Support ImageMagick Development" href="../../www/support.html">Support ImageMagick Development</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]162</div>
163
164<div class="eastbar">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]165
cristy417eeb12013-07-28 18:48:22 +0000[diff] [blame]166 <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a></div>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]167 <noscript>
168 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]169 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0"></img></a>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]170 </noscript>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]171
172
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]173</div>
174
175<div class="main">
176
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]177<h1>Module transform Methods</h1>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]178<p class="navigation-index">[<a href="transform.html#AutoOrientImage">AutoOrientImage</a> • <a href="transform.html#ChopImage">ChopImage</a> • <a href="transform.html#CropImage">CropImage</a> • <a href="transform.html#CropImageToTiles">CropImageToTiles</a> • <a href="transform.html#ExcerptImage">ExcerptImage</a> • <a href="transform.html#ExtentImage">ExtentImage</a> • <a href="transform.html#FlipImage">FlipImage</a> • <a href="transform.html#FlopImage">FlopImage</a> • <a href="transform.html#RollImage">RollImage</a> • <a href="transform.html#ShaveImage">ShaveImage</a> • <a href="transform.html#SpliceImage">SpliceImage</a> • <a href="transform.html#TransformImage">TransformImage</a> • <a href="transform.html#to CropImageToTiles">to CropImageToTiles</a> • <a href="transform.html#TransformImages">TransformImages</a> • <a href="transform.html#TransposeImage">TransposeImage</a> • <a href="transform.html#TransverseImage">TransverseImage</a> • <a href="transform.html#TrimImage">TrimImage</a>]</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]179
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]180<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="AutoOrientImage">AutoOrientImage</a></h2>
181<div class="doc-section">
182
183<p>AutoOrientImage() adjusts an image so that its orientation is suitable for viewing (i.e. top-left orientation).</p>
184
185<p>The format of the AutoOrientImage method is:</p>
186
187<pre class="code">
188 Image *AutoOrientImage(const Image *image,
189 const OrientationType orientation,ExceptionInfo *exception)
190</pre>
191
192<p>A description of each parameter follows:</p>
193
194<h5>image</h5>
195<p>The image.</p>
196
197<h5>orientation</h5>
198<p>Current image orientation.</p>
199
200<h5>exception</h5>
201<p>Return any errors or warnings in this structure.</p>
202
203 </div>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]204<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ChopImage">ChopImage</a></h2>
205<div class="doc-section">
206
207<p>ChopImage() removes a region of an image and collapses the image to occupy the removed portion.</p>
208
209<p>The format of the ChopImage method is:</p>
210
211<pre class="code">
212 Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
213 ExceptionInfo *exception)
214</pre>
215
216<p>A description of each parameter follows:</p>
217
218<h5>image</h5>
219<p>the image.</p>
220
221<h5>chop_info</h5>
222<p>Define the region of the image to chop.</p>
223
224<h5>exception</h5>
225<p>return any errors or warnings in this structure.</p>
226
227 </div>
228<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="CropImage">CropImage</a></h2>
229<div class="doc-section">
230
231<p>CropImage() extracts a region of the image starting at the offset defined by geometry. Region must be fully defined, and no special handling of geometry flags is performed.</p>
232
233<p>The format of the CropImage method is:</p>
234
235<pre class="code">
236 Image *CropImage(const Image *image,const RectangleInfo *geometry,
237 ExceptionInfo *exception)
238</pre>
239
240<p>A description of each parameter follows:</p>
241
242<h5>image</h5>
243<p>the image.</p>
244
245<h5>geometry</h5>
246<p>Define the region of the image to crop with members x, y, width, and height.</p>
247
248<h5>exception</h5>
249<p>return any errors or warnings in this structure.</p>
250
251 </div>
252<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="CropImageToTiles">CropImageToTiles</a></h2>
253<div class="doc-section">
254
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]255<p>CropImageToTiles() crops a single image, into a possible list of tiles. This may include a single sub-region of the image. This basically applies all the normal geometry flags for Crop.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]256
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]257<p>Image *CropImageToTiles(const Image *image, const RectangleInfo *crop_geometry, ExceptionInfo *exception)</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]258
259<p>A description of each parameter follows:</p>
260
261<h5>image</h5>
262<p>the image The transformed image is returned as this parameter.</p>
263
264<h5>crop_geometry</h5>
265<p>A crop geometry string.</p>
266
267<h5>exception</h5>
268<p>return any errors or warnings in this structure.</p>
269
270 </div>
271<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ExcerptImage">ExcerptImage</a></h2>
272<div class="doc-section">
273
274<p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p>
275
276<p>The format of the ExcerptImage method is:</p>
277
278<pre class="code">
279 Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
280 ExceptionInfo *exception)
281</pre>
282
283<p>A description of each parameter follows:</p>
284
285<h5>image</h5>
286<p>the image.</p>
287
288<h5>geometry</h5>
289<p>Define the region of the image to extend with members x, y, width, and height.</p>
290
291<h5>exception</h5>
292<p>return any errors or warnings in this structure.</p>
293
294 </div>
295<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ExtentImage">ExtentImage</a></h2>
296<div class="doc-section">
297
298<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>
299
300<p>The format of the ExtentImage method is:</p>
301
302<pre class="code">
303 Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
304 ExceptionInfo *exception)
305</pre>
306
307<p>A description of each parameter follows:</p>
308
309<h5>image</h5>
310<p>the image.</p>
311
312<h5>geometry</h5>
313<p>Define the region of the image to extend with members x, y, width, and height.</p>
314
315<h5>exception</h5>
316<p>return any errors or warnings in this structure.</p>
317
318 </div>
319<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="FlipImage">FlipImage</a></h2>
320<div class="doc-section">
321
322<p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p>
323
324<p>The format of the FlipImage method is:</p>
325
326<pre class="code">
327 Image *FlipImage(const Image *image,ExceptionInfo *exception)
328</pre>
329
330<p>A description of each parameter follows:</p>
331
332<h5>image</h5>
333<p>the image.</p>
334
335<h5>exception</h5>
336<p>return any errors or warnings in this structure.</p>
337
338 </div>
339<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="FlopImage">FlopImage</a></h2>
340<div class="doc-section">
341
342<p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p>
343
344<p>The format of the FlopImage method is:</p>
345
346<pre class="code">
347 Image *FlopImage(const Image *image,ExceptionInfo *exception)
348</pre>
349
350<p>A description of each parameter follows:</p>
351
352<h5>image</h5>
353<p>the image.</p>
354
355<h5>exception</h5>
356<p>return any errors or warnings in this structure.</p>
357
358 </div>
359<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="RollImage">RollImage</a></h2>
360<div class="doc-section">
361
362<p>RollImage() offsets an image as defined by x_offset and y_offset.</p>
363
364<p>The format of the RollImage method is:</p>
365
366<pre class="code">
367 Image *RollImage(const Image *image,const ssize_t x_offset,
368 const ssize_t y_offset,ExceptionInfo *exception)
369</pre>
370
371<p>A description of each parameter follows:</p>
372
373<h5>image</h5>
374<p>the image.</p>
375
376<h5>x_offset</h5>
377<p>the number of columns to roll in the horizontal direction.</p>
378
379<h5>y_offset</h5>
380<p>the number of rows to roll in the vertical direction.</p>
381
382<h5>exception</h5>
383<p>return any errors or warnings in this structure.</p>
384
385 </div>
386<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ShaveImage">ShaveImage</a></h2>
387<div class="doc-section">
388
389<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>
390
391<p>The format of the ShaveImage method is:</p>
392
393<pre class="code">
394 Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
395 ExceptionInfo *exception)
396</pre>
397
398<p>A description of each parameter follows:</p>
399
400<h5>shave_image</h5>
401<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>
402
403<h5>image</h5>
404<p>the image.</p>
405
406<h5>shave_info</h5>
407<p>Specifies a pointer to a RectangleInfo which defines the region of the image to crop.</p>
408
409<h5>exception</h5>
410<p>return any errors or warnings in this structure.</p>
411
412 </div>
413<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="SpliceImage">SpliceImage</a></h2>
414<div class="doc-section">
415
416<p>SpliceImage() splices a solid color into the image as defined by the geometry.</p>
417
418<p>The format of the SpliceImage method is:</p>
419
420<pre class="code">
421 Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
422 ExceptionInfo *exception)
423</pre>
424
425<p>A description of each parameter follows:</p>
426
427<h5>image</h5>
428<p>the image.</p>
429
430<h5>geometry</h5>
431<p>Define the region of the image to splice with members x, y, width, and height.</p>
432
433<h5>exception</h5>
434<p>return any errors or warnings in this structure.</p>
435
436 </div>
437<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransformImage">TransformImage</a></h2>
438<div class="doc-section">
439
440<p>TransformImage() is a convenience method that behaves like ResizeImage() or CropImage() but accepts scaling and/or cropping information as a region geometry specification. If the operation fails, the original image handle is left as is.</p>
441
442<p>This should only be used for single images.</p>
443
444<p>The format of the TransformImage method is:</p>
445
446<pre class="code">
447 MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
448 const char *image_geometry)
449</pre>
450
451<p>A description of each parameter follows:</p>
452
453<h5>image</h5>
454<p>the image The transformed image is returned as this parameter.</p>
455
456<h5>crop_geometry</h5>
457<p>A crop geometry string. This geometry defines a subregion of the image to crop.</p>
458
459<h5>image_geometry</h5>
460<p>An image geometry string. This geometry defines the final size of the image.</p>
461
462 </div>
463<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="to_CropImageToTiles">to CropImageToTiles</a></h2>
464<div class="doc-section">
465
466<p>to CropImageToTiles() or ResizeImage(), as appropriate.</p>
467
468 </div>
469<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransformImages">TransformImages</a></h2>
470<div class="doc-section">
471
472<p>TransformImages() calls TransformImage() on each image of a sequence.</p>
473
474<p>The format of the TransformImage method is:</p>
475
476<pre class="code">
477 MagickBooleanType TransformImages(Image **image,
478 const char *crop_geometry,const char *image_geometry)
479</pre>
480
481<p>A description of each parameter follows:</p>
482
483<h5>image</h5>
484<p>the image The transformed image is returned as this parameter.</p>
485
486<h5>crop_geometry</h5>
487<p>A crop geometry string. This geometry defines a subregion of the image to crop.</p>
488
489<h5>image_geometry</h5>
490<p>An image geometry string. This geometry defines the final size of the image.</p>
491
492 </div>
493<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransposeImage">TransposeImage</a></h2>
494<div class="doc-section">
495
496<p>TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.</p>
497
498<p>The format of the TransposeImage method is:</p>
499
500<pre class="code">
501 Image *TransposeImage(const Image *image,ExceptionInfo *exception)
502</pre>
503
504<p>A description of each parameter follows:</p>
505
506<h5>image</h5>
507<p>the image.</p>
508
509<h5>exception</h5>
510<p>return any errors or warnings in this structure.</p>
511
512 </div>
513<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransverseImage">TransverseImage</a></h2>
514<div class="doc-section">
515
516<p>TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.</p>
517
518<p>The format of the TransverseImage method is:</p>
519
520<pre class="code">
521 Image *TransverseImage(const Image *image,ExceptionInfo *exception)
522</pre>
523
524<p>A description of each parameter follows:</p>
525
526<h5>image</h5>
527<p>the image.</p>
528
529<h5>exception</h5>
530<p>return any errors or warnings in this structure.</p>
531
532 </div>
533<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TrimImage">TrimImage</a></h2>
534<div class="doc-section">
535
536<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>
537
538<p>The format of the TrimImage method is:</p>
539
540<pre class="code">
541 Image *TrimImage(const Image *image,ExceptionInfo *exception)
542</pre>
543
544<p>A description of each parameter follows:</p>
545
546<h5>image</h5>
547<p>the image.</p>
548
549<h5>exception</h5>
550<p>return any errors or warnings in this structure.</p>
551
552 </div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]553
554</div>
555
556<div id="linkbar">
cristyac1b4322013-07-28 13:58:06 +0000[diff] [blame]557 <span id="linkbar-west"> </span>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]558
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]559 <span id="linkbar-center">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]560 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
561 <a href="../../discourse-server">Discourse Server</a> •
562 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> •
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]563 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]564 </span>
cristyac1b4322013-07-28 13:58:06 +0000[diff] [blame]565 <span id="linkbar-east"> </span>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]566</div>
567<div class="footer">
568 <span id="footer-west">© 1999-2013 ImageMagick Studio LLC</span>
569 <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
570</div>
571<div style="clear: both; margin: 0; width: 100%; "></div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]572</body>
573</html>