blob: 018c4aa9dad0e63c5feee19495c4278c00c5ae32 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy2c839602010-04-03 02:32:08 +00005 <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +00006 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
8 <style type="text/css" media="screen,projection"><!--
9 @import url("../../www/magick.css");
10 --></style>
cristy3ed852e2009-09-05 21:47:34 +000011 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Transform an Image</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <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"/>
18 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +000025 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000026 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +000027</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
cristy3ed852e2009-09-05 21:47:34 +000047<div class="menu">
48 <a href="../../index.html">About ImageMagick</a>
49</div>
cristy3eaa0ef2010-03-06 20:35:26 +000050<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000051<div class="menu">
52 <a href="../../www/command-line-tools.html">Command-line Tools</a>
53</div>
54<div class="sub">
55 <a href="../../www/command-line-processing.html">Processing</a>
56</div>
57<div class="sub">
58 <a href="../../www/command-line-options.html">Options</a>
59</div>
60<div class="sub">
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
62</div>
63<div class="menu">
64 <a href="../../www/api.html">Program Interfaces</a>
65</div>
66<div class="sub">
67 <a href="../../www/magick-wand.html">MagickWand</a>
68</div>
69<div class="sub">
70 <a href="../../www/magick-core.html">MagickCore</a>
71</div>
72<div class="sub">
73 <a href="../../www/perl-magick.html">PerlMagick</a>
74</div>
75<div class="sub">
76 <a href="../../Magick++/">Magick++</a>
77</div>
78<div class="menu">
79 <a href="../../www/architecture.html">Architecture</a>
80</div>
cristy3eaa0ef2010-03-06 20:35:26 +000081<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000082<div class="menu">
83 <a href="../../www/install-source.html">Install from Source</a>
84</div>
85<div class="sub">
86 <a href="../../www/install-source.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a href="../../www/install-source.html#windows">Windows</a>
90 </div>
91<div class="menu">
92 <a href="../../www/binary-releases.html">Binary Releases</a>
93</div>
94<div class="sub">
95 <a href="../../www/binary-releases.html#unix">Unix</a>
96</div>
97<div class="sub">
98 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
99</div>
100<div class="sub">
101 <a href="../../www/binary-releases.html#windows">Windows</a>
102</div>
103<div class="menu">
104 <a href="../../www/resources.html">Resources</a>
105</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000106<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000107<div class="menu">
108 <a href="../../www/download.html">Download</a>
109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000111<div class="menu">
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000115<div class="menu">
116 <a href="../../www/sitemap.html">Site Map</a>
117</div>
118<div class="sub">
119 <a href="../../www/links.html">Links</a>
120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000122<div class="menu">
123 <a href="../../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristy2c839602010-04-03 02:32:08 +0000127 <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
cristyb36feb22010-03-26 16:54:37 +0000128</div>
129<div class="sponsor">
cristy8f900122010-03-05 15:26:31 +0000130 <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
131</div>
132<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000133 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
cristyc1c61662009-09-30 14:04:37 +0000134</div>
135<div class="sponsor">
cristycdbe2742010-02-07 19:30:44 +0000136 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristy0f61e612009-11-10 20:03:57 +0000137</div>
138<div class="sponsor">
139 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristy916e1922009-10-01 12:52:47 +0000140</div>
141<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000142 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
143</div>
144<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000145 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy3ed852e2009-09-05 21:47:34 +0000146</div>
cristy3ed852e2009-09-05 21:47:34 +0000147</div>
148</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000149
150
151</div>
152
153<div class="main">
154
cristyf1196bb2010-02-13 21:18:03 +0000155<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 +0000156
157<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
cristyf1196bb2010-02-13 21:18:03 +0000158_8c.html" target="source" name="ChopImage">ChopImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000159<div class="doc-section">
160
cristyf1196bb2010-02-13 21:18:03 +0000161<p>ChopImage() removes a region of an image and collapses the image to occupy the removed portion.</p></ol>
cristy3ed852e2009-09-05 21:47:34 +0000162
163<p>The format of the ChopImage method is:</p>
164
165<pre class="code">
166 Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
167 ExceptionInfo *exception)
168</pre>
169
170<p>A description of each parameter follows:</p></ol>
171
172<h5>image</h5>
173<ol><p>the image.</p></ol>
174
175<h5>chop_info</h5>
176<ol><p>Define the region of the image to chop.</p></ol>
177
178<h5>exception</h5>
179<ol><p>return any errors or warnings in this structure.</p></ol>
180
181 </div>
182<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
183_8c.html" target="source" name="CropImage">CropImage</a></h2>
184<div class="doc-section">
185
186<p>CropImage() extracts a region of the image starting at the offset defined by geometry.</p></ol>
187
188<p>The format of the CropImage method is:</p>
189
190<pre class="code">
191 Image *CropImage(const Image *image,const RectangleInfo *geometry,
192 ExceptionInfo *exception)
193</pre>
194
195<p>A description of each parameter follows:</p></ol>
196
197<h5>image</h5>
198<ol><p>the image.</p></ol>
199
200<h5>geometry</h5>
201<ol><p>Define the region of the image to crop with members x, y, width, and height.</p></ol>
202
203<h5>exception</h5>
204<ol><p>return any errors or warnings in this structure.</p></ol>
205
206 </div>
207<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
208_8c.html" target="source" name="ExcerptImage">ExcerptImage</a></h2>
209<div class="doc-section">
210
211<p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p></ol>
212
213<p>The format of the ExcerptImage method is:</p>
214
215<pre class="code">
216 Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
217 ExceptionInfo *exception)
218</pre>
219
220<p>A description of each parameter follows:</p></ol>
221
222<h5>image</h5>
223<ol><p>the image.</p></ol>
224
225<h5>geometry</h5>
226<ol><p>Define the region of the image to extend with members x, y, width, and height.</p></ol>
227
228<h5>exception</h5>
229<ol><p>return any errors or warnings in this structure.</p></ol>
230
231 </div>
232<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
233_8c.html" target="source" name="ExtentImage">ExtentImage</a></h2>
234<div class="doc-section">
235
236<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></ol>
237
238<p>The format of the ExtentImage method is:</p>
239
240<pre class="code">
241 Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
242 ExceptionInfo *exception)
243</pre>
244
245<p>A description of each parameter follows:</p></ol>
246
247<h5>image</h5>
248<ol><p>the image.</p></ol>
249
250<h5>geometry</h5>
251<ol><p>Define the region of the image to extend with members x, y, width, and height.</p></ol>
252
253<h5>exception</h5>
254<ol><p>return any errors or warnings in this structure.</p></ol>
255
256 </div>
257<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
258_8c.html" target="source" name="FlipImage">FlipImage</a></h2>
259<div class="doc-section">
260
261<p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p></ol>
262
263<p>The format of the FlipImage method is:</p>
264
265<pre class="code">
266 Image *FlipImage(const Image *image,ExceptionInfo *exception)
267</pre>
268
269<p>A description of each parameter follows:</p></ol>
270
271<h5>image</h5>
272<ol><p>the image.</p></ol>
273
274<h5>exception</h5>
275<ol><p>return any errors or warnings in this structure.</p></ol>
276
277 </div>
278<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
279_8c.html" target="source" name="FlopImage">FlopImage</a></h2>
280<div class="doc-section">
281
282<p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p></ol>
283
284<p>The format of the FlopImage method is:</p>
285
286<pre class="code">
287 Image *FlopImage(const Image *image,ExceptionInfo *exception)
288</pre>
289
290<p>A description of each parameter follows:</p></ol>
291
292<h5>image</h5>
293<ol><p>the image.</p></ol>
294
295<h5>exception</h5>
296<ol><p>return any errors or warnings in this structure.</p></ol>
297
298 </div>
299<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
300_8c.html" target="source" name="RollImage">RollImage</a></h2>
301<div class="doc-section">
302
303<p>RollImage() offsets an image as defined by x_offset and y_offset.</p></ol>
304
305<p>The format of the RollImage method is:</p>
306
307<pre class="code">
308 Image *RollImage(const Image *image,const long x_offset,
309 const long y_offset,ExceptionInfo *exception)
310</pre>
311
312<p>A description of each parameter follows:</p></ol>
313
314<h5>image</h5>
315<ol><p>the image.</p></ol>
316
317<h5>x_offset</h5>
318<ol><p>the number of columns to roll in the horizontal direction.</p></ol>
319
320<h5>y_offset</h5>
321<ol><p>the number of rows to roll in the vertical direction.</p></ol>
322
323<h5>exception</h5>
324<ol><p>return any errors or warnings in this structure.</p></ol>
325
326 </div>
327<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
328_8c.html" target="source" name="ShaveImage">ShaveImage</a></h2>
329<div class="doc-section">
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></ol>
332
333<p>The format of the ShaveImage method is:</p>
334
335<pre class="code">
336 Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
337 ExceptionInfo *exception)
338</pre>
339
340<p>A description of each parameter follows:</p></ol>
341
342<h5>shave_image</h5>
343<ol><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></ol>
344
345<h5>image</h5>
346<ol><p>the image.</p></ol>
347
348<h5>shave_info</h5>
349<ol><p>Specifies a pointer to a RectangleInfo which defines the region of the image to crop.</p></ol>
350
351<h5>exception</h5>
352<ol><p>return any errors or warnings in this structure.</p></ol>
353
354 </div>
355<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
356_8c.html" target="source" name="SpliceImage">SpliceImage</a></h2>
357<div class="doc-section">
358
359<p>SpliceImage() splices a solid color into the image as defined by the geometry.</p></ol>
360
361<p>The format of the SpliceImage method is:</p>
362
363<pre class="code">
364 Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
365 ExceptionInfo *exception)
366</pre>
367
368<p>A description of each parameter follows:</p></ol>
369
370<h5>image</h5>
371<ol><p>the image.</p></ol>
372
373<h5>geometry</h5>
374<ol><p>Define the region of the image to splice with members x, y, width, and height.</p></ol>
375
376<h5>exception</h5>
377<ol><p>return any errors or warnings in this structure.</p></ol>
378
379 </div>
380<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
381_8c.html" target="source" name="TransformImage">TransformImage</a></h2>
382<div class="doc-section">
383
384<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></ol>
385
386<p>The format of the TransformImage method is:</p>
387
388<pre class="code">
389 MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
390 const char *image_geometry)
391</pre>
392
393<p>A description of each parameter follows:</p></ol>
394
395<h5>image</h5>
396<ol><p>the image The transformed image is returned as this parameter.</p></ol>
397
398<h5>crop_geometry</h5>
399<ol><p>A crop geometry string. This geometry defines a subregion of the image to crop.</p></ol>
400
401<h5>image_geometry</h5>
402<ol><p>An image geometry string. This geometry defines the final size of the image.</p></ol>
403
404 </div>
405<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
406_8c.html" target="source" name="TransformImages">TransformImages</a></h2>
407<div class="doc-section">
408
409<p>TransformImages() calls TransformImage() on each image of a sequence.</p></ol>
410
411<p>The format of the TransformImage method is:</p>
412
413<pre class="code">
414 MagickBooleanType TransformImages(Image **image,
415 const char *crop_geometry,const char *image_geometry)
416</pre>
417
418<p>A description of each parameter follows:</p></ol>
419
420<h5>image</h5>
421<ol><p>the image The transformed image is returned as this parameter.</p></ol>
422
423<h5>crop_geometry</h5>
424<ol><p>A crop geometry string. This geometry defines a subregion of the image to crop.</p></ol>
425
426<h5>image_geometry</h5>
427<ol><p>An image geometry string. This geometry defines the final size of the image.</p></ol>
428
429 </div>
430<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
431_8c.html" target="source" name="TransposeImage">TransposeImage</a></h2>
432<div class="doc-section">
433
434<p>TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.</p></ol>
435
436<p>The format of the TransposeImage method is:</p>
437
438<pre class="code">
439 Image *TransposeImage(const Image *image,ExceptionInfo *exception)
440</pre>
441
442<p>A description of each parameter follows:</p></ol>
443
444<h5>image</h5>
445<ol><p>the image.</p></ol>
446
447<h5>exception</h5>
448<ol><p>return any errors or warnings in this structure.</p></ol>
449
450 </div>
451<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
452_8c.html" target="source" name="TransverseImage">TransverseImage</a></h2>
453<div class="doc-section">
454
455<p>TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.</p></ol>
456
457<p>The format of the TransverseImage method is:</p>
458
459<pre class="code">
460 Image *TransverseImage(const Image *image,ExceptionInfo *exception)
461</pre>
462
463<p>A description of each parameter follows:</p></ol>
464
465<h5>image</h5>
466<ol><p>the image.</p></ol>
467
468<h5>exception</h5>
469<ol><p>return any errors or warnings in this structure.</p></ol>
470
471 </div>
472<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
473_8c.html" target="source" name="TrimImage">TrimImage</a></h2>
474<div class="doc-section">
475
476<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></ol>
477
478<p>The format of the TrimImage method is:</p>
479
480<pre class="code">
481 Image *TrimImage(const Image *image,ExceptionInfo *exception)
482</pre>
483
484<p>A description of each parameter follows:</p></ol>
485
486<h5>image</h5>
487<ol><p>the image.</p></ol>
488
489<h5>exception</h5>
490<ol><p>return any errors or warnings in this structure.</p></ol>
491
492 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000493
494</div>
495
496<div id="linkbar">
497 <!-- <span id="linkbar-west">&nbsp;</span> -->
498 <span id="linkbar-center">
499 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristy7d34ef22010-03-25 01:11:22 +0000500 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000501 </span>
502 <span id="linkbar-east">&nbsp;</span>
503 </div>
504 <div class="footer">
505 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
506 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
507 </div>
508 <div style="clear: both; margin: 0; width: 100%; "></div>
509</body>
510</html>