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