Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / a1890f0836ae7459ceab62ae752e9d6d5082f1b1 / . / www / api / transform.html
blob: 69056776ade3dcad2039a3299d10974cb0143a0c [file] [log] [blame]
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1<!DOCTYPE html>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]2<html lang="en">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]3<head>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Transform an Image</title>
cristy44443b92015-05-05 00:06:07 +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">
11 <meta name="application-name" content="ImageMagick">
12 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
13 <meta name="application-url" content="http://www.imagemagick.org">
14 <meta name="generator" content="PHP">
15 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, transform, an, image, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
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">
cristy4e638cd2015-05-07 16:47:40 +0000[diff] [blame]22 <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]23 <meta name="distribution" content="Global">
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]25 <link rel="icon" href="../images/wand.png">
26 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon">
27 <link rel="stylesheet" href="../css/bootstrap.min.css">
28 <link rel="stylesheet" href="../css/magick.css">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]29</head>
30
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]31<body>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]32<div class="main">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]33<div class="magick-masthead">
34 <div class="container">
35 <script type="text/javascript">
36 <!--
37 google_ad_client = "pub-3129977114552745";
38 google_ad_slot = "5439289906";
39 google_ad_width = 728;
40 google_ad_height = 90;
41 //-->
42 </script>
43 <center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
44 </script></center>
45 <nav class="magick-nav">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]46 <a class="magick-nav-item " href="../index.html">Home</a>
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]47 <a class="magick-nav-item " href="../binary-releases.html">Downloads</a>
48 <a class="magick-nav-item " href="../command-line-tools.html">Tools</a>
49 <a class="magick-nav-item " href="../command-line-options.html">Options</a>
50 <a class="magick-nav-item " href="api.html">Development</a>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame^]51 <a class="magick-nav-item " href="http://www.imagemagick.org/script/search.php">Search</a>
52 <a class="magick-nav-item pull-right" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]53 </nav>
54 </div>
55</div>
56<div class="container">
cristy4e638cd2015-05-07 16:47:40 +0000[diff] [blame]57<div class="magick-header">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]58<p class="text-center"><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%20CropImageToTiles">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>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]59
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]60<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="AutoOrientImage">AutoOrientImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]61
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]62<p>AutoOrientImage() adjusts an image so that its orientation is suitable for viewing (i.e. top-left orientation).</p>
63
64<p>The format of the AutoOrientImage method is:</p>
65
66<pre class="text">
67Image *AutoOrientImage(const Image *image,
68 const OrientationType orientation,ExceptionInfo *exception)
69</pre>
70
71<p>A description of each parameter follows:</p>
72
73<dd>
74</dd>
75
76<dd> </dd>
77<dl class="dl-horizontal">
78<dt>image</dt>
79<dd>The image. </dd>
80
81<dd> </dd>
82<dt>orientation</dt>
83<dd>Current image orientation. </dd>
84
85<dd> </dd>
86<dt>exception</dt>
87<dd>Return any errors or warnings in this structure. </dd>
88
89<dd> </dd>
90</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]91<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ChopImage">ChopImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]92
93<p>ChopImage() removes a region of an image and collapses the image to occupy the removed portion.</p>
94
95<p>The format of the ChopImage method is:</p>
96
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]97<pre class="text">
98Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
99 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]100</pre>
101
102<p>A description of each parameter follows:</p>
103
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]104<dd>
105</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]106
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]107<dd> </dd>
108<dl class="dl-horizontal">
109<dt>image</dt>
110<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]111
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]112<dd> </dd>
113<dt>chop_info</dt>
114<dd>Define the region of the image to chop. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]115
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]116<dd> </dd>
117<dt>exception</dt>
118<dd>return any errors or warnings in this structure. </dd>
119
120<dd> </dd>
121</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]122<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="CropImage">CropImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]123
124<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>
125
126<p>The format of the CropImage method is:</p>
127
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]128<pre class="text">
129Image *CropImage(const Image *image,const RectangleInfo *geometry,
130 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]131</pre>
132
133<p>A description of each parameter follows:</p>
134
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]135<dd>
136</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]137
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]138<dd> </dd>
139<dl class="dl-horizontal">
140<dt>image</dt>
141<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]142
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]143<dd> </dd>
144<dt>geometry</dt>
145<dd>Define the region of the image to crop with members x, y, width, and height. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]146
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]147<dd> </dd>
148<dt>exception</dt>
149<dd>return any errors or warnings in this structure. </dd>
150
151<dd> </dd>
152</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]153<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="CropImageToTiles">CropImageToTiles</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]154
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]155<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]156
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]157<p>Image *CropImageToTiles(const Image *image, const RectangleInfo *crop_geometry, ExceptionInfo *exception)</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]158
159<p>A description of each parameter follows:</p>
160
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]161<dd>
162</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]163
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]164<dd> </dd>
165<dl class="dl-horizontal">
166<dt>image</dt>
167<dd>the image The transformed image is returned as this parameter. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]168
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]169<dd> </dd>
170<dt>crop_geometry</dt>
171<dd>A crop geometry string. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]172
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]173<dd> </dd>
174<dt>exception</dt>
175<dd>return any errors or warnings in this structure. </dd>
176
177<dd> </dd>
178</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]179<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ExcerptImage">ExcerptImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]180
181<p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p>
182
183<p>The format of the ExcerptImage method is:</p>
184
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]185<pre class="text">
186Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
187 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]188</pre>
189
190<p>A description of each parameter follows:</p>
191
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]192<dd>
193</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]194
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]195<dd> </dd>
196<dl class="dl-horizontal">
197<dt>image</dt>
198<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]199
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]200<dd> </dd>
201<dt>geometry</dt>
202<dd>Define the region of the image to extend with members x, y, width, and height. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]203
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]204<dd> </dd>
205<dt>exception</dt>
206<dd>return any errors or warnings in this structure. </dd>
207
208<dd> </dd>
209</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]210<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ExtentImage">ExtentImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]211
212<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>
213
214<p>The format of the ExtentImage method is:</p>
215
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]216<pre class="text">
217Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
218 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]219</pre>
220
221<p>A description of each parameter follows:</p>
222
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]223<dd>
224</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]225
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]226<dd> </dd>
227<dl class="dl-horizontal">
228<dt>image</dt>
229<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]230
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]231<dd> </dd>
232<dt>geometry</dt>
233<dd>Define the region of the image to extend with members x, y, width, and height. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]234
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]235<dd> </dd>
236<dt>exception</dt>
237<dd>return any errors or warnings in this structure. </dd>
238
239<dd> </dd>
240</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]241<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="FlipImage">FlipImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]242
243<p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p>
244
245<p>The format of the FlipImage method is:</p>
246
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]247<pre class="text">
248Image *FlipImage(const Image *image,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]249</pre>
250
251<p>A description of each parameter follows:</p>
252
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]253<dd>
254</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]255
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]256<dd> </dd>
257<dl class="dl-horizontal">
258<dt>image</dt>
259<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]260
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]261<dd> </dd>
262<dt>exception</dt>
263<dd>return any errors or warnings in this structure. </dd>
264
265<dd> </dd>
266</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]267<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="FlopImage">FlopImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]268
269<p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p>
270
271<p>The format of the FlopImage method is:</p>
272
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]273<pre class="text">
274Image *FlopImage(const Image *image,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]275</pre>
276
277<p>A description of each parameter follows:</p>
278
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]279<dd>
280</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]281
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]282<dd> </dd>
283<dl class="dl-horizontal">
284<dt>image</dt>
285<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]286
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]287<dd> </dd>
288<dt>exception</dt>
289<dd>return any errors or warnings in this structure. </dd>
290
291<dd> </dd>
292</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]293<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="RollImage">RollImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]294
295<p>RollImage() offsets an image as defined by x_offset and y_offset.</p>
296
297<p>The format of the RollImage method is:</p>
298
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]299<pre class="text">
300Image *RollImage(const Image *image,const ssize_t x_offset,
301 const ssize_t y_offset,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]302</pre>
303
304<p>A description of each parameter follows:</p>
305
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]306<dd>
307</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]308
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]309<dd> </dd>
310<dl class="dl-horizontal">
311<dt>image</dt>
312<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]313
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]314<dd> </dd>
315<dt>x_offset</dt>
316<dd>the number of columns to roll in the horizontal direction. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]317
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]318<dd> </dd>
319<dt>y_offset</dt>
320<dd>the number of rows to roll in the vertical direction. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]321
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]322<dd> </dd>
323<dt>exception</dt>
324<dd>return any errors or warnings in this structure. </dd>
325
326<dd> </dd>
327</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]328<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ShaveImage">ShaveImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]329
330<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>
331
332<p>The format of the ShaveImage method is:</p>
333
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]334<pre class="text">
335Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
336 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]337</pre>
338
339<p>A description of each parameter follows:</p>
340
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]341<dd>
342</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]343
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]344<dd> </dd>
345<dl class="dl-horizontal">
346<dt>shave_image</dt>
347<dd>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. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]348
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]349<dd> </dd>
350<dt>image</dt>
351<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]352
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]353<dd> </dd>
354<dt>shave_info</dt>
355<dd>Specifies a pointer to a RectangleInfo which defines the region of the image to crop. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]356
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]357<dd> </dd>
358<dt>exception</dt>
359<dd>return any errors or warnings in this structure. </dd>
360
361<dd> </dd>
362</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]363<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="SpliceImage">SpliceImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]364
365<p>SpliceImage() splices a solid color into the image as defined by the geometry.</p>
366
367<p>The format of the SpliceImage method is:</p>
368
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]369<pre class="text">
370Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
371 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]372</pre>
373
374<p>A description of each parameter follows:</p>
375
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]376<dd>
377</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]378
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]379<dd> </dd>
380<dl class="dl-horizontal">
381<dt>image</dt>
382<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]383
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]384<dd> </dd>
385<dt>geometry</dt>
386<dd>Define the region of the image to splice with members x, y, width, and height. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]387
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]388<dd> </dd>
389<dt>exception</dt>
390<dd>return any errors or warnings in this structure. </dd>
391
392<dd> </dd>
393</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]394<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransformImage">TransformImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]395
396<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>
397
398<p>This should only be used for single images.</p>
399
400<p>The format of the TransformImage method is:</p>
401
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]402<pre class="text">
403MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]404 const char *image_geometry)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]405</pre>
406
407<p>A description of each parameter follows:</p>
408
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]409<dd>
410</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]411
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]412<dd> </dd>
413<dl class="dl-horizontal">
414<dt>image</dt>
415<dd>the image The transformed image is returned as this parameter. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]416
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]417<dd> </dd>
418<dt>crop_geometry</dt>
419<dd>A crop geometry string. This geometry defines a subregion of the image to crop. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]420
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]421<dd> </dd>
422<dt>image_geometry</dt>
423<dd>An image geometry string. This geometry defines the final size of the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]424
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]425<dd> </dd>
426</dl>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]427<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="to_CropImageToTiles">to CropImageToTiles</a></h2>
428
429<p>to CropImageToTiles() or ResizeImage(), as appropriate.</p>
430
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]431<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransformImages">TransformImages</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]432
433<p>TransformImages() calls TransformImage() on each image of a sequence.</p>
434
435<p>The format of the TransformImage method is:</p>
436
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]437<pre class="text">
438MagickBooleanType TransformImages(Image **image,
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]439 const char *crop_geometry,const char *image_geometry)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]440</pre>
441
442<p>A description of each parameter follows:</p>
443
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]444<dd>
445</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]446
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]447<dd> </dd>
448<dl class="dl-horizontal">
449<dt>image</dt>
450<dd>the image The transformed image is returned as this parameter. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]451
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]452<dd> </dd>
453<dt>crop_geometry</dt>
454<dd>A crop geometry string. This geometry defines a subregion of the image to crop. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]455
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]456<dd> </dd>
457<dt>image_geometry</dt>
458<dd>An image geometry string. This geometry defines the final size of the image. </dd>
459
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]460<dd> </dd>
461</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]462<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransposeImage">TransposeImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]463
464<p>TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.</p>
465
466<p>The format of the TransposeImage method is:</p>
467
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]468<pre class="text">
469Image *TransposeImage(const Image *image,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]470</pre>
471
472<p>A description of each parameter follows:</p>
473
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]474<dd>
475</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]476
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]477<dd> </dd>
478<dl class="dl-horizontal">
479<dt>image</dt>
480<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]481
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]482<dd> </dd>
483<dt>exception</dt>
484<dd>return any errors or warnings in this structure. </dd>
485
486<dd> </dd>
487</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]488<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransverseImage">TransverseImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]489
490<p>TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.</p>
491
492<p>The format of the TransverseImage method is:</p>
493
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]494<pre class="text">
495Image *TransverseImage(const Image *image,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]496</pre>
497
498<p>A description of each parameter follows:</p>
499
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]500<dd>
501</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]502
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]503<dd> </dd>
504<dl class="dl-horizontal">
505<dt>image</dt>
506<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]507
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]508<dd> </dd>
509<dt>exception</dt>
510<dd>return any errors or warnings in this structure. </dd>
511
512<dd> </dd>
513</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]514<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TrimImage">TrimImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]515
516<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>
517
518<p>The format of the TrimImage method is:</p>
519
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]520<pre class="text">
521Image *TrimImage(const Image *image,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]522</pre>
523
524<p>A description of each parameter follows:</p>
525
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]526<dd>
527</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]528
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]529<dd> </dd>
530<dl class="dl-horizontal">
531<dt>image</dt>
532<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]533
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]534<dd> </dd>
535<dt>exception</dt>
536<dd>return any errors or warnings in this structure. </dd>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]537
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]538<dd> </dd>
539</dl>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]540</div>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]541 <footer class="magick-footer">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]542 <div class="magick-nav-item pull-left">
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]543 <a href="../support.html">Donate</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]544 </div>
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]545 <p><a href="../sitemap.html">Sitemap</a> •
546 <a href="../links.html">Related</a> •
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]547 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> •
548 <a href="http://jqmagick.imagemagick.org/">JqMagick</a> •
549 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
550</p>
551 <p><a href="transform.html#">Back to top</a> •
cristyabed55c2015-05-06 17:07:00 +0000[diff] [blame]552 <a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame^]553 <p><small>© 1999-2015 ImageMagick Studio LLC</small></p>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]554 </footer>
555</div><!-- /.container -->
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]556
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]557 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]558 <script src="../js/bootstrap.min.js"></script>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]559 <script type="text/javascript">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]560 /* <![CDATA[ */
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]561 (function() {
562 var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
563 s.type = 'text/javascript';
564 s.async = true;
565 s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
566 t.parentNode.insertBefore(s, t);
567 })();
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]568 /* ]]> */
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]569 </script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]570</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]571</body>
cristy5a367e42015-05-05 12:39:18 +0000[diff] [blame]572</html>