Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 999b6470f3620c44c55bd1ed8956de6dd1d02c88 / . / www / api / resize.html
blob: 4bb5fb1ab15a7f8148a41f6d1dc97175a762bdc1 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +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">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6 <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 +0000[diff] [blame]11 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Resize 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:, resize, 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 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]27</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 +0000[diff] [blame]47<div class="menu">
48 <a href="../../index.html">About ImageMagick</a>
49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<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 +0000[diff] [blame]81<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<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 +0000[diff] [blame]106<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
108 <a href="../../www/download.html">Download</a>
109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<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 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
123 <a href="../../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristy69e3f922010-04-10 14:20:03 +0000[diff] [blame]127 <a href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
cristy5e6c2fe2010-03-20 20:36:58 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]130 <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
131</div>
132<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]133 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
134</div>
135<div class="sponsor">
cristycdbe2742010-02-07 19:30:44 +0000[diff] [blame]136 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristy2744bd92009-11-08 22:57:52 +0000[diff] [blame]137</div>
138<div class="sponsor">
139 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]140</div>
141<div class="sponsor">
142 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
143</div>
144<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]145 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
148</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]149
150
151</div>
152
153<div class="main">
154
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<p class="navigation-index">[<a href="#AdaptiveResizeImage">AdaptiveResizeImage</a> &bull; <a href="#MagnifyImage">MagnifyImage</a> &bull; <a href="#MinifyImage">MinifyImage</a> &bull; <a href="#ResampleImage">ResampleImage</a> &bull; <a href="#LiquidRescaleImage">LiquidRescaleImage</a> &bull; <a href="#ResizeImage">ResizeImage</a> &bull; <a href="#SampleImage">SampleImage</a> &bull; <a href="#ScaleImage">ScaleImage</a> &bull; <a href="#ThumbnailImage">ThumbnailImage</a> &bull; <a href="#ZoomImage">ZoomImage</a>]</p>
156
157<h2><a href="http://www.imagemagick.org/api/MagickCore/resize
158_8c.html" target="source" name="AdaptiveResizeImage">AdaptiveResizeImage</a></h2>
159<div class="doc-section">
160
161<p>AdaptiveResizeImage() adaptively resize image with pixel resampling.</p></ol>
162
163<p>The format of the AdaptiveResizeImage method is:</p>
164
165<pre class="code">
166 Image *AdaptiveResizeImage(const Image *image,
167 const unsigned long columns,const unsigned long rows,
168 ExceptionInfo *exception)
169</pre>
170
171<p>A description of each parameter follows:</p></ol>
172
173<h5>image</h5>
174<ol><p>the image.</p></ol>
175
176<h5>columns</h5>
177<ol><p>the number of columns in the resized image.</p></ol>
178
179<h5>rows</h5>
180<ol><p>the number of rows in the resized image.</p></ol>
181
182<h5>exception</h5>
183<ol><p>return any errors or warnings in this structure.</p></ol>
184
185 </div>
186<h2><a href="http://www.imagemagick.org/api/MagickCore/resize
187_8c.html" target="source" name="MagnifyImage">MagnifyImage</a></h2>
188<div class="doc-section">
189
190<p>MagnifyImage() is a convenience method that scales an image proportionally to twice its size.</p></ol>
191
192<p>The format of the MagnifyImage method is:</p>
193
194<pre class="code">
195 Image *MagnifyImage(const Image *image,ExceptionInfo *exception)
196</pre>
197
198<p>A description of each parameter follows:</p></ol>
199
200<h5>image</h5>
201<ol><p>the image.</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/resize
208_8c.html" target="source" name="MinifyImage">MinifyImage</a></h2>
209<div class="doc-section">
210
211<p>MinifyImage() is a convenience method that scales an image proportionally to half its size.</p></ol>
212
213<p>The format of the MinifyImage method is:</p>
214
215<pre class="code">
216 Image *MinifyImage(const Image *image,ExceptionInfo *exception)
217</pre>
218
219<p>A description of each parameter follows:</p></ol>
220
221<h5>image</h5>
222<ol><p>the image.</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/resize
229_8c.html" target="source" name="ResampleImage">ResampleImage</a></h2>
230<div class="doc-section">
231
232<p>ResampleImage() resize image in terms of its pixel size, so that when displayed at the given resolution it will be the same size in terms of real world units as the original image at the original resolution.</p></ol>
233
234<p>The format of the ResampleImage method is:</p>
235
236<pre class="code">
237 Image *ResampleImage(Image *image,const double x_resolution,
238 const double y_resolution,const FilterTypes filter,const double blur,
239 ExceptionInfo *exception)
240</pre>
241
242<p>A description of each parameter follows:</p></ol>
243
244<h5>image</h5>
245<ol><p>the image to be resized to fit the given resolution.</p></ol>
246
247<h5>x_resolution</h5>
248<ol><p>the new image x resolution.</p></ol>
249
250<h5>y_resolution</h5>
251<ol><p>the new image y resolution.</p></ol>
252
253<h5>filter</h5>
254<ol><p>Image filter to use.</p></ol>
255
256<h5>blur</h5>
257<ol><p>the blur factor where > 1 is blurry, < 1 is sharp.</p></ol>
258
259 </div>
260<h2><a href="http://www.imagemagick.org/api/MagickCore/resize
261_8c.html" target="source" name="LiquidRescaleImage">LiquidRescaleImage</a></h2>
262<div class="doc-section">
263
264<p>LiquidRescaleImage() rescales image with seam carving.</p></ol>
265
266<p>The format of the LiquidRescaleImage method is:</p>
267
268<pre class="code">
269 Image *LiquidRescaleImage(const Image *image,
270 const unsigned long columns,const unsigned long rows,
271 const double delta_x,const double rigidity,ExceptionInfo *exception)
272</pre>
273
274<p>A description of each parameter follows:</p></ol>
275
276<h5>image</h5>
277<ol><p>the image.</p></ol>
278
279<h5>columns</h5>
280<ol><p>the number of columns in the rescaled image.</p></ol>
281
282<h5>rows</h5>
283<ol><p>the number of rows in the rescaled image.</p></ol>
284
285<h5>delta_x</h5>
286<ol><p>maximum seam transversal step (0 means straight seams).</p></ol>
287
288<h5>rigidity</h5>
289<ol><p>introduce a bias for non-straight seams (typically 0).</p></ol>
290
291<h5>exception</h5>
292<ol><p>return any errors or warnings in this structure.</p></ol>
293
294 </div>
295<h2><a href="http://www.imagemagick.org/api/MagickCore/resize
296_8c.html" target="source" name="ResizeImage">ResizeImage</a></h2>
297<div class="doc-section">
298
299<p>ResizeImage() scales an image to the desired dimensions, using the given filter (see AcquireFilterInfo() ).</p></ol>
300
301<p>If an undefined filter is given the filter defaults to Mitchell for a colormapped image, a image with a matte channel, or if the image is enlarged. Otherwise the filter defaults to a Lanczos.</p></ol>
302
303<p>ResizeImage() was inspired by Paul Heckbert's "zoom" program.</p></ol>
304
305<p>The format of the ResizeImage method is:</p>
306
307<pre class="code">
308 Image *ResizeImage(Image *image,const unsigned long columns,
309 const unsigned long rows,const FilterTypes filter,const double blur,
310 ExceptionInfo *exception)
311</pre>
312
313<p>A description of each parameter follows:</p></ol>
314
315<h5>image</h5>
316<ol><p>the image.</p></ol>
317
318<h5>columns</h5>
319<ol><p>the number of columns in the scaled image.</p></ol>
320
321<h5>rows</h5>
322<ol><p>the number of rows in the scaled image.</p></ol>
323
324<h5>filter</h5>
325<ol><p>Image filter to use.</p></ol>
326
327<h5>blur</h5>
328<ol><p>the blur factor where > 1 is blurry, < 1 is sharp. Typically set this to 1.0.</p></ol>
329
330<h5>exception</h5>
331<ol><p>return any errors or warnings in this structure.</p></ol>
332
333 </div>
334<h2><a href="http://www.imagemagick.org/api/MagickCore/resize
335_8c.html" target="source" name="SampleImage">SampleImage</a></h2>
336<div class="doc-section">
337
338<p>SampleImage() scales an image to the desired dimensions with pixel sampling. Unlike other scaling methods, this method does not introduce any additional color into the scaled image.</p></ol>
339
340<p>The format of the SampleImage method is:</p>
341
342<pre class="code">
343 Image *SampleImage(const Image *image,const unsigned long columns,
344 const unsigned long rows,ExceptionInfo *exception)
345</pre>
346
347<p>A description of each parameter follows:</p></ol>
348
349<h5>image</h5>
350<ol><p>the image.</p></ol>
351
352<h5>columns</h5>
353<ol><p>the number of columns in the sampled image.</p></ol>
354
355<h5>rows</h5>
356<ol><p>the number of rows in the sampled image.</p></ol>
357
358<h5>exception</h5>
359<ol><p>return any errors or warnings in this structure.</p></ol>
360
361 </div>
362<h2><a href="http://www.imagemagick.org/api/MagickCore/resize
363_8c.html" target="source" name="ScaleImage">ScaleImage</a></h2>
364<div class="doc-section">
365
366<p>ScaleImage() changes the size of an image to the given dimensions.</p></ol>
367
368<p>The format of the ScaleImage method is:</p>
369
370<pre class="code">
371 Image *ScaleImage(const Image *image,const unsigned long columns,
372 const unsigned long rows,ExceptionInfo *exception)
373</pre>
374
375<p>A description of each parameter follows:</p></ol>
376
377<h5>image</h5>
378<ol><p>the image.</p></ol>
379
380<h5>columns</h5>
381<ol><p>the number of columns in the scaled image.</p></ol>
382
383<h5>rows</h5>
384<ol><p>the number of rows in the scaled image.</p></ol>
385
386<h5>exception</h5>
387<ol><p>return any errors or warnings in this structure.</p></ol>
388
389 </div>
390<h2><a href="http://www.imagemagick.org/api/MagickCore/resize
391_8c.html" target="source" name="ThumbnailImage">ThumbnailImage</a></h2>
392<div class="doc-section">
393
394<p>ThumbnailImage() changes the size of an image to the given dimensions and removes any associated profiles. The goal is to produce small low cost thumbnail images suited for display on the Web.</p></ol>
395
396<p>The format of the ThumbnailImage method is:</p>
397
398<pre class="code">
399 Image *ThumbnailImage(const Image *image,const unsigned long columns,
400 const unsigned long rows,ExceptionInfo *exception)
401</pre>
402
403<p>A description of each parameter follows:</p></ol>
404
405<h5>image</h5>
406<ol><p>the image.</p></ol>
407
408<h5>columns</h5>
409<ol><p>the number of columns in the scaled image.</p></ol>
410
411<h5>rows</h5>
412<ol><p>the number of rows in the scaled image.</p></ol>
413
414<h5>exception</h5>
415<ol><p>return any errors or warnings in this structure.</p></ol>
416
417 </div>
418<h2><a href="http://www.imagemagick.org/api/MagickCore/resize
419_8c.html" target="source" name="ZoomImage">ZoomImage</a></h2>
420<div class="doc-section">
421
422<p>ZoomImage() creates a new image that is a scaled size of an existing one. It allocates the memory necessary for the new Image structure and returns a pointer to the new image. The Point filter gives fast pixel replication, Triangle is equivalent to bi-linear interpolation, and Mitchel giver slower, very high-quality results. See Graphic Gems III for details on this algorithm.</p></ol>
423
424<p>The filter member of the Image structure specifies which image filter to use. Blur specifies the blur factor where > 1 is blurry, < 1 is sharp.</p></ol>
425
426<p>The format of the ZoomImage method is:</p>
427
428<pre class="code">
429 Image *ZoomImage(const Image *image,const unsigned long columns,
430 const unsigned long rows,ExceptionInfo *exception)
431</pre>
432
433<p>A description of each parameter follows:</p></ol>
434
435<h5>image</h5>
436<ol><p>the image.</p></ol>
437
438<h5>columns</h5>
439<ol><p>An integer that specifies the number of columns in the zoom image.</p></ol>
440
441<h5>rows</h5>
442<ol><p>An integer that specifies the number of rows in the scaled image.</p></ol>
443
444<h5>exception</h5>
445<ol><p>return any errors or warnings in this structure.</p></ol>
446
447 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]448
449</div>
450
451<div id="linkbar">
452 <!-- <span id="linkbar-west">&nbsp;</span> -->
453 <span id="linkbar-center">
454 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristy0391e8d2010-04-10 01:36:10 +0000[diff] [blame]455 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]456 </span>
457 <span id="linkbar-east">&nbsp;</span>
458 </div>
459 <div class="footer">
460 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
461 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
462 </div>
463 <div style="clear: both; margin: 0; width: 100%; "></div>
464</body>
465</html>