Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 3ed852eea50f9d4cd633efb8c2b054b8e33c2530 / . / www / api / transform.html
blob: df11055d8a8bad54b4708cb11c7674d4bfaf82c0 [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame^]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
7 <style type="text/css" media="screen,projection"><!--
8 @import url("../../www/magick.css");
9 --></style>
10 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
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="Generator" content="PHP"/>
16 <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"/>
17 <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."/>
18 <meta name="Rating" content="GENERAL"/>
19 <meta name="Robots" content="INDEX, FOLLOW"/>
20 <meta name="Generator" content="ImageMagick Studio LLC"/>
21 <meta name="Author" content="ImageMagick Studio LLC"/>
22 <meta name="Revisit-after" content="2 DAYS"/>
23 <meta name="Resource-type" content="document"/>
24 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
25 <meta name="Distribution" content="Global"/>
26</head>
27
28<body id="www-imagemagick-org">
29<div class="titlebar">
30<a href="../../index.html">
31 <img src="../../images/script.png" alt="[ImageMagick]"
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
33<a href="http://www.networkredux.com">
34 <img src="../../images/networkredux.png" alt="[sponsor]"
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
36<a href="http://www.imagemagick.org/discourse-server/">
37 <img src="../../images/logo.jpg" alt=""
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
39<a href="../../index.html">
40 <img src="../../images/sprite.jpg" alt=""
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
42</div>
43
44<div class="eastbar">
45
46<div class="menu">
47 <a href="../../index.html">About ImageMagick</a>
48</div>
49<div class="sep"></div>
50<div class="menu">
51 <a href="../../www/command-line-tools.html">Command-line Tools</a>
52</div>
53<div class="sub">
54 <a href="../../www/command-line-processing.html">Processing</a>
55</div>
56<div class="sub">
57 <a href="../../www/command-line-options.html">Options</a>
58</div>
59<div class="sub">
60 <a href="http://www.imagemagick.org/Usage/">Usage</a>
61</div>
62<div class="menu">
63 <a href="../../www/api.html">Program Interfaces</a>
64</div>
65<div class="sub">
66 <a href="../../www/magick-wand.html">MagickWand</a>
67</div>
68<div class="sub">
69 <a href="../../www/magick-core.html">MagickCore</a>
70</div>
71<div class="sub">
72 <a href="../../www/perl-magick.html">PerlMagick</a>
73</div>
74<div class="sub">
75 <a href="../../Magick++/">Magick++</a>
76</div>
77<div class="menu">
78 <a href="../../www/architecture.html">Architecture</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
82 <a href="../../www/install-source.html">Install from Source</a>
83</div>
84<div class="sub">
85 <a href="../../www/install-source.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a href="../../www/install-source.html#windows">Windows</a>
89 </div>
90<div class="menu">
91 <a href="../../www/binary-releases.html">Binary Releases</a>
92</div>
93<div class="sub">
94 <a href="../../www/binary-releases.html#unix">Unix</a>
95</div>
96<div class="sub">
97 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
98</div>
99<div class="sub">
100 <a href="../../www/binary-releases.html#windows">Windows</a>
101</div>
102<div class="menu">
103 <a href="../../www/resources.html">Resources</a>
104</div>
105<div class="sep"></div>
106<div class="menu">
107 <a href="../../www/download.html">Download</a>
108</div>
109<div class="sep"></div>
110<div class="menu">
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112</div>
113<div class="sep"></div>
114<div class="menu">
115 <a href="../../www/sitemap.html">Site Map</a>
116</div>
117<div class="sub">
118 <a href="../../www/links.html">Links</a>
119</div>
120<div class="sep"></div>
121<div class="menu">
122 <a href="../../www/sponsors.html">Sponsors:</a>
123
124<div class="sponsbox">
125<div class="sponsor">
126 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
127</div>
128<div class="sponsor">
129 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
130</div>
131<div class="sponsor">
132 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
133</div>
134<div class="sponsor">
135 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
136</div>
137<div class="sponsor">
138 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
139</div>
140</div>
141</div>
142
143
144</div>
145
146<div class="main">
147
148<p class="navigation-index">[<a href="#Chop">Chop</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>
149
150<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
151_8c.html" target="source" name="Chop">Chop</a></h2>
152<div class="doc-section">
153
154<p>Chop() removes a region of an image and collapses the image to occupy the removed portion.</p></ol>
155
156<p>The format of the ChopImage method is:</p>
157
158<pre class="code">
159 Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
160 ExceptionInfo *exception)
161</pre>
162
163<p>A description of each parameter follows:</p></ol>
164
165<h5>image</h5>
166<ol><p>the image.</p></ol>
167
168<h5>chop_info</h5>
169<ol><p>Define the region of the image to chop.</p></ol>
170
171<h5>exception</h5>
172<ol><p>return any errors or warnings in this structure.</p></ol>
173
174 </div>
175<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
176_8c.html" target="source" name="CropImage">CropImage</a></h2>
177<div class="doc-section">
178
179<p>CropImage() extracts a region of the image starting at the offset defined by geometry.</p></ol>
180
181<p>The format of the CropImage method is:</p>
182
183<pre class="code">
184 Image *CropImage(const Image *image,const RectangleInfo *geometry,
185 ExceptionInfo *exception)
186</pre>
187
188<p>A description of each parameter follows:</p></ol>
189
190<h5>image</h5>
191<ol><p>the image.</p></ol>
192
193<h5>geometry</h5>
194<ol><p>Define the region of the image to crop with members x, y, width, and height.</p></ol>
195
196<h5>exception</h5>
197<ol><p>return any errors or warnings in this structure.</p></ol>
198
199 </div>
200<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
201_8c.html" target="source" name="ExcerptImage">ExcerptImage</a></h2>
202<div class="doc-section">
203
204<p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p></ol>
205
206<p>The format of the ExcerptImage method is:</p>
207
208<pre class="code">
209 Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
210 ExceptionInfo *exception)
211</pre>
212
213<p>A description of each parameter follows:</p></ol>
214
215<h5>image</h5>
216<ol><p>the image.</p></ol>
217
218<h5>geometry</h5>
219<ol><p>Define the region of the image to extend with members x, y, width, and height.</p></ol>
220
221<h5>exception</h5>
222<ol><p>return any errors or warnings in this structure.</p></ol>
223
224 </div>
225<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
226_8c.html" target="source" name="ExtentImage">ExtentImage</a></h2>
227<div class="doc-section">
228
229<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>
230
231<p>The format of the ExtentImage method is:</p>
232
233<pre class="code">
234 Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
235 ExceptionInfo *exception)
236</pre>
237
238<p>A description of each parameter follows:</p></ol>
239
240<h5>image</h5>
241<ol><p>the image.</p></ol>
242
243<h5>geometry</h5>
244<ol><p>Define the region of the image to extend with members x, y, width, and height.</p></ol>
245
246<h5>exception</h5>
247<ol><p>return any errors or warnings in this structure.</p></ol>
248
249 </div>
250<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
251_8c.html" target="source" name="FlipImage">FlipImage</a></h2>
252<div class="doc-section">
253
254<p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p></ol>
255
256<p>The format of the FlipImage method is:</p>
257
258<pre class="code">
259 Image *FlipImage(const Image *image,ExceptionInfo *exception)
260</pre>
261
262<p>A description of each parameter follows:</p></ol>
263
264<h5>image</h5>
265<ol><p>the image.</p></ol>
266
267<h5>exception</h5>
268<ol><p>return any errors or warnings in this structure.</p></ol>
269
270 </div>
271<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
272_8c.html" target="source" name="FlopImage">FlopImage</a></h2>
273<div class="doc-section">
274
275<p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p></ol>
276
277<p>The format of the FlopImage method is:</p>
278
279<pre class="code">
280 Image *FlopImage(const Image *image,ExceptionInfo *exception)
281</pre>
282
283<p>A description of each parameter follows:</p></ol>
284
285<h5>image</h5>
286<ol><p>the image.</p></ol>
287
288<h5>exception</h5>
289<ol><p>return any errors or warnings in this structure.</p></ol>
290
291 </div>
292<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
293_8c.html" target="source" name="RollImage">RollImage</a></h2>
294<div class="doc-section">
295
296<p>RollImage() offsets an image as defined by x_offset and y_offset.</p></ol>
297
298<p>The format of the RollImage method is:</p>
299
300<pre class="code">
301 Image *RollImage(const Image *image,const long x_offset,
302 const long y_offset,ExceptionInfo *exception)
303</pre>
304
305<p>A description of each parameter follows:</p></ol>
306
307<h5>image</h5>
308<ol><p>the image.</p></ol>
309
310<h5>x_offset</h5>
311<ol><p>the number of columns to roll in the horizontal direction.</p></ol>
312
313<h5>y_offset</h5>
314<ol><p>the number of rows to roll in the vertical direction.</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="ShaveImage">ShaveImage</a></h2>
322<div class="doc-section">
323
324<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>
325
326<p>The format of the ShaveImage method is:</p>
327
328<pre class="code">
329 Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
330 ExceptionInfo *exception)
331</pre>
332
333<p>A description of each parameter follows:</p></ol>
334
335<h5>shave_image</h5>
336<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>
337
338<h5>image</h5>
339<ol><p>the image.</p></ol>
340
341<h5>shave_info</h5>
342<ol><p>Specifies a pointer to a RectangleInfo which defines the region of the image to crop.</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="SpliceImage">SpliceImage</a></h2>
350<div class="doc-section">
351
352<p>SpliceImage() splices a solid color into the image as defined by the geometry.</p></ol>
353
354<p>The format of the SpliceImage method is:</p>
355
356<pre class="code">
357 Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
358 ExceptionInfo *exception)
359</pre>
360
361<p>A description of each parameter follows:</p></ol>
362
363<h5>image</h5>
364<ol><p>the image.</p></ol>
365
366<h5>geometry</h5>
367<ol><p>Define the region of the image to splice with members x, y, width, and height.</p></ol>
368
369<h5>exception</h5>
370<ol><p>return any errors or warnings in this structure.</p></ol>
371
372 </div>
373<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
374_8c.html" target="source" name="TransformImage">TransformImage</a></h2>
375<div class="doc-section">
376
377<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>
378
379<p>The format of the TransformImage method is:</p>
380
381<pre class="code">
382 MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
383 const char *image_geometry)
384</pre>
385
386<p>A description of each parameter follows:</p></ol>
387
388<h5>image</h5>
389<ol><p>the image The transformed image is returned as this parameter.</p></ol>
390
391<h5>crop_geometry</h5>
392<ol><p>A crop geometry string. This geometry defines a subregion of the image to crop.</p></ol>
393
394<h5>image_geometry</h5>
395<ol><p>An image geometry string. This geometry defines the final size of the image.</p></ol>
396
397 </div>
398<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
399_8c.html" target="source" name="TransformImages">TransformImages</a></h2>
400<div class="doc-section">
401
402<p>TransformImages() calls TransformImage() on each image of a sequence.</p></ol>
403
404<p>The format of the TransformImage method is:</p>
405
406<pre class="code">
407 MagickBooleanType TransformImages(Image **image,
408 const char *crop_geometry,const char *image_geometry)
409</pre>
410
411<p>A description of each parameter follows:</p></ol>
412
413<h5>image</h5>
414<ol><p>the image The transformed image is returned as this parameter.</p></ol>
415
416<h5>crop_geometry</h5>
417<ol><p>A crop geometry string. This geometry defines a subregion of the image to crop.</p></ol>
418
419<h5>image_geometry</h5>
420<ol><p>An image geometry string. This geometry defines the final size of the image.</p></ol>
421
422 </div>
423<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
424_8c.html" target="source" name="TransposeImage">TransposeImage</a></h2>
425<div class="doc-section">
426
427<p>TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.</p></ol>
428
429<p>The format of the TransposeImage method is:</p>
430
431<pre class="code">
432 Image *TransposeImage(const Image *image,ExceptionInfo *exception)
433</pre>
434
435<p>A description of each parameter follows:</p></ol>
436
437<h5>image</h5>
438<ol><p>the image.</p></ol>
439
440<h5>exception</h5>
441<ol><p>return any errors or warnings in this structure.</p></ol>
442
443 </div>
444<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
445_8c.html" target="source" name="TransverseImage">TransverseImage</a></h2>
446<div class="doc-section">
447
448<p>TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.</p></ol>
449
450<p>The format of the TransverseImage method is:</p>
451
452<pre class="code">
453 Image *TransverseImage(const Image *image,ExceptionInfo *exception)
454</pre>
455
456<p>A description of each parameter follows:</p></ol>
457
458<h5>image</h5>
459<ol><p>the image.</p></ol>
460
461<h5>exception</h5>
462<ol><p>return any errors or warnings in this structure.</p></ol>
463
464 </div>
465<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
466_8c.html" target="source" name="TrimImage">TrimImage</a></h2>
467<div class="doc-section">
468
469<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>
470
471<p>The format of the TrimImage method is:</p>
472
473<pre class="code">
474 Image *TrimImage(const Image *image,ExceptionInfo *exception)
475</pre>
476
477<p>A description of each parameter follows:</p></ol>
478
479<h5>image</h5>
480<ol><p>the image.</p></ol>
481
482<h5>exception</h5>
483<ol><p>return any errors or warnings in this structure.</p></ol>
484
485 </div>
486
487</div>
488
489<div id="linkbar">
490 <!-- <span id="linkbar-west">&nbsp;</span> -->
491 <span id="linkbar-center">
492 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
493 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
494 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
495 </span>
496 <span id="linkbar-east">&nbsp;</span>
497 </div>
498 <div class="footer">
499 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
500 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
501 </div>
502 <div style="clear: both; margin: 0; width: 100%; "></div>
503</body>
504</html>