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