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">
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>
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>
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>
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>
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();
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");
61 <body id="www-imagemagick-org">
62 <div class="titlebar">
63 <div style="margin: 17px auto; float: left;">
64 <script type="text/javascript">
66 google_ad_client = "pub-3129977114552745";
67 google_ad_slot = "5439289906";
68 google_ad_width = 728;
69 google_ad_height = 90;
72 <script type="text/javascript"
73 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
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>
89 <a title="About ImageMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">About ImageMagick</a>
92 <a title="Binary Releases" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html">Binary Releases</a>
95 <a title="Binary Release: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#unix">Unix</a>
98 <a title="Binary Release: MacOS X" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#macosx">Mac OS X</a>
101 <a title="Binary Release: iOS" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#iOS">iOS</a>
104 <a title="Binary Release: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#windows">Windows</a>
106 <div class="sep"></div>
108 <a title="Command-line Tools" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-tools.html">Command-line Tools</a>
111 <a title="Command-line Tools: Processing" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-processing.html">Processing</a>
114 <a title="Command-line Tools: Options" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-options.html">Options</a>
117 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
120 <a title="Program Interfaces" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/api.html">Program Interfaces</a>
123 <a title="Program Interface: MagickWand" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-wand.html">MagickWand</a>
126 <a title="Program Interface: MagickCore" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-core.html">MagickCore</a>
129 <a title="Program Interface: PerlMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/perl-magick.html">PerlMagick</a>
132 <a title="Program Interface: Magick++" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick++.html">Magick++</a>
134 <div class="sep"></div>
136 <a title="Install from Source" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html">Install from Source</a>
139 <a title="Install from Source: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#unix">Unix</a>
142 <a title="Install from Source: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#windows">Windows</a>
145 <a title="Resources" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/resources.html">Resources</a>
148 <a title="Architecture" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/architecture.html">Architecture</a>
151 <a title="Download" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/download.html">Download</a>
153 <div class="sep"></div>
155 <a title="Search" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/search.html">Search</a>
157 <div class="sep"></div>
159 <a title="Site Map" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sitemap.html">Site Map</a>
162 <a title="Site Map: Links" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/links.html">Links</a>
164 <div class="sep"></div>
166 <a rel="follow" title="Sponsors" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sponsors.html">Sponsors:</a>
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 & Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest & Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
174 <div class="sponsor">
175 <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
177 <div class="sponsor">
178 <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
180 <div class="sponsor">
181 <a rel="follow" title="Entertainment News & Photos" href="http://www.zimbio.com">Entertainment News & Photos</a><!-- 201211010540 bd@zimb... -->
183 <div class="sponsor">
184 <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
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-->
189 <div class="sponsor">
190 <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
192 <div class="sponsor">
193 <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
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 ... -->
198 <div class="sponsor">
199 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
201 <div class="sponsor">
202 <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
204 <div class="sponsor">
205 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
207 <div class="sponsor">
208 <a rel="follow" title="Sponsor: Got Stripes" href="http://www.stripeslawncare.org">Got Stripes?</a><!-- 2012090100150 brooks@stripes...-->
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-->
217 <div class="eastbar">
218 <div class="g-plusone" id="gplusone"></div>
219 <script type="text/javascript">
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);
231 var gplusone = document.getElementById("gplusone");
232 gplusone.setAttribute("data-size","medium");
233 gplusone.setAttribute("data-count","false");
239 <h1>Module image Methods</h1>
240 <p class="navigation-index">[<a href="image.html#AcquireImage">AcquireImage</a> • <a href="image.html#AcquireImageInfo">AcquireImageInfo</a> • <a href="image.html#AcquireNextImage">AcquireNextImage</a> • <a href="image.html#AppendImages">AppendImages</a> • <a href="image.html#CatchImageException">CatchImageException</a> • <a href="image.html#ClipImagePath">ClipImagePath</a> • <a href="image.html#CloneImage">CloneImage</a> • <a href="image.html#CloneImageInfo">CloneImageInfo</a> • <a href="image.html#CombineImages">CombineImages</a> • <a href="image.html#DestroyImage">DestroyImage</a> • <a href="image.html#DestroyImageInfo">DestroyImageInfo</a> • <a href="image.html#GetImageAlphaChannel">GetImageAlphaChannel</a> • <a href="image.html#GetImageClipMask">GetImageClipMask</a> • <a href="image.html#GetImageException">GetImageException</a> • <a href="image.html#GetImageInfo">GetImageInfo</a> • <a href="image.html#GetImageInfoFile">GetImageInfoFile</a> • <a href="image.html#GetImageMask">GetImageMask</a> • <a href="image.html#GetImageChannels">GetImageChannels</a> • <a href="image.html#GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a> • <a href="image.html#InterpretImageFilename">InterpretImageFilename</a> • <a href="image.html#IsHighDynamicRangeImage">IsHighDynamicRangeImage</a> • <a href="image.html#IsImageObject">IsImageObject</a> • <a href="image.html#IsTaintImage">IsTaintImage</a> • <a href="image.html#ModifyImage">ModifyImage</a> • <a href="image.html#NewMagickImage">NewMagickImage</a> • <a href="image.html#ReferenceImage">ReferenceImage</a> • <a href="image.html#ResetImagePage">ResetImagePage</a> • <a href="image.html#SeparateImageChannel">SeparateImageChannel</a> • <a href="image.html#SeparateImages">SeparateImages</a> • <a href="image.html#SetImageAlphaChannel">SetImageAlphaChannel</a> • <a href="image.html#SetImageBackgroundColor">SetImageBackgroundColor</a> • <a href="image.html#SetImageChannels">SetImageChannels</a> • <a href="image.html#SetImageColor">SetImageColor</a> • <a href="image.html#SetImageStorageClass">SetImageStorageClass</a> • <a href="image.html#SetImageClipMask">SetImageClipMask</a> • <a href="image.html#SetImageExtent">SetImageExtent</a> • <a href="image.html#SetImageInfoBlob">SetImageInfoBlob</a> • <a href="image.html#SetImageInfoFile">SetImageInfoFile</a> • <a href="image.html#SetImageMask">SetImageMask</a> • <a href="image.html#SetImageOpacity">SetImageOpacity</a> • <a href="image.html#SetImageType">SetImageType</a> • <a href="image.html#SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a> • <a href="image.html#SmushImages">SmushImages</a> • <a href="image.html#StripImage">StripImage</a> • <a href="image.html#SyncImageSettings">SyncImageSettings</a>]</p>
242 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AcquireImage">AcquireImage</a></h2>
243 <div class="doc-section">
245 <p>AcquireImage() returns a pointer to an image structure initialized to default values.</p>
247 <p>The format of the AcquireImage method is:</p>
250 Image *AcquireImage(const ImageInfo *image_info)
253 <p>A description of each parameter follows:</p>
256 <p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p>
259 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AcquireImageInfo">AcquireImageInfo</a></h2>
260 <div class="doc-section">
262 <p>AcquireImageInfo() allocates the ImageInfo structure.</p>
264 <p>The format of the AcquireImageInfo method is:</p>
267 ImageInfo *AcquireImageInfo(void)
271 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AcquireNextImage">AcquireNextImage</a></h2>
272 <div class="doc-section">
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>
276 <p>The format of the AcquireNextImage method is:</p>
279 void AcquireNextImage(const ImageInfo *image_info,Image *image)
282 <p>A description of each parameter follows:</p>
285 <p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p>
291 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AppendImages">AppendImages</a></h2>
292 <div class="doc-section">
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>
296 <p>The current gravity setting now effects how the image is justified in the final image.</p>
298 <p>The format of the AppendImages method is:</p>
301 Image *AppendImages(const Image *images,const MagickBooleanType stack,
302 ExceptionInfo *exception)
305 <p>A description of each parameter follows:</p>
308 <p>the image sequence.</p>
311 <p>A value other than 0 stacks the images top-to-bottom.</p>
314 <p>return any errors or warnings in this structure.</p>
317 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CatchImageException">CatchImageException</a></h2>
318 <div class="doc-section">
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>
322 <p>The format of the CatchImageException method is:</p>
325 ExceptionType CatchImageException(Image *image)
328 <p>A description of each parameter follows:</p>
331 <p>An image sequence.</p>
334 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ClipImagePath">ClipImagePath</a></h2>
335 <div class="doc-section">
337 <p>ClipImagePath() sets the image clip mask based any clipping path information if it exists.</p>
339 <p>The format of the ClipImagePath method is:</p>
342 MagickBooleanType ClipImagePath(Image *image,const char *pathname,
343 const MagickBooleanType inside)
346 <p>A description of each parameter follows:</p>
352 <p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p>
355 <p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p>
358 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CloneImage">CloneImage</a></h2>
359 <div class="doc-section">
361 <p>CloneImage() copies an image and returns the copy as a new image object.</p>
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>
365 <p>The format of the CloneImage method is:</p>
368 Image *CloneImage(const Image *image,const size_t columns,
369 const size_t rows,const MagickBooleanType orphan,
370 ExceptionInfo *exception)
373 <p>A description of each parameter follows:</p>
379 <p>the number of columns in the cloned image.</p>
382 <p>the number of rows in the cloned image.</p>
385 <p>With a value other than 0, the cloned image is detached from its parent I/O stream.</p>
388 <p>return any errors or warnings in this structure.</p>
391 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CloneImageInfo">CloneImageInfo</a></h2>
392 <div class="doc-section">
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>
396 <p>The format of the CloneImageInfo method is:</p>
399 ImageInfo *CloneImageInfo(const ImageInfo *image_info)
402 <p>A description of each parameter follows:</p>
405 <p>the image info.</p>
408 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CombineImages">CombineImages</a></h2>
409 <div class="doc-section">
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>
413 <p>The format of the CombineImages method is:</p>
416 Image *CombineImages(const Image *image,const ChannelType channel,
417 ExceptionInfo *exception)
420 <p>A description of each parameter follows:</p>
426 <p>return any errors or warnings in this structure.</p>
429 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="DestroyImage">DestroyImage</a></h2>
430 <div class="doc-section">
432 <p>DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p>
434 <p>The format of the DestroyImage method is:</p>
437 Image *DestroyImage(Image *image)
440 <p>A description of each parameter follows:</p>
446 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="DestroyImageInfo">DestroyImageInfo</a></h2>
447 <div class="doc-section">
449 <p>DestroyImageInfo() deallocates memory associated with an ImageInfo structure.</p>
451 <p>The format of the DestroyImageInfo method is:</p>
454 ImageInfo *DestroyImageInfo(ImageInfo *image_info)
457 <p>A description of each parameter follows:</p>
460 <p>the image info.</p>
463 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageAlphaChannel">GetImageAlphaChannel</a></h2>
464 <div class="doc-section">
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>
468 <p>The format of the GetImageAlphaChannel method is:</p>
471 MagickBooleanType GetImageAlphaChannel(const Image *image)
474 <p>A description of each parameter follows:</p>
480 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageClipMask">GetImageClipMask</a></h2>
481 <div class="doc-section">
483 <p>GetImageClipMask() returns the clip path associated with the image.</p>
485 <p>The format of the GetImageClipMask method is:</p>
488 Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
491 <p>A description of each parameter follows:</p>
497 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageException">GetImageException</a></h2>
498 <div class="doc-section">
500 <p>GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.</p>
502 <p>The format of the GetImageException method is:</p>
505 void GetImageException(Image *image,ExceptionInfo *exception)
508 <p>A description of each parameter follows:</p>
511 <p>Specifies a pointer to a list of one or more images.</p>
514 <p>return the highest severity exception.</p>
517 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageInfo">GetImageInfo</a></h2>
518 <div class="doc-section">
520 <p>GetImageInfo() initializes image_info to default values.</p>
522 <p>The format of the GetImageInfo method is:</p>
525 void GetImageInfo(ImageInfo *image_info)
528 <p>A description of each parameter follows:</p>
531 <p>the image info.</p>
534 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageInfoFile">GetImageInfoFile</a></h2>
535 <div class="doc-section">
537 <p>GetImageInfoFile() returns the image info file member.</p>
539 <p>The format of the GetImageInfoFile method is:</p>
542 FILE *GetImageInfoFile(const ImageInfo *image_info)
545 <p>A description of each parameter follows:</p>
548 <p>the image info.</p>
551 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageMask">GetImageMask</a></h2>
552 <div class="doc-section">
554 <p>GetImageMask() returns the mask associated with the image.</p>
556 <p>The format of the GetImageMask method is:</p>
559 Image *GetImageMask(const Image *image,ExceptionInfo *exception)
562 <p>A description of each parameter follows:</p>
568 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageChannels">GetImageChannels</a></h2>
569 <div class="doc-section">
571 <p>GetImageChannels() returns the number of pixel channels associated with the specified image.</p>
573 <p>The format of the GetChannels method is:</p>
576 size_t GetImageChannels(Image *image)
579 <p>A description of each parameter follows:</p>
585 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a></h2>
586 <div class="doc-section">
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>
590 <p>The format of the GetImageVirtualPixelMethod() method is:</p>
593 VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
596 <p>A description of each parameter follows:</p>
602 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="InterpretImageFilename">InterpretImageFilename</a></h2>
603 <div class="doc-section">
605 <p>InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.</p>
607 <p>The format of the InterpretImageFilename method is:</p>
610 size_t InterpretImageFilename(const ImageInfo *image_info,Image *image,
611 const char *format,int value,char *filename)
614 <p>A description of each parameter follows.</p>
617 <p>the image info..</p>
623 <p>A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.</p>
626 <p>Numeric value to substitute into format filename.</p>
629 <p>return the formatted filename in this character buffer.</p>
632 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="IsHighDynamicRangeImage">IsHighDynamicRangeImage</a></h2>
633 <div class="doc-section">
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>
637 <p>The format of the IsHighDynamicRangeImage method is:</p>
640 MagickBooleanType IsHighDynamicRangeImage(const Image *image,
641 ExceptionInfo *exception)
644 <p>A description of each parameter follows:</p>
650 <p>return any errors or warnings in this structure.</p>
653 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="IsImageObject">IsImageObject</a></h2>
654 <div class="doc-section">
656 <p>IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.</p>
658 <p>The format of the IsImageObject method is:</p>
661 MagickBooleanType IsImageObject(const Image *image)
664 <p>A description of each parameter follows:</p>
670 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="IsTaintImage">IsTaintImage</a></h2>
671 <div class="doc-section">
673 <p>IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.</p>
675 <p>The format of the IsTaintImage method is:</p>
678 MagickBooleanType IsTaintImage(const Image *image)
681 <p>A description of each parameter follows:</p>
687 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ModifyImage">ModifyImage</a></h2>
688 <div class="doc-section">
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>
692 <p>The format of the ModifyImage method is:</p>
695 MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
698 <p>A description of each parameter follows:</p>
704 <p>return any errors or warnings in this structure.</p>
707 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="NewMagickImage">NewMagickImage</a></h2>
708 <div class="doc-section">
710 <p>NewMagickImage() creates a blank image canvas of the specified size and background color.</p>
712 <p>The format of the NewMagickImage method is:</p>
715 Image *NewMagickImage(const ImageInfo *image_info,
716 const size_t width,const size_t height,
717 const MagickPixelPacket *background)
720 <p>A description of each parameter follows:</p>
726 <p>the image width.</p>
729 <p>the image height.</p>
732 <p>the image color.</p>
735 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ReferenceImage">ReferenceImage</a></h2>
736 <div class="doc-section">
738 <p>ReferenceImage() increments the reference count associated with an image returning a pointer to the image.</p>
740 <p>The format of the ReferenceImage method is:</p>
743 Image *ReferenceImage(Image *image)
746 <p>A description of each parameter follows:</p>
752 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ResetImagePage">ResetImagePage</a></h2>
753 <div class="doc-section">
755 <p>ResetImagePage() resets the image page canvas and position.</p>
757 <p>The format of the ResetImagePage method is:</p>
760 MagickBooleanType ResetImagePage(Image *image,const char *page)
763 <p>A description of each parameter follows:</p>
769 <p>the relative page specification.</p>
772 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SeparateImageChannel">SeparateImageChannel</a></h2>
773 <div class="doc-section">
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>
777 <p>The format of the SeparateImageChannel method is:</p>
780 MagickBooleanType SeparateImageChannel(Image *image,
781 const ChannelType channel)
784 <p>A description of each parameter follows:</p>
790 <p>Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p>
793 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SeparateImages">SeparateImages</a></h2>
794 <div class="doc-section">
796 <p>SeparateImages() returns a separate grayscale image for each channel specified.</p>
798 <p>The format of the SeparateImages method is:</p>
801 MagickBooleanType SeparateImages(const Image *image,
802 const ChannelType channel,ExceptionInfo *exception)
805 <p>A description of each parameter follows:</p>
811 <p>Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p>
814 <p>return any errors or warnings in this structure.</p>
817 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageAlphaChannel">SetImageAlphaChannel</a></h2>
818 <div class="doc-section">
820 <p>SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p>
822 <p>The format of the SetImageAlphaChannel method is:</p>
825 MagickBooleanType SetImageAlphaChannel(Image *image,
826 const AlphaChannelType alpha_type)
829 <p>A description of each parameter follows:</p>
835 <p>The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.</p>
838 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageBackgroundColor">SetImageBackgroundColor</a></h2>
839 <div class="doc-section">
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>
843 <p>The format of the SetImage method is:</p>
846 MagickBooleanType SetImageBackgroundColor(Image *image)
849 <p>A description of each parameter follows:</p>
855 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageChannels">SetImageChannels</a></h2>
856 <div class="doc-section">
858 <p>SetImageChannels() sets the number of pixels channels associated with the image.</p>
860 <p>The format of the SetImageChannels method is:</p>
863 MagickBooleanType SetImageChannels(Image *image,const size_t channels)
866 <p>A description of each parameter follows:</p>
872 <p>The number of pixel channels.</p>
875 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageColor">SetImageColor</a></h2>
876 <div class="doc-section">
878 <p>SetImageColor() set the entire image canvas to the specified color.</p>
880 <p>The format of the SetImageColor method is:</p>
883 MagickBooleanType SetImageColor(Image *image,
884 const MagickPixelPacket *color)
887 <p>A description of each parameter follows:</p>
893 <p>the image color.</p>
896 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageStorageClass">SetImageStorageClass</a></h2>
897 <div class="doc-section">
899 <p>SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.</p>
901 <p>The format of the SetImageStorageClass method is:</p>
904 MagickBooleanType SetImageStorageClass(Image *image,
905 const ClassType storage_class)
908 <p>A description of each parameter follows:</p>
913 <h5>storage_class</h5>
914 <p>The image class.</p>
917 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageClipMask">SetImageClipMask</a></h2>
918 <div class="doc-section">
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>
922 <p>The format of the SetImageClipMask method is:</p>
925 MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
928 <p>A description of each parameter follows:</p>
934 <p>the image clip path.</p>
937 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageExtent">SetImageExtent</a></h2>
938 <div class="doc-section">
940 <p>SetImageExtent() sets the image size (i.e. columns & rows).</p>
942 <p>The format of the SetImageExtent method is:</p>
945 MagickBooleanType SetImageExtent(Image *image,
946 const size_t columns,const size_t rows)
949 <p>A description of each parameter follows:</p>
955 <p>The image width in pixels.</p>
958 <p>The image height in pixels.</p>
961 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageInfoBlob">SetImageInfoBlob</a></h2>
962 <div class="doc-section">
964 <p>SetImageInfoBlob() sets the image info blob member.</p>
966 <p>The format of the SetImageInfoBlob method is:</p>
969 void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
973 <p>A description of each parameter follows:</p>
976 <p>the image info.</p>
982 <p>the blob length.</p>
985 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageInfoFile">SetImageInfoFile</a></h2>
986 <div class="doc-section">
988 <p>SetImageInfoFile() sets the image info file member.</p>
990 <p>The format of the SetImageInfoFile method is:</p>
993 void SetImageInfoFile(ImageInfo *image_info,FILE *file)
996 <p>A description of each parameter follows:</p>
999 <p>the image info.</p>
1005 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageMask">SetImageMask</a></h2>
1006 <div class="doc-section">
1008 <p>SetImageMask() associates a mask with the image. The mask must be the same dimensions as the image.</p>
1010 <p>The format of the SetImageMask method is:</p>
1013 MagickBooleanType SetImageMask(Image *image,const Image *mask)
1016 <p>A description of each parameter follows:</p>
1022 <p>the image mask.</p>
1025 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageOpacity">SetImageOpacity</a></h2>
1026 <div class="doc-section">
1028 <p>SetImageOpacity() sets the opacity levels of the image.</p>
1030 <p>The format of the SetImageOpacity method is:</p>
1033 MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
1036 <p>A description of each parameter follows:</p>
1042 <p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p>
1045 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageType">SetImageType</a></h2>
1046 <div class="doc-section">
1048 <p>SetImageType() sets the type of image. Choose from these types:</p>
1050 <p>BilevelType, GrayscaleType, GrayscaleMatteType, PaletteType, PaletteMatteType, TrueColorType, TrueColorMatteType, ColorSeparationType, ColorSeparationMatteType, OptimizeType</p>
1052 <p>The format of the SetImageType method is:</p>
1055 MagickBooleanType SetImageType(Image *image,const ImageType type)
1058 <p>A description of each parameter follows:</p>
1067 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a></h2>
1068 <div class="doc-section">
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>
1072 <p>The format of the SetImageVirtualPixelMethod() method is:</p>
1075 VirtualPixelMethod SetImageVirtualPixelMethod(const Image *image,
1076 const VirtualPixelMethod virtual_pixel_method)
1079 <p>A description of each parameter follows:</p>
1084 <h5>virtual_pixel_method</h5>
1085 <p>choose the type of virtual pixel.</p>
1088 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SmushImages">SmushImages</a></h2>
1089 <div class="doc-section">
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>
1093 <p>The current gravity setting now effects how the image is justified in the final image.</p>
1095 <p>The format of the SmushImages method is:</p>
1098 Image *SmushImages(const Image *images,const MagickBooleanType stack,
1099 ExceptionInfo *exception)
1102 <p>A description of each parameter follows:</p>
1105 <p>the image sequence.</p>
1108 <p>A value other than 0 stacks the images top-to-bottom.</p>
1111 <p>minimum distance in pixels between images.</p>
1114 <p>return any errors or warnings in this structure.</p>
1117 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="StripImage">StripImage</a></h2>
1118 <div class="doc-section">
1120 <p>StripImage() strips an image of all profiles and comments.</p>
1122 <p>The format of the StripImage method is:</p>
1125 MagickBooleanType StripImage(Image *image)
1128 <p>A description of each parameter follows:</p>
1134 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SyncImageSettings">SyncImageSettings</a></h2>
1135 <div class="doc-section">
1137 <p>SyncImageSettings() syncs image_info options into per-image attributes.</p>
1139 <p>The format of the SyncImageSettings method is:</p>
1142 MagickBooleanType SyncImageSettings(const ImageInfo *image_info,
1144 MagickBooleanType SyncImagesSettings(const ImageInfo *image_info,
1148 <p>A description of each parameter follows:</p>
1151 <p>the image info.</p>
1161 <span id="linkbar-west"> </span>
1162 <span id="linkbar-center">
1163 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">Discourse Server</a> •
1164 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
1166 <span id="linkbar-east"> </span>
1168 <div class="footer">
1169 <span id="footer-west">© 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>
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']);
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);