1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
\r
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
\r
5 <meta http-equiv="Content-Type" value="application/xhtml+xml" />
\r
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
\r
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
\r
8 <style type="text/css" media="screen,projection"><!--
\r
9 @import url("../../www/magick.css");
\r
11 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Image Methods</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:, image, methods, 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"/>
25 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
26 <meta name="Distribution" content="Global"/>
29 <body id="www-imagemagick-org">
\r
30 <div class="titlebar">
\r
31 <a href="../../index.html">
\r
32 <img src="../../images/script.png" alt="[ImageMagick]"
\r
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
34 <a href="http://www.networkredux.com">
\r
35 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
37 <a href="http://www.imagemagick.org/discourse-server/">
\r
38 <img src="../../images/logo.jpg" alt=""
\r
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
40 <a href="../../index.html">
\r
41 <img src="../../images/sprite.jpg" alt=""
\r
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
45 <div class="eastbar">
\r
48 <a href="../../index.html">About ImageMagick</a>
50 <div class="sep"></div>
\r
52 <a href="../../www/command-line-tools.html">Command-line Tools</a>
55 <a href="../../www/command-line-processing.html">Processing</a>
58 <a href="../../www/command-line-options.html">Options</a>
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
64 <a href="../../www/api.html">Program Interfaces</a>
67 <a href="../../www/magick-wand.html">MagickWand</a>
70 <a href="../../www/magick-core.html">MagickCore</a>
73 <a href="../../www/perl-magick.html">PerlMagick</a>
76 <a href="../../Magick++/">Magick++</a>
79 <a href="../../www/architecture.html">Architecture</a>
81 <div class="sep"></div>
\r
83 <a href="../../www/install-source.html">Install from Source</a>
86 <a href="../../www/install-source.html#unix">Unix</a>
89 <a href="../../www/install-source.html#windows">Windows</a>
92 <a href="../../www/binary-releases.html">Binary Releases</a>
95 <a href="../../www/binary-releases.html#unix">Unix</a>
98 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
101 <a href="../../www/binary-releases.html#windows">Windows</a>
104 <a href="../../www/resources.html">Resources</a>
106 <div class="sep"></div>
\r
108 <a href="../../www/download.html">Download</a>
110 <div class="sep"></div>
\r
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
114 <div class="sep"></div>
\r
116 <a href="../../www/sitemap.html">Site Map</a>
119 <a href="../../www/links.html">Links</a>
121 <div class="sep"></div>
\r
123 <a href="../../www/sponsors.html">Sponsors:</a>
125 <div class="sponsbox">
126 <div class="sponsor">
127 <a href="http://www.hygi.de">Reinigungsmittel</a><!-- 201002000400+ -->
129 <div class="sponsor">
130 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
132 <div class="sponsor">
133 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
135 <div class="sponsor">
136 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
138 <div class="sponsor">
139 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
141 <div class="sponsor">
142 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
144 <div class="sponsor">
145 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
147 <div class="sponsor">
148 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
158 <p class="navigation-index">[<a href="#AcquireImage">AcquireImage</a> • <a href="#AcquireImageColormap">AcquireImageColormap</a> • <a href="#AcquireImageInfo">AcquireImageInfo</a> • <a href="#AcquireNextImage">AcquireNextImage</a> • <a href="#AppendImages">AppendImages</a> • <a href="#CatchImageException">CatchImageException</a> • <a href="#ClipImagePath">ClipImagePath</a> • <a href="#CloneImage">CloneImage</a> • <a href="#CloneImageInfo">CloneImageInfo</a> • <a href="#CombineImages">CombineImages</a> • <a href="#DestroyImage">DestroyImage</a> • <a href="#DestroyImageInfo">DestroyImageInfo</a> • <a href="#GetImageAlphaChannel">GetImageAlphaChannel</a> • <a href="#GetImageClipMask">GetImageClipMask</a> • <a href="#GetImageException">GetImageException</a> • <a href="#GetImageInfo">GetImageInfo</a> • <a href="#GetImageMask">GetImageMask</a> • <a href="#GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a> • <a href="#InterpretImageFilename">InterpretImageFilename</a> • <a href="#IsHighDynamicRangeImage">IsHighDynamicRangeImage</a> • <a href="#IsImageObject">IsImageObject</a> • <a href="#IsTaintImage">IsTaintImage</a> • <a href="#ModifyImage">ModifyImage</a> • <a href="#NewMagickImage">NewMagickImage</a> • <a href="#ReferenceImage">ReferenceImage</a> • <a href="#ResetImagePage">ResetImagePage</a> • <a href="#SeparateImageChannel">SeparateImageChannel</a> • <a href="#SeparateImages">SeparateImages</a> • <a href="#SetImageAlphaChannel">SetImageAlphaChannel</a> • <a href="#SetImageBackgroundColor">SetImageBackgroundColor</a> • <a href="#SetImageStorageClass">SetImageStorageClass</a> • <a href="#SetImageClipMask">SetImageClipMask</a> • <a href="#SetImageExtent">SetImageExtent</a> • <a href="#SetImageInfoBlob">SetImageInfoBlob</a> • <a href="#SetImageInfoFile">SetImageInfoFile</a> • <a href="#SetImageMask">SetImageMask</a> • <a href="#SetImageOpacity">SetImageOpacity</a> • <a href="#SetImageType">SetImageType</a> • <a href="#SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a> • <a href="#StripImage">StripImage</a> • <a href="#SyncImageSettings">SyncImageSettings</a>]</p>
160 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
161 _8c.html" target="source" name="AcquireImage">AcquireImage</a></h2>
162 <div class="doc-section">
164 <p>AcquireImage() returns a pointer to an image structure initialized to default values.</p></ol>
166 <p>The format of the AcquireImage method is:</p>
169 Image *AcquireImage(const ImageInfo *image_info)
172 <p>A description of each parameter follows:</p></ol>
175 <ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
178 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
179 _8c.html" target="source" name="AcquireImageColormap">AcquireImageColormap</a></h2>
180 <div class="doc-section">
182 <p>AcquireImageColormap() allocates an image colormap and initializes it to a linear gray colorspace. If the image already has a colormap, it is replaced. AcquireImageColormap() returns MagickTrue if successful, otherwise MagickFalse if there is not enough memory.</p></ol>
184 <p>The format of the AcquireImageColormap method is:</p>
187 MagickBooleanType AcquireImageColormap(Image *image,
188 const unsigned long colors)
191 <p>A description of each parameter follows:</p></ol>
194 <ol><p>the image.</p></ol>
197 <ol><p>the number of colors in the image colormap.</p></ol>
200 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
201 _8c.html" target="source" name="AcquireImageInfo">AcquireImageInfo</a></h2>
202 <div class="doc-section">
204 <p>AcquireImageInfo() allocates the ImageInfo structure.</p></ol>
206 <p>The format of the AcquireImageInfo method is:</p>
209 ImageInfo *AcquireImageInfo(void)
213 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
214 _8c.html" target="source" name="AcquireNextImage">AcquireNextImage</a></h2>
215 <div class="doc-section">
217 <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></ol>
219 <p>The format of the AcquireNextImage method is:</p>
222 void AcquireNextImage(const ImageInfo *image_info,Image *image)
225 <p>A description of each parameter follows:</p></ol>
228 <ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
231 <ol><p>the image.</p></ol>
234 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
235 _8c.html" target="source" name="AppendImages">AppendImages</a></h2>
236 <div class="doc-section">
238 <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></ol>
240 <p>The current gravity setting now effects how the image is justified in the final image.</p></ol>
242 <p>The format of the AppendImages method is:</p>
245 Image *AppendImages(const Image *image,const MagickBooleanType stack,
246 ExceptionInfo *exception)
249 <p>A description of each parameter follows:</p></ol>
252 <ol><p>the image sequence.</p></ol>
255 <ol><p>A value other than 0 stacks the images top-to-bottom.</p></ol>
258 <ol><p>return any errors or warnings in this structure.</p></ol>
261 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
262 _8c.html" target="source" name="CatchImageException">CatchImageException</a></h2>
263 <div class="doc-section">
265 <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></ol>
267 <p>The format of the CatchImageException method is:</p>
270 ExceptionType CatchImageException(Image *image)
273 <p>A description of each parameter follows:</p></ol>
276 <ol><p>An image sequence.</p></ol>
279 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
280 _8c.html" target="source" name="ClipImagePath">ClipImagePath</a></h2>
281 <div class="doc-section">
283 <p>ClipImagePath() sets the image clip mask based any clipping path information if it exists.</p></ol>
285 <p>The format of the ClipImagePath method is:</p>
288 MagickBooleanType ClipImagePath(Image *image,const char *pathname,
289 const MagickBooleanType inside)
292 <p>A description of each parameter follows:</p></ol>
295 <ol><p>the image.</p></ol>
298 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
301 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
304 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
305 _8c.html" target="source" name="CloneImage">CloneImage</a></h2>
306 <div class="doc-section">
308 <p>CloneImage() copies an image and returns the copy as a new image object. 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></ol>
310 <p>The format of the CloneImage method is:</p>
313 Image *CloneImage(const Image *image,const unsigned long columns,
314 const unsigned long rows,const MagickBooleanType orphan,
315 ExceptionInfo *exception)
318 <p>A description of each parameter follows:</p></ol>
321 <ol><p>the image.</p></ol>
324 <ol><p>the number of columns in the cloned image.</p></ol>
327 <ol><p>the number of rows in the cloned image.</p></ol>
330 <ol><p>With a value other than 0, the cloned image is detached from its parent I/O stream.</p></ol>
333 <ol><p>return any errors or warnings in this structure.</p></ol>
336 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
337 _8c.html" target="source" name="CloneImageInfo">CloneImageInfo</a></h2>
338 <div class="doc-section">
340 <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></ol>
342 <p>The format of the CloneImageInfo method is:</p>
345 ImageInfo *CloneImageInfo(const ImageInfo *image_info)
348 <p>A description of each parameter follows:</p></ol>
351 <ol><p>the image info.</p></ol>
354 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
355 _8c.html" target="source" name="CombineImages">CombineImages</a></h2>
356 <div class="doc-section">
358 <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></ol>
360 <p>The format of the CombineImages method is:</p>
363 Image *CombineImages(const Image *image,const ChannelType channel,
364 ExceptionInfo *exception)
367 <p>A description of each parameter follows:</p></ol>
370 <ol><p>the image.</p></ol>
373 <ol><p>return any errors or warnings in this structure.</p></ol>
376 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
377 _8c.html" target="source" name="DestroyImage">DestroyImage</a></h2>
378 <div class="doc-section">
380 <p>DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p></ol>
382 <p>The format of the DestroyImage method is:</p>
385 Image *DestroyImage(Image *image)
388 <p>A description of each parameter follows:</p></ol>
391 <ol><p>the image.</p></ol>
394 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
395 _8c.html" target="source" name="DestroyImageInfo">DestroyImageInfo</a></h2>
396 <div class="doc-section">
398 <p>DestroyImageInfo() deallocates memory associated with an ImageInfo structure.</p></ol>
400 <p>The format of the DestroyImageInfo method is:</p>
403 ImageInfo *DestroyImageInfo(ImageInfo *image_info)
406 <p>A description of each parameter follows:</p></ol>
409 <ol><p>the image info.</p></ol>
412 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
413 _8c.html" target="source" name="GetImageAlphaChannel">GetImageAlphaChannel</a></h2>
414 <div class="doc-section">
416 <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></ol>
418 <p>The format of the GetImageAlphaChannel method is:</p>
421 MagickBooleanType GetImageAlphaChannel(const Image *image)
424 <p>A description of each parameter follows:</p></ol>
427 <ol><p>the image.</p></ol>
430 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
431 _8c.html" target="source" name="GetImageClipMask">GetImageClipMask</a></h2>
432 <div class="doc-section">
434 <p>GetImageClipMask() returns the clip path associated with the image.</p></ol>
436 <p>The format of the GetImageClipMask method is:</p>
439 Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
442 <p>A description of each parameter follows:</p></ol>
445 <ol><p>the image.</p></ol>
448 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
449 _8c.html" target="source" name="GetImageException">GetImageException</a></h2>
450 <div class="doc-section">
452 <p>GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.</p></ol>
454 <p>The format of the GetImageException method is:</p>
457 void GetImageException(Image *image,ExceptionInfo *exception)
460 <p>A description of each parameter follows:</p></ol>
463 <ol><p>Specifies a pointer to a list of one or more images.</p></ol>
466 <ol><p>return the highest severity exception.</p></ol>
469 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
470 _8c.html" target="source" name="GetImageInfo">GetImageInfo</a></h2>
471 <div class="doc-section">
473 <p>GetImageInfo() initializes image_info to default values.</p></ol>
475 <p>The format of the GetImageInfo method is:</p>
478 void GetImageInfo(ImageInfo *image_info)
481 <p>A description of each parameter follows:</p></ol>
484 <ol><p>the image info.</p></ol>
487 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
488 _8c.html" target="source" name="GetImageMask">GetImageMask</a></h2>
489 <div class="doc-section">
491 <p>GetImageMask() returns the mask associated with the image.</p></ol>
493 <p>The format of the GetImageMask method is:</p>
496 Image *GetImageMask(const Image *image,ExceptionInfo *exception)
499 <p>A description of each parameter follows:</p></ol>
502 <ol><p>the image.</p></ol>
505 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
506 _8c.html" target="source" name="GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a></h2>
507 <div class="doc-section">
509 <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></ol>
511 <p>The format of the GetImageVirtualPixelMethod() method is:</p>
514 VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
517 <p>A description of each parameter follows:</p></ol>
520 <ol><p>the image.</p></ol>
523 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
524 _8c.html" target="source" name="InterpretImageFilename">InterpretImageFilename</a></h2>
525 <div class="doc-section">
527 <p>InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.</p></ol>
529 <p>The format of the InterpretImageFilename method is:</p>
532 size_t InterpretImageFilename(const ImageInfo *image_info,
533 Image *image,const char *format,int value,char *filename)
536 <p>A description of each parameter follows.</p></ol>
539 <ol><p>the image info..</p></ol>
542 <ol><p>the image.</p></ol>
545 <ol><p>A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.</p></ol>
548 <ol><p>Numeric value to substitute into format filename.</p></ol>
551 <ol><p>return the formatted filename in this character buffer.</p></ol>
554 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
555 _8c.html" target="source" name="IsHighDynamicRangeImage">IsHighDynamicRangeImage</a></h2>
556 <div class="doc-section">
558 <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></ol>
560 <p>The format of the IsHighDynamicRangeImage method is:</p>
563 MagickBooleanType IsHighDynamicRangeImage(const Image *image,
564 ExceptionInfo *exception)
567 <p>A description of each parameter follows:</p></ol>
570 <ol><p>the image.</p></ol>
573 <ol><p>return any errors or warnings in this structure.</p></ol>
576 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
577 _8c.html" target="source" name="IsImageObject">IsImageObject</a></h2>
578 <div class="doc-section">
580 <p>IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.</p></ol>
582 <p>The format of the IsImageObject method is:</p>
585 MagickBooleanType IsImageObject(const Image *image)
588 <p>A description of each parameter follows:</p></ol>
591 <ol><p>the image.</p></ol>
594 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
595 _8c.html" target="source" name="IsTaintImage">IsTaintImage</a></h2>
596 <div class="doc-section">
598 <p>IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.</p></ol>
600 <p>The format of the IsTaintImage method is:</p>
603 MagickBooleanType IsTaintImage(const Image *image)
606 <p>A description of each parameter follows:</p></ol>
609 <ol><p>the image.</p></ol>
612 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
613 _8c.html" target="source" name="ModifyImage">ModifyImage</a></h2>
614 <div class="doc-section">
616 <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></ol>
618 <p>The format of the ModifyImage method is:</p>
621 MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
624 <p>A description of each parameter follows:</p></ol>
627 <ol><p>the image.</p></ol>
630 <ol><p>return any errors or warnings in this structure.</p></ol>
633 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
634 _8c.html" target="source" name="NewMagickImage">NewMagickImage</a></h2>
635 <div class="doc-section">
637 <p>NewMagickImage() creates a blank image canvas of the specified size and background color.</p></ol>
639 <p>The format of the NewMagickImage method is:</p>
642 Image *NewMagickImage(const ImageInfo *image_info,
643 const unsigned long width,const unsigned long height,
644 const MagickPixelPacket *background)
647 <p>A description of each parameter follows:</p></ol>
650 <ol><p>the image.</p></ol>
653 <ol><p>the image width.</p></ol>
656 <ol><p>the image height.</p></ol>
659 <ol><p>the image color.</p></ol>
662 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
663 _8c.html" target="source" name="ReferenceImage">ReferenceImage</a></h2>
664 <div class="doc-section">
666 <p>ReferenceImage() increments the reference count associated with an image returning a pointer to the image.</p></ol>
668 <p>The format of the ReferenceImage method is:</p>
671 Image *ReferenceImage(Image *image)
674 <p>A description of each parameter follows:</p></ol>
677 <ol><p>the image.</p></ol>
680 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
681 _8c.html" target="source" name="ResetImagePage">ResetImagePage</a></h2>
682 <div class="doc-section">
684 <p>ResetImagePage() resets the image page canvas and position.</p></ol>
686 <p>The format of the ResetImagePage method is:</p>
689 MagickBooleanType ResetImagePage(Image *image,const char *page)
692 <p>A description of each parameter follows:</p></ol>
695 <ol><p>the image.</p></ol>
698 <ol><p>the relative page specification.</p></ol>
701 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
702 _8c.html" target="source" name="SeparateImageChannel">SeparateImageChannel</a></h2>
703 <div class="doc-section">
705 <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></ol>
707 <p>The format of the SeparateImageChannel method is:</p>
710 MagickBooleanType SeparateImageChannel(Image *image,
711 const ChannelType channel)
714 <p>A description of each parameter follows:</p></ol>
717 <ol><p>the image.</p></ol>
720 <ol><p>Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
723 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
724 _8c.html" target="source" name="SeparateImages">SeparateImages</a></h2>
725 <div class="doc-section">
727 <p>SeparateImages() returns a separate grayscale image for each channel specified.</p></ol>
729 <p>The format of the SeparateImages method is:</p>
732 MagickBooleanType SeparateImages(const Image *image,
733 const ChannelType channel,ExceptionInfo *exception)
736 <p>A description of each parameter follows:</p></ol>
739 <ol><p>the image.</p></ol>
742 <ol><p>Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
745 <ol><p>return any errors or warnings in this structure.</p></ol>
748 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
749 _8c.html" target="source" name="SetImageAlphaChannel">SetImageAlphaChannel</a></h2>
750 <div class="doc-section">
752 <p>SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p></ol>
754 <p>The format of the SetImageAlphaChannel method is:</p>
757 MagickBooleanType SetImageAlphaChannel(Image *image,
758 const AlphaChannelType alpha_type)
761 <p>A description of each parameter follows:</p></ol>
764 <ol><p>the image.</p></ol>
767 <ol><p>The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.</p></ol>
770 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
771 _8c.html" target="source" name="SetImageBackgroundColor">SetImageBackgroundColor</a></h2>
772 <div class="doc-section">
774 <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></ol>
776 <p>The format of the SetImage method is:</p>
779 MagickBooleanType SetImageBackgroundColor(Image *image)
782 <p>A description of each parameter follows:</p></ol>
785 <ol><p>the image.</p></ol>
788 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
789 _8c.html" target="source" name="SetImageStorageClass">SetImageStorageClass</a></h2>
790 <div class="doc-section">
792 <p>SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.</p></ol>
794 <p>The format of the SetImageStorageClass method is:</p>
797 MagickBooleanType SetImageStorageClass(Image *image,
798 const ClassType storage_class)
801 <p>A description of each parameter follows:</p></ol>
804 <ol><p>the image.</p></ol>
806 <h5>storage_class</h5>
807 <ol><p>The image class.</p></ol>
810 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
811 _8c.html" target="source" name="SetImageClipMask">SetImageClipMask</a></h2>
812 <div class="doc-section">
814 <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></ol>
816 <p>The format of the SetImageClipMask method is:</p>
819 MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
822 <p>A description of each parameter follows:</p></ol>
825 <ol><p>the image.</p></ol>
828 <ol><p>the image clip path.</p></ol>
831 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
832 _8c.html" target="source" name="SetImageExtent">SetImageExtent</a></h2>
833 <div class="doc-section">
835 <p>SetImageExtent() sets the image size (i.e. columns & rows).</p></ol>
837 <p>The format of the SetImageExtent method is:</p>
840 MagickBooleanType SetImageExtent(Image *image,
841 const unsigned long columns,const unsigned long rows)
844 <p>A description of each parameter follows:</p></ol>
847 <ol><p>the image.</p></ol>
850 <ol><p>The image width in pixels.</p></ol>
853 <ol><p>The image height in pixels.</p></ol>
856 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
857 _8c.html" target="source" name="SetImageInfoBlob">SetImageInfoBlob</a></h2>
858 <div class="doc-section">
860 <p>SetImageInfoBlob() sets the image info blob member.</p></ol>
862 <p>The format of the SetImageInfoBlob method is:</p>
865 void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
869 <p>A description of each parameter follows:</p></ol>
872 <ol><p>the image info.</p></ol>
875 <ol><p>the blob.</p></ol>
878 <ol><p>the blob length.</p></ol>
881 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
882 _8c.html" target="source" name="SetImageInfoFile">SetImageInfoFile</a></h2>
883 <div class="doc-section">
885 <p>SetImageInfoFile() sets the image info file member.</p></ol>
887 <p>The format of the SetImageInfoFile method is:</p>
890 void SetImageInfoFile(ImageInfo *image_info,FILE *file)
893 <p>A description of each parameter follows:</p></ol>
896 <ol><p>the image info.</p></ol>
899 <ol><p>the file.</p></ol>
902 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
903 _8c.html" target="source" name="SetImageMask">SetImageMask</a></h2>
904 <div class="doc-section">
906 <p>SetImageMask() associates a mask with the image. The mask must be the same dimensions as the image.</p></ol>
908 <p>The format of the SetImageMask method is:</p>
911 MagickBooleanType SetImageMask(Image *image,const Image *mask)
914 <p>A description of each parameter follows:</p></ol>
917 <ol><p>the image.</p></ol>
920 <ol><p>the image mask.</p></ol>
923 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
924 _8c.html" target="source" name="SetImageOpacity">SetImageOpacity</a></h2>
925 <div class="doc-section">
927 <p>SetImageOpacity() sets the opacity levels of the image.</p></ol>
929 <p>The format of the SetImageOpacity method is:</p>
932 MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
935 <p>A description of each parameter follows:</p></ol>
938 <ol><p>the image.</p></ol>
941 <ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
944 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
945 _8c.html" target="source" name="SetImageType">SetImageType</a></h2>
946 <div class="doc-section">
948 <p>SetImageType() sets the type of image. Choose from these types:</p></ol>
950 <p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte OptimizeType</p></ol>
952 <p>The format of the SetImageType method is:</p>
955 MagickBooleanType SetImageType(Image *image,const ImageType type)
958 <p>A description of each parameter follows:</p></ol>
961 <ol><p>the image.</p></ol>
964 <ol><p>Image type.</p></ol>
967 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
968 _8c.html" target="source" name="SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a></h2>
969 <div class="doc-section">
971 <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></ol>
973 <p>The format of the SetImageVirtualPixelMethod() method is:</p>
976 VirtualPixelMethod SetImageVirtualPixelMethod(const Image *image,
977 const VirtualPixelMethod virtual_pixel_method)
980 <p>A description of each parameter follows:</p></ol>
983 <ol><p>the image.</p></ol>
985 <h5>virtual_pixel_method</h5>
986 <ol><p>choose the type of virtual pixel.</p></ol>
989 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
990 _8c.html" target="source" name="StripImage">StripImage</a></h2>
991 <div class="doc-section">
993 <p>StripImage() strips an image of all profiles and comments.</p></ol>
995 <p>The format of the StripImage method is:</p>
998 MagickBooleanType StripImage(Image *image)
1001 <p>A description of each parameter follows:</p></ol>
1004 <ol><p>the image.</p></ol>
1007 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
1008 _8c.html" target="source" name="SyncImageSettings">SyncImageSettings</a></h2>
1009 <div class="doc-section">
1011 <p>SyncImageSettings() sync the image info options to the image.</p></ol>
1013 <p>The format of the SyncImageSettings method is:</p>
1016 MagickBooleanType SyncImageSettings(const ImageInfo *image_info,
1018 MagickBooleanType SyncImagesSettings(const ImageInfo *image_info,
1022 <p>A description of each parameter follows:</p></ol>
1025 <ol><p>the image info.</p></ol>
1028 <ol><p>the image.</p></ol>
1034 <div id="linkbar">
\r
1035 <!-- <span id="linkbar-west"> </span> -->
\r
1036 <span id="linkbar-center">
\r
1037 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
1038 <a href="../../www/mailing-list.html">Mailing Lists</a> •
\r
1039 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
1041 <span id="linkbar-east"> </span>
\r
1043 <div class="footer">
\r
1044 <span id="footer-west">© 1999-2009 ImageMagick Studio LLC</span>
\r
1045 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
1047 <div style="clear: both; margin: 0; width: 100%; "></div>
\r