]> granicus.if.org Git - imagemagick/blob - www/api/transform.html
(no commit message)
[imagemagick] / www / api / transform.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html version="-//W3C//DTD XHTML 1.1//EN"\r
4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
8 <head>\r
9   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
10   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
11   <title>ImageMagick: MagickCore, C API for ImageMagick: Transform an Image</title>
12   <meta http-equiv="Content-Language" content="en-US"/>
13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
15   <meta name="Application-name" content="ImageMagick"/>
16   <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images."/>
17   <meta name="Application-url" content="http://www.imagemagick.org"/>
18   <meta name="Generator" content="PHP"/>
19   <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"/>
20   <meta name="Rating" content="GENERAL"/>
21   <meta name="Robots" content="INDEX, FOLLOW"/>
22   <meta name="Generator" content="ImageMagick Studio LLC"/>
23   <meta name="Author" content="ImageMagick Studio LLC"/>
24   <meta name="Revisit-after" content="2 DAYS"/>
25   <meta name="Resource-type" content="document"/>
26   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
27   <meta name="Distribution" content="Global"/>
28   <link rel="icon" href="../../images/wand.png"/>
29   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
30   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
31   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
32   <style type="text/css" media="all">\r
33     @import url("../../www/magick.css");\r
34   </style>\r
35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
36   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
37   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
38   <script type="text/javascript">\r
39     $(document).ready(function() {\r
40       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
41         'transitionIn'  : 'elastic',\r
42         'transitionOut' : 'elastic',\r
43         'overlayShow'   : false,\r
44         'opacity'       : true\r
45       });\r
46     });\r
47   </script>\r
48 </head>\r
49 \r
50 <body id="www-imagemagick-org">\r
51 <div class="titlebar">\r
52 <a href="../../index.html">\r
53   <img src="../../images/script.png" alt="[ImageMagick]"\r
54   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
55 <a href="http://www.networkredux.com">\r
56   <img src="../../images/networkredux.png" alt="[sponsor]"\r
57   style="margin-top: 42px; border: 0px; float: left;" /></a>\r
58 <a href="http://www.imagemagick.org/discourse-server/">\r
59   <img src="../../images/logo.jpg"\r
60   alt="ImageMagick Logo"\r
61   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
62 <a href="../../index.html">\r
63   <img src="../../images/sprite.jpg"\r
64   alt="ImageMagick Sprite"\r
65   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
66 </div>\r
67 \r
68 <div class="westbar">\r
69 \r
70 <div class="menu">
71   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
72 </div>
73 <div class="sep"></div>\r
74 <div class="menu">
75   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
76 </div>
77 <div class="sub">
78     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
79 </div>
80 <div class="sub">
81     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
82 </div>
83 <div class="sub">
84     <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
85 </div>
86 <div class="sub">
87     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
88 </div>
89 <div class="sep"></div>\r
90 <div class="menu">
91   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
92 </div>
93 <div class="sub">
94     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
95 </div>
96 <div class="sub">
97     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
98 </div>
99 <div class="sub">
100     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
101 </div>
102 <div class="menu">
103   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
104 </div>
105 <div class="sub">
106     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
107 </div>
108 <div class="sub">
109     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
110 </div>
111 <div class="sub">
112     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
113 </div>
114 <div class="sub">
115     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
116 </div>
117 <div class="sep"></div>\r
118 <div  class="menu">
119    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
120 </div>
121 <div class="sub">
122     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
123 </div>
124 <div class="sub">
125     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
126  </div>
127 <div class="menu">
128   <a title="Resources" href="../../www/resources.html">Resources</a>
129 </div>
130 <div class="menu">
131   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
132 </div>
133 <div class="menu">
134   <a title="Download" href="../../www/download.html">Download</a>
135 </div>
136 <div class="sep"></div>\r
137 <div class="menu">
138   <a title="Search" href="../../www/search.html">Search</a>
139 </div>
140 <div class="sep"></div>\r
141 <div class="menu">
142   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
143 </div>
144 <div  class="sub">
145   <a title="Site Map: Links" href="../../www/links.html">Links</a>
146 </div>
147 <div class="sep"></div>\r
148 <div  class="menu">
149   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
150
151 <div class="sponsbox">
152 <div  class="sponsor">
153   <a title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
154 </div>
155 <div  class="sponsor">
156   <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201106010090 alexanian media -->
157 </div>
158 <div  class="sponsor">
159   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
160 </div>
161 <div  class="sponsor">
162   <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
163 </div>
164 <div  class="sponsor">
165   <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
166 </div>
167 <div  class="sponsor">
168   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
169 </div>
170 <div class="sponsor">
171   <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
172 </div>
173 <div  class="sponsor">
174   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
175 </div>
176 <div  class="sponsor">
177    <a title="Sponsor: Fototapete" href=" http://www.allesdruck.de/Fototapete-Tapetendruck,category,8830.html">Fototapete</a><!-- 20110701000080 a-o.de -->
178 </div>
179 </div>
180 </div>
181 </div>\r
182 \r
183 <div class="eastbar">\r
184   <script type="text/javascript">\r
185   <!--\r
186     google_ad_client = "pub-3129977114552745";\r
187     google_ad_slot = "0574824969";\r
188     google_ad_width = 160;\r
189     google_ad_height = 600;\r
190   //-->\r
191   </script>\r
192   <script type="text/javascript"\r
193     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
194   </script>\r
195 </div>\r
196 \r
197 <div class="main">\r
198 \r
199 <h1>Module transform Methods</h1>
200 <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>
201
202 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ChopImage">ChopImage</a></h2>
203 <div class="doc-section">
204
205 <p>ChopImage() removes a region of an image and collapses the image to occupy the removed portion.</p>
206
207 <p>The format of the ChopImage method is:</p>
208
209 <pre class="code">
210   Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
211     ExceptionInfo *exception)
212 </pre>
213
214 <p>A description of each parameter follows:</p>
215
216 <h5>image</h5>
217 <p>the image.</p>
218
219 <h5>chop_info</h5>
220 <p>Define the region of the image to chop.</p>
221
222 <h5>exception</h5>
223 <p>return any errors or warnings in this structure.</p>
224
225  </div>
226 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="CropImage">CropImage</a></h2>
227 <div class="doc-section">
228
229 <p>CropImage() extracts a region of the image starting at the offset defined by geometry.</p>
230
231 <p>The format of the CropImage method is:</p>
232
233 <pre class="code">
234   Image *CropImage(const Image *image,const RectangleInfo *geometry,
235     ExceptionInfo *exception)
236 </pre>
237
238 <p>A description of each parameter follows:</p>
239
240 <h5>image</h5>
241 <p>the image.</p>
242
243 <h5>geometry</h5>
244 <p>Define the region of the image to crop with members x, y, width, and height.</p>
245
246 <h5>exception</h5>
247 <p>return any errors or warnings in this structure.</p>
248
249  </div>
250 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ExcerptImage">ExcerptImage</a></h2>
251 <div class="doc-section">
252
253 <p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p>
254
255 <p>The format of the ExcerptImage method is:</p>
256
257 <pre class="code">
258   Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
259     ExceptionInfo *exception)
260 </pre>
261
262 <p>A description of each parameter follows:</p>
263
264 <h5>image</h5>
265 <p>the image.</p>
266
267 <h5>geometry</h5>
268 <p>Define the region of the image to extend with members x, y, width, and height.</p>
269
270 <h5>exception</h5>
271 <p>return any errors or warnings in this structure.</p>
272
273  </div>
274 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ExtentImage">ExtentImage</a></h2>
275 <div class="doc-section">
276
277 <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>
278
279 <p>The format of the ExtentImage method is:</p>
280
281 <pre class="code">
282   Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
283     ExceptionInfo *exception)
284 </pre>
285
286 <p>A description of each parameter follows:</p>
287
288 <h5>image</h5>
289 <p>the image.</p>
290
291 <h5>geometry</h5>
292 <p>Define the region of the image to extend with members x, y, width, and height.</p>
293
294 <h5>exception</h5>
295 <p>return any errors or warnings in this structure.</p>
296
297  </div>
298 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="FlipImage">FlipImage</a></h2>
299 <div class="doc-section">
300
301 <p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p>
302
303 <p>The format of the FlipImage method is:</p>
304
305 <pre class="code">
306   Image *FlipImage(const Image *image,ExceptionInfo *exception)
307 </pre>
308
309 <p>A description of each parameter follows:</p>
310
311 <h5>image</h5>
312 <p>the image.</p>
313
314 <h5>exception</h5>
315 <p>return any errors or warnings in this structure.</p>
316
317  </div>
318 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="FlopImage">FlopImage</a></h2>
319 <div class="doc-section">
320
321 <p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p>
322
323 <p>The format of the FlopImage method is:</p>
324
325 <pre class="code">
326   Image *FlopImage(const Image *image,ExceptionInfo *exception)
327 </pre>
328
329 <p>A description of each parameter follows:</p>
330
331 <h5>image</h5>
332 <p>the image.</p>
333
334 <h5>exception</h5>
335 <p>return any errors or warnings in this structure.</p>
336
337  </div>
338 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="RollImage">RollImage</a></h2>
339 <div class="doc-section">
340
341 <p>RollImage() offsets an image as defined by x_offset and y_offset.</p>
342
343 <p>The format of the RollImage method is:</p>
344
345 <pre class="code">
346   Image *RollImage(const Image *image,const ssize_t x_offset,
347     const ssize_t y_offset,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>x_offset</h5>
356 <p>the number of columns to roll in the horizontal direction.</p>
357
358 <h5>y_offset</h5>
359 <p>the number of rows to roll in the vertical direction.</p>
360
361 <h5>exception</h5>
362 <p>return any errors or warnings in this structure.</p>
363
364  </div>
365 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ShaveImage">ShaveImage</a></h2>
366 <div class="doc-section">
367
368 <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>
369
370 <p>The format of the ShaveImage method is:</p>
371
372 <pre class="code">
373   Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
374     ExceptionInfo *exception)
375 </pre>
376
377 <p>A description of each parameter follows:</p>
378
379 <h5>shave_image</h5>
380 <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>
381
382 <h5>image</h5>
383 <p>the image.</p>
384
385 <h5>shave_info</h5>
386 <p>Specifies a pointer to a RectangleInfo which defines the region of the image to crop.</p>
387
388 <h5>exception</h5>
389 <p>return any errors or warnings in this structure.</p>
390
391  </div>
392 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="SpliceImage">SpliceImage</a></h2>
393 <div class="doc-section">
394
395 <p>SpliceImage() splices a solid color into the image as defined by the geometry.</p>
396
397 <p>The format of the SpliceImage method is:</p>
398
399 <pre class="code">
400   Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
401     ExceptionInfo *exception)
402 </pre>
403
404 <p>A description of each parameter follows:</p>
405
406 <h5>image</h5>
407 <p>the image.</p>
408
409 <h5>geometry</h5>
410 <p>Define the region of the image to splice with members x, y, width, and height.</p>
411
412 <h5>exception</h5>
413 <p>return any errors or warnings in this structure.</p>
414
415  </div>
416 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransformImage">TransformImage</a></h2>
417 <div class="doc-section">
418
419 <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>
420
421 <p>The format of the TransformImage method is:</p>
422
423 <pre class="code">
424   MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
425     const char *image_geometry)
426 </pre>
427
428 <p>A description of each parameter follows:</p>
429
430 <h5>image</h5>
431 <p>the image The transformed image is returned as this parameter.</p>
432
433 <h5>crop_geometry</h5>
434 <p>A crop geometry string.  This geometry defines a subregion of the image to crop.</p>
435
436 <h5>image_geometry</h5>
437 <p>An image geometry string.  This geometry defines the final size of the image.</p>
438
439  </div>
440 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransformImages">TransformImages</a></h2>
441 <div class="doc-section">
442
443 <p>TransformImages() calls TransformImage() on each image of a sequence.</p>
444
445 <p>The format of the TransformImage method is:</p>
446
447 <pre class="code">
448   MagickBooleanType TransformImages(Image **image,
449     const char *crop_geometry,const char *image_geometry)
450 </pre>
451
452 <p>A description of each parameter follows:</p>
453
454 <h5>image</h5>
455 <p>the image The transformed image is returned as this parameter.</p>
456
457 <h5>crop_geometry</h5>
458 <p>A crop geometry string.  This geometry defines a subregion of the image to crop.</p>
459
460 <h5>image_geometry</h5>
461 <p>An image geometry string.  This geometry defines the final size of the image.</p>
462
463  </div>
464 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransposeImage">TransposeImage</a></h2>
465 <div class="doc-section">
466
467 <p>TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.</p>
468
469 <p>The format of the TransposeImage method is:</p>
470
471 <pre class="code">
472   Image *TransposeImage(const Image *image,ExceptionInfo *exception)
473 </pre>
474
475 <p>A description of each parameter follows:</p>
476
477 <h5>image</h5>
478 <p>the image.</p>
479
480 <h5>exception</h5>
481 <p>return any errors or warnings in this structure.</p>
482
483  </div>
484 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransverseImage">TransverseImage</a></h2>
485 <div class="doc-section">
486
487 <p>TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.</p>
488
489 <p>The format of the TransverseImage method is:</p>
490
491 <pre class="code">
492   Image *TransverseImage(const Image *image,ExceptionInfo *exception)
493 </pre>
494
495 <p>A description of each parameter follows:</p>
496
497 <h5>image</h5>
498 <p>the image.</p>
499
500 <h5>exception</h5>
501 <p>return any errors or warnings in this structure.</p>
502
503  </div>
504 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TrimImage">TrimImage</a></h2>
505 <div class="doc-section">
506
507 <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>
508
509 <p>The format of the TrimImage method is:</p>
510
511 <pre class="code">
512   Image *TrimImage(const Image *image,ExceptionInfo *exception)
513 </pre>
514
515 <p>A description of each parameter follows:</p>
516
517 <h5>image</h5>
518 <p>the image.</p>
519
520 <h5>exception</h5>
521 <p>return any errors or warnings in this structure.</p>
522
523  </div>
524 \r
525 </div>\r
526 \r
527 <div id="linkbar">\r
528     <span id="linkbar-west">&nbsp;</span>\r
529     <span id="linkbar-center">\r
530       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
531       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
532     </span>\r
533     <span id="linkbar-east">&nbsp;</span>\r
534   </div>\r
535   <div class="footer">\r
536     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
537     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
538   </div>\r
539   <div style="clear: both; margin: 0; width: 100%; "></div>\r
540   <script type="text/javascript">\r
541     var _gaq = _gaq || [];\r
542     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
543     _gaq.push(['_trackPageview']);\r
544 \r
545     (function() {\r
546       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
547       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
548       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
549     })();\r
550   </script>\r
551 </body>\r
552 </html>\r