]> granicus.if.org Git - imagemagick/blob - www/api/image.html
(no commit message)
[imagemagick] / www / api / image.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" 
2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html version="-//W3C//DTD XHTML 1.1//EN"
4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6       xsi:schemaLocation="http://www.w3.org/1999/xhtml
7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
8 <head>
9   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
10   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
11   <title>ImageMagick: MagickCore, C API for ImageMagick: Image Methods</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 automagically."/>
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:, image, methods, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
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-2013 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="canonical" href="http://www.imagemagick.org" />
31   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
32   <!-- Add jQuery library -->
33   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
34   
35   <!-- Optionaly include easing and/or mousewheel plugins -->
36   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
38   
39   <!-- Add fancyBox -->
40   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
42   
43   <!-- Optionaly include button and/or thumbnail helpers -->
44   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
45   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
46   
47   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
48   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
49   <script type="text/javascript">
50         $(document).ready(function() {
51                 $(".fancybox").fancybox();
52         });
53   </script>
54   <!-- ImageMagick style -->
55   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
56   <style type="text/css" media="all">
57     @import url("../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick.css");
58   </style>
59 </head>
60
61 <body id="www-imagemagick-org">
62 <div class="titlebar">
63 <div style="margin: 17px auto; float: left;">
64   <script type="text/javascript">
65   <!--
66     google_ad_client = "pub-3129977114552745";
67     google_ad_slot = "5439289906";
68     google_ad_width = 728;
69     google_ad_height = 90;
70   //-->
71   </script>
72   <script type="text/javascript"
73     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
74   </script>
75 </div>
76 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">
77   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/logo.jpg"
78   alt="ImageMagick Logo"
79   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
80 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">
81   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/sprite.jpg"
82   alt="ImageMagick Sprite"
83   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
84 </div>
85
86 <div class="westbar">
87
88 <div class="menu">
89   <a title="About ImageMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">About ImageMagick</a>
90 </div>
91 <div class="menu">
92   <a title="Binary Releases" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html">Binary Releases</a>
93 </div>
94 <div class="sub">
95     <a title="Binary Release: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#unix">Unix</a>
96 </div>
97 <div class="sub">
98     <a title="Binary Release: MacOS X" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#macosx">Mac OS X</a>
99 </div>
100 <div class="sub">
101     <a title="Binary Release: iOS" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#iOS">iOS</a>
102 </div>
103 <div class="sub">
104     <a title="Binary Release: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#windows">Windows</a>
105 </div>
106 <div class="sep"></div>
107 <div class="menu">
108   <a title="Command-line Tools" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-tools.html">Command-line Tools</a>
109 </div>
110 <div class="sub">
111     <a title="Command-line Tools: Processing" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-processing.html">Processing</a>
112 </div>
113 <div class="sub">
114     <a title="Command-line Tools: Options" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-options.html">Options</a>
115 </div>
116 <div class="sub">
117     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
118 </div>
119 <div class="menu">
120   <a title="Program Interfaces" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/api.html">Program Interfaces</a>
121 </div>
122 <div class="sub">
123     <a title="Program Interface: MagickWand" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-wand.html">MagickWand</a>
124 </div>
125 <div class="sub">
126     <a title="Program Interface: MagickCore" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-core.html">MagickCore</a>
127 </div>
128 <div class="sub">
129     <a title="Program Interface: PerlMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/perl-magick.html">PerlMagick</a>
130 </div>
131 <div class="sub">
132     <a title="Program Interface: Magick++" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick++.html">Magick++</a>
133 </div>
134 <div class="sep"></div>
135 <div  class="menu">
136    <a title="Install from Source" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html">Install from Source</a>
137 </div>
138 <div class="sub">
139     <a title="Install from Source: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#unix">Unix</a>
140 </div>
141 <div class="sub">
142     <a title="Install from Source: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#windows">Windows</a>
143  </div>
144 <div class="menu">
145   <a title="Resources" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/resources.html">Resources</a>
146 </div>
147 <div class="menu">
148   <a title="Architecture" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/architecture.html">Architecture</a>
149 </div>
150 <div class="menu">
151   <a title="Download" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/download.html">Download</a>
152 </div>
153 <div class="sep"></div>
154 <div class="menu">
155   <a title="Search" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/search.html">Search</a>
156 </div>
157 <div class="sep"></div>
158 <div class="menu">
159   <a title="Site Map" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sitemap.html">Site Map</a>
160 </div>
161 <div  class="sub">
162   <a title="Site Map: Links" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/links.html">Links</a>
163 </div>
164 <div class="sep"></div>
165 <div class="menu">
166   <a rel="follow" title="Sponsors" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sponsors.html">Sponsors:</a>
167
168   <a href="http://www.networkredux.com"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
169   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
170 <div class="sponsbox">
171 <div class="sponsor">
172   <a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
173 </div>
174 <div class="sponsor">
175   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
176 </div>
177 <div class="sponsor">
178   <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
179 </div>
180 <div class="sponsor">
181   <a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
182 </div>
183 <div class="sponsor">
184   <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
185 </div>
186 <div class="sponsor">
187   <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
188 </div>
189 <div class="sponsor">
190   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
191 </div>
192 <div class="sponsor">
193   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
194 </div>
195 <div class="sponsor">
196    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
197 </div>
198 <div class="sponsor">
199    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
200 </div>
201 <div class="sponsor">
202   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
203 </div>
204 <div class="sponsor">
205   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
206 </div>
207 <div class="sponsor">
208    <a rel="follow" title="Sponsor: Got Stripes" href="http://www.stripeslawncare.org">Got Stripes?</a><!-- 2012090100150 brooks@stripes...-->
209 </div>
210 <div class="sponsor">
211    <a rel="follow" title="Sponsor: Waschmaschinen Reparatur Berlin" href="http://www.waschmaschinen-reparaturen-berlin.de">Waschmaschinen Reparatur Berlin</a><!-- 2012070100030 Temurbas@autoteile-->
212 </div>
213 </div>
214 </div>
215 </div>
216
217 <div class="eastbar">
218   <div class="g-plusone" id="gplusone"></div>
219   <script type="text/javascript">
220     window.___gcfg = {
221       lang: 'en-US'
222     };
223
224     (function() {
225       var po = document.createElement('script');
226       po.type = 'text/javascript'; po.async = true;
227       po.src = 'https://apis.google.com/js/plusone.js';
228       var script = document.getElementsByTagName('script')[0];
229       script.parentNode.insertBefore(po, script);
230     })();
231     var gplusone = document.getElementById("gplusone");
232     gplusone.setAttribute("data-size","medium");
233     gplusone.setAttribute("data-count","false");
234   </script>
235 </div>
236
237 <div class="main">
238
239 <h1>Module image Methods</h1>
240 <p class="navigation-index">[<a href="image.html#AcquireImage">AcquireImage</a> &bull; <a href="image.html#AcquireImageInfo">AcquireImageInfo</a> &bull; <a href="image.html#AcquireNextImage">AcquireNextImage</a> &bull; <a href="image.html#AppendImages">AppendImages</a> &bull; <a href="image.html#CatchImageException">CatchImageException</a> &bull; <a href="image.html#ClipImagePath">ClipImagePath</a> &bull; <a href="image.html#CloneImage">CloneImage</a> &bull; <a href="image.html#CloneImageInfo">CloneImageInfo</a> &bull; <a href="image.html#CombineImages">CombineImages</a> &bull; <a href="image.html#DestroyImage">DestroyImage</a> &bull; <a href="image.html#DestroyImageInfo">DestroyImageInfo</a> &bull; <a href="image.html#GetImageAlphaChannel">GetImageAlphaChannel</a> &bull; <a href="image.html#GetImageClipMask">GetImageClipMask</a> &bull; <a href="image.html#GetImageException">GetImageException</a> &bull; <a href="image.html#GetImageInfo">GetImageInfo</a> &bull; <a href="image.html#GetImageInfoFile">GetImageInfoFile</a> &bull; <a href="image.html#GetImageMask">GetImageMask</a> &bull; <a href="image.html#GetImageChannels">GetImageChannels</a> &bull; <a href="image.html#GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a> &bull; <a href="image.html#InterpretImageFilename">InterpretImageFilename</a> &bull; <a href="image.html#IsHighDynamicRangeImage">IsHighDynamicRangeImage</a> &bull; <a href="image.html#IsImageObject">IsImageObject</a> &bull; <a href="image.html#IsTaintImage">IsTaintImage</a> &bull; <a href="image.html#ModifyImage">ModifyImage</a> &bull; <a href="image.html#NewMagickImage">NewMagickImage</a> &bull; <a href="image.html#ReferenceImage">ReferenceImage</a> &bull; <a href="image.html#ResetImagePage">ResetImagePage</a> &bull; <a href="image.html#SeparateImageChannel">SeparateImageChannel</a> &bull; <a href="image.html#SeparateImages">SeparateImages</a> &bull; <a href="image.html#SetImageAlphaChannel">SetImageAlphaChannel</a> &bull; <a href="image.html#SetImageBackgroundColor">SetImageBackgroundColor</a> &bull; <a href="image.html#SetImageChannels">SetImageChannels</a> &bull; <a href="image.html#SetImageColor">SetImageColor</a> &bull; <a href="image.html#SetImageStorageClass">SetImageStorageClass</a> &bull; <a href="image.html#SetImageClipMask">SetImageClipMask</a> &bull; <a href="image.html#SetImageExtent">SetImageExtent</a> &bull; <a href="image.html#SetImageInfoBlob">SetImageInfoBlob</a> &bull; <a href="image.html#SetImageInfoFile">SetImageInfoFile</a> &bull; <a href="image.html#SetImageMask">SetImageMask</a> &bull; <a href="image.html#SetImageOpacity">SetImageOpacity</a> &bull; <a href="image.html#SetImageType">SetImageType</a> &bull; <a href="image.html#SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a> &bull; <a href="image.html#SmushImages">SmushImages</a> &bull; <a href="image.html#StripImage">StripImage</a> &bull; <a href="image.html#SyncImageSettings">SyncImageSettings</a>]</p>
241
242 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AcquireImage">AcquireImage</a></h2>
243 <div class="doc-section">
244
245 <p>AcquireImage() returns a pointer to an image structure initialized to default values.</p>
246
247 <p>The format of the AcquireImage method is:</p>
248
249 <pre class="code">
250   Image *AcquireImage(const ImageInfo *image_info)
251 </pre>
252
253 <p>A description of each parameter follows:</p>
254
255 <h5>image_info</h5>
256 <p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p>
257
258  </div>
259 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AcquireImageInfo">AcquireImageInfo</a></h2>
260 <div class="doc-section">
261
262 <p>AcquireImageInfo() allocates the ImageInfo structure.</p>
263
264 <p>The format of the AcquireImageInfo method is:</p>
265
266 <pre class="code">
267   ImageInfo *AcquireImageInfo(void)
268 </pre>
269
270  </div>
271 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AcquireNextImage">AcquireNextImage</a></h2>
272 <div class="doc-section">
273
274 <p>AcquireNextImage() initializes the next image in a sequence to default values.  The next member of image points to the newly allocated image.  If there is a memory shortage, next is assigned NULL.</p>
275
276 <p>The format of the AcquireNextImage method is:</p>
277
278 <pre class="code">
279   void AcquireNextImage(const ImageInfo *image_info,Image *image)
280 </pre>
281
282 <p>A description of each parameter follows:</p>
283
284 <h5>image_info</h5>
285 <p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p>
286
287 <h5>image</h5>
288 <p>the image.</p>
289
290  </div>
291 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AppendImages">AppendImages</a></h2>
292 <div class="doc-section">
293
294 <p>AppendImages() takes all images from the current image pointer to the end of the image list and appends them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.</p>
295
296 <p>The current gravity setting now effects how the image is justified in the final image.</p>
297
298 <p>The format of the AppendImages method is:</p>
299
300 <pre class="code">
301   Image *AppendImages(const Image *images,const MagickBooleanType stack,
302     ExceptionInfo *exception)
303 </pre>
304
305 <p>A description of each parameter follows:</p>
306
307 <h5>images</h5>
308 <p>the image sequence.</p>
309
310 <h5>stack</h5>
311 <p>A value other than 0 stacks the images top-to-bottom.</p>
312
313 <h5>exception</h5>
314 <p>return any errors or warnings in this structure.</p>
315
316  </div>
317 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CatchImageException">CatchImageException</a></h2>
318 <div class="doc-section">
319
320 <p>CatchImageException() returns if no exceptions are found in the image sequence, otherwise it determines the most severe exception and reports it as a warning or error depending on the severity.</p>
321
322 <p>The format of the CatchImageException method is:</p>
323
324 <pre class="code">
325   ExceptionType CatchImageException(Image *image)
326 </pre>
327
328 <p>A description of each parameter follows:</p>
329
330 <h5>image</h5>
331 <p>An image sequence.</p>
332
333  </div>
334 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ClipImagePath">ClipImagePath</a></h2>
335 <div class="doc-section">
336
337 <p>ClipImagePath() sets the image clip mask based any clipping path information if it exists.</p>
338
339 <p>The format of the ClipImagePath method is:</p>
340
341 <pre class="code">
342   MagickBooleanType ClipImagePath(Image *image,const char *pathname,
343     const MagickBooleanType inside)
344 </pre>
345
346 <p>A description of each parameter follows:</p>
347
348 <h5>image</h5>
349 <p>the image.</p>
350
351 <h5>pathname</h5>
352 <p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p>
353
354 <h5>inside</h5>
355 <p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p>
356
357  </div>
358 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CloneImage">CloneImage</a></h2>
359 <div class="doc-section">
360
361 <p>CloneImage() copies an image and returns the copy as a new image object.</p>
362
363 <p>If the specified columns and rows is 0, an exact copy of the image is returned, otherwise the pixel data is undefined and must be initialized with the QueueAuthenticPixels() and SyncAuthenticPixels() methods.  On failure, a NULL image is returned and exception describes the reason for the failure.</p>
364
365 <p>The format of the CloneImage method is:</p>
366
367 <pre class="code">
368   Image *CloneImage(const Image *image,const size_t columns,
369     const size_t rows,const MagickBooleanType orphan,
370     ExceptionInfo *exception)
371 </pre>
372
373 <p>A description of each parameter follows:</p>
374
375 <h5>image</h5>
376 <p>the image.</p>
377
378 <h5>columns</h5>
379 <p>the number of columns in the cloned image.</p>
380
381 <h5>rows</h5>
382 <p>the number of rows in the cloned image.</p>
383
384 <h5>detach</h5>
385 <p>With a value other than 0, the cloned image is detached from its parent I/O stream.</p>
386
387 <h5>exception</h5>
388 <p>return any errors or warnings in this structure.</p>
389
390  </div>
391 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CloneImageInfo">CloneImageInfo</a></h2>
392 <div class="doc-section">
393
394 <p>CloneImageInfo() makes a copy of the given image info structure.  If NULL is specified, a new image info structure is created initialized to default values.</p>
395
396 <p>The format of the CloneImageInfo method is:</p>
397
398 <pre class="code">
399   ImageInfo *CloneImageInfo(const ImageInfo *image_info)
400 </pre>
401
402 <p>A description of each parameter follows:</p>
403
404 <h5>image_info</h5>
405 <p>the image info.</p>
406
407  </div>
408 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CombineImages">CombineImages</a></h2>
409 <div class="doc-section">
410
411 <p>CombineImages() combines one or more images into a single image.  The grayscale value of the pixels of each image in the sequence is assigned in order to the specified channels of the combined image.   The typical ordering would be image 1 => Red, 2 => Green, 3 => Blue, etc.</p>
412
413 <p>The format of the CombineImages method is:</p>
414
415 <pre class="code">
416   Image *CombineImages(const Image *image,const ChannelType channel,
417     ExceptionInfo *exception)
418 </pre>
419
420 <p>A description of each parameter follows:</p>
421
422 <h5>image</h5>
423 <p>the image.</p>
424
425 <h5>exception</h5>
426 <p>return any errors or warnings in this structure.</p>
427
428  </div>
429 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="DestroyImage">DestroyImage</a></h2>
430 <div class="doc-section">
431
432 <p>DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p>
433
434 <p>The format of the DestroyImage method is:</p>
435
436 <pre class="code">
437   Image *DestroyImage(Image *image)
438 </pre>
439
440 <p>A description of each parameter follows:</p>
441
442 <h5>image</h5>
443 <p>the image.</p>
444
445  </div>
446 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="DestroyImageInfo">DestroyImageInfo</a></h2>
447 <div class="doc-section">
448
449 <p>DestroyImageInfo() deallocates memory associated with an ImageInfo structure.</p>
450
451 <p>The format of the DestroyImageInfo method is:</p>
452
453 <pre class="code">
454   ImageInfo *DestroyImageInfo(ImageInfo *image_info)
455 </pre>
456
457 <p>A description of each parameter follows:</p>
458
459 <h5>image_info</h5>
460 <p>the image info.</p>
461
462  </div>
463 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageAlphaChannel">GetImageAlphaChannel</a></h2>
464 <div class="doc-section">
465
466 <p>GetImageAlphaChannel() returns MagickFalse if the image alpha channel is not activated.  That is, the image is RGB rather than RGBA or CMYK rather than CMYKA.</p>
467
468 <p>The format of the GetImageAlphaChannel method is:</p>
469
470 <pre class="code">
471   MagickBooleanType GetImageAlphaChannel(const Image *image)
472 </pre>
473
474 <p>A description of each parameter follows:</p>
475
476 <h5>image</h5>
477 <p>the image.</p>
478
479  </div>
480 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageClipMask">GetImageClipMask</a></h2>
481 <div class="doc-section">
482
483 <p>GetImageClipMask() returns the clip path associated with the image.</p>
484
485 <p>The format of the GetImageClipMask method is:</p>
486
487 <pre class="code">
488   Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
489 </pre>
490
491 <p>A description of each parameter follows:</p>
492
493 <h5>image</h5>
494 <p>the image.</p>
495
496  </div>
497 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageException">GetImageException</a></h2>
498 <div class="doc-section">
499
500 <p>GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.</p>
501
502 <p>The format of the GetImageException method is:</p>
503
504 <pre class="code">
505   void GetImageException(Image *image,ExceptionInfo *exception)
506 </pre>
507
508 <p>A description of each parameter follows:</p>
509
510 <h5>image</h5>
511 <p>Specifies a pointer to a list of one or more images.</p>
512
513 <h5>exception</h5>
514 <p>return the highest severity exception.</p>
515
516  </div>
517 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageInfo">GetImageInfo</a></h2>
518 <div class="doc-section">
519
520 <p>GetImageInfo() initializes image_info to default values.</p>
521
522 <p>The format of the GetImageInfo method is:</p>
523
524 <pre class="code">
525   void GetImageInfo(ImageInfo *image_info)
526 </pre>
527
528 <p>A description of each parameter follows:</p>
529
530 <h5>image_info</h5>
531 <p>the image info.</p>
532
533  </div>
534 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageInfoFile">GetImageInfoFile</a></h2>
535 <div class="doc-section">
536
537 <p>GetImageInfoFile() returns the image info file member.</p>
538
539 <p>The format of the GetImageInfoFile method is:</p>
540
541 <pre class="code">
542   FILE *GetImageInfoFile(const ImageInfo *image_info)
543 </pre>
544
545 <p>A description of each parameter follows:</p>
546
547 <h5>image_info</h5>
548 <p>the image info.</p>
549
550  </div>
551 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageMask">GetImageMask</a></h2>
552 <div class="doc-section">
553
554 <p>GetImageMask() returns the mask associated with the image.</p>
555
556 <p>The format of the GetImageMask method is:</p>
557
558 <pre class="code">
559   Image *GetImageMask(const Image *image,ExceptionInfo *exception)
560 </pre>
561
562 <p>A description of each parameter follows:</p>
563
564 <h5>image</h5>
565 <p>the image.</p>
566
567  </div>
568 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageChannels">GetImageChannels</a></h2>
569 <div class="doc-section">
570
571 <p>GetImageChannels() returns the number of pixel channels associated with the specified image.</p>
572
573 <p>The format of the GetChannels method is:</p>
574
575 <pre class="code">
576   size_t GetImageChannels(Image *image)
577 </pre>
578
579 <p>A description of each parameter follows:</p>
580
581 <h5>image</h5>
582 <p>the image.</p>
583
584  </div>
585 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a></h2>
586 <div class="doc-section">
587
588 <p>GetImageVirtualPixelMethod() gets the "virtual pixels" method for the image.  A virtual pixel is any pixel access that is outside the boundaries of the image cache.</p>
589
590 <p>The format of the GetImageVirtualPixelMethod() method is:</p>
591
592 <pre class="code">
593   VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
594 </pre>
595
596 <p>A description of each parameter follows:</p>
597
598 <h5>image</h5>
599 <p>the image.</p>
600
601  </div>
602 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="InterpretImageFilename">InterpretImageFilename</a></h2>
603 <div class="doc-section">
604
605 <p>InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.</p>
606
607 <p>The format of the InterpretImageFilename method is:</p>
608
609 <pre class="code">
610   size_t InterpretImageFilename(const ImageInfo *image_info,Image *image,
611     const char *format,int value,char *filename)
612 </pre>
613
614 <p>A description of each parameter follows.</p>
615
616 <h5>image_info</h5>
617 <p>the image info..</p>
618
619 <h5>image</h5>
620 <p>the image.</p>
621
622 <h5>format</h5>
623 <p>A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.</p>
624
625 <h5>value</h5>
626 <p>Numeric value to substitute into format filename.</p>
627
628 <h5>filename</h5>
629 <p>return the formatted filename in this character buffer.</p>
630
631  </div>
632 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="IsHighDynamicRangeImage">IsHighDynamicRangeImage</a></h2>
633 <div class="doc-section">
634
635 <p>IsHighDynamicRangeImage() returns MagickTrue if any pixel component is non-integer or exceeds the bounds of the quantum depth (e.g. for Q16 0..65535.</p>
636
637 <p>The format of the IsHighDynamicRangeImage method is:</p>
638
639 <pre class="code">
640   MagickBooleanType IsHighDynamicRangeImage(const Image *image,
641     ExceptionInfo *exception)
642 </pre>
643
644 <p>A description of each parameter follows:</p>
645
646 <h5>image</h5>
647 <p>the image.</p>
648
649 <h5>exception</h5>
650 <p>return any errors or warnings in this structure.</p>
651
652  </div>
653 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="IsImageObject">IsImageObject</a></h2>
654 <div class="doc-section">
655
656 <p>IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.</p>
657
658 <p>The format of the IsImageObject method is:</p>
659
660 <pre class="code">
661   MagickBooleanType IsImageObject(const Image *image)
662 </pre>
663
664 <p>A description of each parameter follows:</p>
665
666 <h5>image</h5>
667 <p>the image.</p>
668
669  </div>
670 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="IsTaintImage">IsTaintImage</a></h2>
671 <div class="doc-section">
672
673 <p>IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.</p>
674
675 <p>The format of the IsTaintImage method is:</p>
676
677 <pre class="code">
678   MagickBooleanType IsTaintImage(const Image *image)
679 </pre>
680
681 <p>A description of each parameter follows:</p>
682
683 <h5>image</h5>
684 <p>the image.</p>
685
686  </div>
687 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ModifyImage">ModifyImage</a></h2>
688 <div class="doc-section">
689
690 <p>ModifyImage() ensures that there is only a single reference to the image to be modified, updating the provided image pointer to point to a clone of the original image if necessary.</p>
691
692 <p>The format of the ModifyImage method is:</p>
693
694 <pre class="code">
695   MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
696 </pre>
697
698 <p>A description of each parameter follows:</p>
699
700 <h5>image</h5>
701 <p>the image.</p>
702
703 <h5>exception</h5>
704 <p>return any errors or warnings in this structure.</p>
705
706  </div>
707 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="NewMagickImage">NewMagickImage</a></h2>
708 <div class="doc-section">
709
710 <p>NewMagickImage() creates a blank image canvas of the specified size and background color.</p>
711
712 <p>The format of the NewMagickImage method is:</p>
713
714 <pre class="code">
715   Image *NewMagickImage(const ImageInfo *image_info,
716     const size_t width,const size_t height,
717     const MagickPixelPacket *background)
718 </pre>
719
720 <p>A description of each parameter follows:</p>
721
722 <h5>image</h5>
723 <p>the image.</p>
724
725 <h5>width</h5>
726 <p>the image width.</p>
727
728 <h5>height</h5>
729 <p>the image height.</p>
730
731 <h5>background</h5>
732 <p>the image color.</p>
733
734  </div>
735 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ReferenceImage">ReferenceImage</a></h2>
736 <div class="doc-section">
737
738 <p>ReferenceImage() increments the reference count associated with an image returning a pointer to the image.</p>
739
740 <p>The format of the ReferenceImage method is:</p>
741
742 <pre class="code">
743   Image *ReferenceImage(Image *image)
744 </pre>
745
746 <p>A description of each parameter follows:</p>
747
748 <h5>image</h5>
749 <p>the image.</p>
750
751  </div>
752 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ResetImagePage">ResetImagePage</a></h2>
753 <div class="doc-section">
754
755 <p>ResetImagePage() resets the image page canvas and position.</p>
756
757 <p>The format of the ResetImagePage method is:</p>
758
759 <pre class="code">
760   MagickBooleanType ResetImagePage(Image *image,const char *page)
761 </pre>
762
763 <p>A description of each parameter follows:</p>
764
765 <h5>image</h5>
766 <p>the image.</p>
767
768 <h5>page</h5>
769 <p>the relative page specification.</p>
770
771  </div>
772 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SeparateImageChannel">SeparateImageChannel</a></h2>
773 <div class="doc-section">
774
775 <p>SeparateImageChannel() separates a channel from the image and returns it as a grayscale image.  A channel is a particular color component of each pixel in the image.</p>
776
777 <p>The format of the SeparateImageChannel method is:</p>
778
779 <pre class="code">
780   MagickBooleanType SeparateImageChannel(Image *image,
781     const ChannelType channel)
782 </pre>
783
784 <p>A description of each parameter follows:</p>
785
786 <h5>image</h5>
787 <p>the image.</p>
788
789 <h5>channel</h5>
790 <p>Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p>
791
792  </div>
793 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SeparateImages">SeparateImages</a></h2>
794 <div class="doc-section">
795
796 <p>SeparateImages() returns a separate grayscale image for each channel specified.</p>
797
798 <p>The format of the SeparateImages method is:</p>
799
800 <pre class="code">
801   MagickBooleanType SeparateImages(const Image *image,
802     const ChannelType channel,ExceptionInfo *exception)
803 </pre>
804
805 <p>A description of each parameter follows:</p>
806
807 <h5>image</h5>
808 <p>the image.</p>
809
810 <h5>channel</h5>
811 <p>Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p>
812
813 <h5>exception</h5>
814 <p>return any errors or warnings in this structure.</p>
815
816  </div>
817 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageAlphaChannel">SetImageAlphaChannel</a></h2>
818 <div class="doc-section">
819
820 <p>SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p>
821
822 <p>The format of the SetImageAlphaChannel method is:</p>
823
824 <pre class="code">
825   MagickBooleanType SetImageAlphaChannel(Image *image,
826     const AlphaChannelType alpha_type)
827 </pre>
828
829 <p>A description of each parameter follows:</p>
830
831 <h5>image</h5>
832 <p>the image.</p>
833
834 <h5>alpha_type</h5>
835 <p>The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.</p>
836
837  </div>
838 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageBackgroundColor">SetImageBackgroundColor</a></h2>
839 <div class="doc-section">
840
841 <p>SetImageBackgroundColor() initializes the image pixels to the image background color.  The background color is defined by the background_color member of the image structure.</p>
842
843 <p>The format of the SetImage method is:</p>
844
845 <pre class="code">
846   MagickBooleanType SetImageBackgroundColor(Image *image)
847 </pre>
848
849 <p>A description of each parameter follows:</p>
850
851 <h5>image</h5>
852 <p>the image.</p>
853
854  </div>
855 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageChannels">SetImageChannels</a></h2>
856 <div class="doc-section">
857
858 <p>SetImageChannels() sets the number of pixels channels associated with the image.</p>
859
860 <p>The format of the SetImageChannels method is:</p>
861
862 <pre class="code">
863   MagickBooleanType SetImageChannels(Image *image,const size_t channels)
864 </pre>
865
866 <p>A description of each parameter follows:</p>
867
868 <h5>image</h5>
869 <p>the image.</p>
870
871 <h5>channels</h5>
872 <p>The number of pixel channels.</p>
873
874  </div>
875 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageColor">SetImageColor</a></h2>
876 <div class="doc-section">
877
878 <p>SetImageColor() set the entire image canvas to the specified color.</p>
879
880 <p>The format of the SetImageColor method is:</p>
881
882 <pre class="code">
883   MagickBooleanType SetImageColor(Image *image,
884     const MagickPixelPacket *color)
885 </pre>
886
887 <p>A description of each parameter follows:</p>
888
889 <h5>image</h5>
890 <p>the image.</p>
891
892 <h5>background</h5>
893 <p>the image color.</p>
894
895  </div>
896 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageStorageClass">SetImageStorageClass</a></h2>
897 <div class="doc-section">
898
899 <p>SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.</p>
900
901 <p>The format of the SetImageStorageClass method is:</p>
902
903 <pre class="code">
904   MagickBooleanType SetImageStorageClass(Image *image,
905     const ClassType storage_class)
906 </pre>
907
908 <p>A description of each parameter follows:</p>
909
910 <h5>image</h5>
911 <p>the image.</p>
912
913 <h5>storage_class</h5>
914 <p>The image class.</p>
915
916  </div>
917 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageClipMask">SetImageClipMask</a></h2>
918 <div class="doc-section">
919
920 <p>SetImageClipMask() associates a clip path with the image.  The clip path must be the same dimensions as the image.  Set any pixel component of the clip path to TransparentOpacity to prevent that corresponding image pixel component from being updated when SyncAuthenticPixels() is applied.</p>
921
922 <p>The format of the SetImageClipMask method is:</p>
923
924 <pre class="code">
925   MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
926 </pre>
927
928 <p>A description of each parameter follows:</p>
929
930 <h5>image</h5>
931 <p>the image.</p>
932
933 <h5>clip_mask</h5>
934 <p>the image clip path.</p>
935
936  </div>
937 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageExtent">SetImageExtent</a></h2>
938 <div class="doc-section">
939
940 <p>SetImageExtent() sets the image size (i.e. columns & rows).</p>
941
942 <p>The format of the SetImageExtent method is:</p>
943
944 <pre class="code">
945   MagickBooleanType SetImageExtent(Image *image,
946     const size_t columns,const size_t rows)
947 </pre>
948
949 <p>A description of each parameter follows:</p>
950
951 <h5>image</h5>
952 <p>the image.</p>
953
954 <h5>columns</h5>
955 <p>The image width in pixels.</p>
956
957 <h5>rows</h5>
958 <p>The image height in pixels.</p>
959
960  </div>
961 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageInfoBlob">SetImageInfoBlob</a></h2>
962 <div class="doc-section">
963
964 <p>SetImageInfoBlob() sets the image info blob member.</p>
965
966 <p>The format of the SetImageInfoBlob method is:</p>
967
968 <pre class="code">
969   void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
970     const size_t length)
971 </pre>
972
973 <p>A description of each parameter follows:</p>
974
975 <h5>image_info</h5>
976 <p>the image info.</p>
977
978 <h5>blob</h5>
979 <p>the blob.</p>
980
981 <h5>length</h5>
982 <p>the blob length.</p>
983
984  </div>
985 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageInfoFile">SetImageInfoFile</a></h2>
986 <div class="doc-section">
987
988 <p>SetImageInfoFile() sets the image info file member.</p>
989
990 <p>The format of the SetImageInfoFile method is:</p>
991
992 <pre class="code">
993   void SetImageInfoFile(ImageInfo *image_info,FILE *file)
994 </pre>
995
996 <p>A description of each parameter follows:</p>
997
998 <h5>image_info</h5>
999 <p>the image info.</p>
1000
1001 <h5>file</h5>
1002 <p>the file.</p>
1003
1004  </div>
1005 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageMask">SetImageMask</a></h2>
1006 <div class="doc-section">
1007
1008 <p>SetImageMask() associates a mask with the image.  The mask must be the same dimensions as the image.</p>
1009
1010 <p>The format of the SetImageMask method is:</p>
1011
1012 <pre class="code">
1013   MagickBooleanType SetImageMask(Image *image,const Image *mask)
1014 </pre>
1015
1016 <p>A description of each parameter follows:</p>
1017
1018 <h5>image</h5>
1019 <p>the image.</p>
1020
1021 <h5>mask</h5>
1022 <p>the image mask.</p>
1023
1024  </div>
1025 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageOpacity">SetImageOpacity</a></h2>
1026 <div class="doc-section">
1027
1028 <p>SetImageOpacity() sets the opacity levels of the image.</p>
1029
1030 <p>The format of the SetImageOpacity method is:</p>
1031
1032 <pre class="code">
1033   MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
1034 </pre>
1035
1036 <p>A description of each parameter follows:</p>
1037
1038 <h5>image</h5>
1039 <p>the image.</p>
1040
1041 <h5>opacity</h5>
1042 <p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p>
1043
1044  </div>
1045 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageType">SetImageType</a></h2>
1046 <div class="doc-section">
1047
1048 <p>SetImageType() sets the type of image.  Choose from these types:</p>
1049
1050 <p>BilevelType, GrayscaleType, GrayscaleMatteType, PaletteType, PaletteMatteType, TrueColorType, TrueColorMatteType, ColorSeparationType, ColorSeparationMatteType, OptimizeType</p>
1051
1052 <p>The format of the SetImageType method is:</p>
1053
1054 <pre class="code">
1055   MagickBooleanType SetImageType(Image *image,const ImageType type)
1056 </pre>
1057
1058 <p>A description of each parameter follows:</p>
1059
1060 <h5>image</h5>
1061 <p>the image.</p>
1062
1063 <h5>type</h5>
1064 <p>Image type.</p>
1065
1066  </div>
1067 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a></h2>
1068 <div class="doc-section">
1069
1070 <p>SetImageVirtualPixelMethod() sets the "virtual pixels" method for the image and returns the previous setting.  A virtual pixel is any pixel access that is outside the boundaries of the image cache.</p>
1071
1072 <p>The format of the SetImageVirtualPixelMethod() method is:</p>
1073
1074 <pre class="code">
1075   VirtualPixelMethod SetImageVirtualPixelMethod(const Image *image,
1076     const VirtualPixelMethod virtual_pixel_method)
1077 </pre>
1078
1079 <p>A description of each parameter follows:</p>
1080
1081 <h5>image</h5>
1082 <p>the image.</p>
1083
1084 <h5>virtual_pixel_method</h5>
1085 <p>choose the type of virtual pixel.</p>
1086
1087  </div>
1088 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SmushImages">SmushImages</a></h2>
1089 <div class="doc-section">
1090
1091 <p>SmushImages() takes all images from the current image pointer to the end of the image list and smushes them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.</p>
1092
1093 <p>The current gravity setting now effects how the image is justified in the final image.</p>
1094
1095 <p>The format of the SmushImages method is:</p>
1096
1097 <pre class="code">
1098   Image *SmushImages(const Image *images,const MagickBooleanType stack,
1099     ExceptionInfo *exception)
1100 </pre>
1101
1102 <p>A description of each parameter follows:</p>
1103
1104 <h5>images</h5>
1105 <p>the image sequence.</p>
1106
1107 <h5>stack</h5>
1108 <p>A value other than 0 stacks the images top-to-bottom.</p>
1109
1110 <h5>offset</h5>
1111 <p>minimum distance in pixels between images.</p>
1112
1113 <h5>exception</h5>
1114 <p>return any errors or warnings in this structure.</p>
1115
1116  </div>
1117 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="StripImage">StripImage</a></h2>
1118 <div class="doc-section">
1119
1120 <p>StripImage() strips an image of all profiles and comments.</p>
1121
1122 <p>The format of the StripImage method is:</p>
1123
1124 <pre class="code">
1125   MagickBooleanType StripImage(Image *image)
1126 </pre>
1127
1128 <p>A description of each parameter follows:</p>
1129
1130 <h5>image</h5>
1131 <p>the image.</p>
1132
1133  </div>
1134 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SyncImageSettings">SyncImageSettings</a></h2>
1135 <div class="doc-section">
1136
1137 <p>SyncImageSettings() syncs image_info options into per-image attributes.</p>
1138
1139 <p>The format of the SyncImageSettings method is:</p>
1140
1141 <pre class="code">
1142   MagickBooleanType SyncImageSettings(const ImageInfo *image_info,
1143     Image *image)
1144   MagickBooleanType SyncImagesSettings(const ImageInfo *image_info,
1145     Image *image)
1146 </pre>
1147
1148 <p>A description of each parameter follows:</p>
1149
1150 <h5>image_info</h5>
1151 <p>the image info.</p>
1152
1153 <h5>image</h5>
1154 <p>the image.</p>
1155
1156  </div>
1157
1158 </div>
1159
1160 <div id="linkbar">
1161     <span id="linkbar-west">&nbsp;</span>
1162     <span id="linkbar-center">
1163       <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">Discourse Server</a> &bull;
1164       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
1165     </span>
1166     <span id="linkbar-east">&nbsp;</span>
1167   </div>
1168   <div class="footer">
1169     <span id="footer-west">&copy; 1999-2013 ImageMagick Studio LLC</span>
1170     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
1171   </div>
1172   <div style="clear: both; margin: 0; width: 100%; "></div>
1173   <script type="text/javascript">
1174     var _gaq = _gaq || [];
1175     _gaq.push(['_setAccount', 'UA-17690367-1']);
1176     _gaq.push(['_trackPageview']);
1177
1178     (function() {
1179       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
1180       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
1181       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
1182     })();
1183   </script>
1184 </body>
1185 </html>