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 name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
\r
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
\r
7 <style type="text/css" media="screen,projection"><!--
\r
8 @import url("../../www/magick.css");
\r
10 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
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="Generator" content="PHP"/>
16 <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"/>
17 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
18 <meta name="Rating" content="GENERAL"/>
19 <meta name="Robots" content="INDEX, FOLLOW"/>
20 <meta name="Generator" content="ImageMagick Studio LLC"/>
21 <meta name="Author" content="ImageMagick Studio LLC"/>
22 <meta name="Revisit-after" content="2 DAYS"/>
23 <meta name="Resource-type" content="document"/>
24 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
25 <meta name="Distribution" content="Global"/>
28 <body id="www-imagemagick-org">
\r
29 <div class="titlebar">
\r
30 <a href="../../index.html">
\r
31 <img src="../../images/script.png" alt="[ImageMagick]"
\r
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
33 <a href="http://www.networkredux.com">
\r
34 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
36 <a href="http://www.imagemagick.org/discourse-server/">
\r
37 <img src="../../images/logo.jpg" alt=""
\r
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
39 <a href="../../index.html">
\r
40 <img src="../../images/sprite.jpg" alt=""
\r
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
44 <div class="eastbar">
\r
47 <a href="../../index.html">About ImageMagick</a>
49 <div class="sep"></div>
\r
51 <a href="../../www/command-line-tools.html">Command-line Tools</a>
54 <a href="../../www/command-line-processing.html">Processing</a>
57 <a href="../../www/command-line-options.html">Options</a>
60 <a href="http://www.imagemagick.org/Usage/">Usage</a>
63 <a href="../../www/api.html">Program Interfaces</a>
66 <a href="../../www/magick-wand.html">MagickWand</a>
69 <a href="../../www/magick-core.html">MagickCore</a>
72 <a href="../../www/perl-magick.html">PerlMagick</a>
75 <a href="../../Magick++/">Magick++</a>
78 <a href="../../www/architecture.html">Architecture</a>
80 <div class="sep"></div>
\r
82 <a href="../../www/install-source.html">Install from Source</a>
85 <a href="../../www/install-source.html#unix">Unix</a>
88 <a href="../../www/install-source.html#windows">Windows</a>
91 <a href="../../www/binary-releases.html">Binary Releases</a>
94 <a href="../../www/binary-releases.html#unix">Unix</a>
97 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
100 <a href="../../www/binary-releases.html#windows">Windows</a>
103 <a href="../../www/resources.html">Resources</a>
105 <div class="sep"></div>
\r
107 <a href="../../www/download.html">Download</a>
109 <div class="sep"></div>
\r
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113 <div class="sep"></div>
\r
115 <a href="../../www/sitemap.html">Site Map</a>
118 <a href="../../www/links.html">Links</a>
120 <div class="sep"></div>
\r
122 <a href="../../www/sponsors.html">Sponsors:</a>
124 <div class="sponsbox">
125 <div class="sponsor">
126 <a href="http://www.buerodruck.de/stempel-service/index.html">Stempel bestellen</a><!-- 200910000035+ -->
128 <div class="sponsor">
129 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
131 <div class="sponsor">
132 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
134 <div class="sponsor">
135 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
137 <div class="sponsor">
138 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
140 <div class="sponsor">
141 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
143 <div class="sponsor">
144 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
154 <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="#AverageImages">AverageImages</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="#CycleColormap">CycleColormap</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="#GetImageType">GetImageType</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="#TextureImage">TextureImage</a>]</p>
156 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
157 _8c.html" target="source" name="AcquireImage">AcquireImage</a></h2>
158 <div class="doc-section">
160 <p>AcquireImage() returns a pointer to an image structure initialized to default values.</p></ol>
162 <p>The format of the AcquireImage method is:</p>
165 Image *AcquireImage(const ImageInfo *image_info)
168 <p>A description of each parameter follows:</p></ol>
171 <ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
174 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
175 _8c.html" target="source" name="AcquireImageColormap">AcquireImageColormap</a></h2>
176 <div class="doc-section">
178 <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>
180 <p>The format of the AcquireImageColormap method is:</p>
183 MagickBooleanType AcquireImageColormap(Image *image,
184 const unsigned long colors)
187 <p>A description of each parameter follows:</p></ol>
190 <ol><p>the image.</p></ol>
193 <ol><p>the number of colors in the image colormap.</p></ol>
196 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
197 _8c.html" target="source" name="AcquireImageInfo">AcquireImageInfo</a></h2>
198 <div class="doc-section">
200 <p>AcquireImageInfo() allocates the ImageInfo structure.</p></ol>
202 <p>The format of the AcquireImageInfo method is:</p>
205 ImageInfo *AcquireImageInfo(void)
209 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
210 _8c.html" target="source" name="AcquireNextImage">AcquireNextImage</a></h2>
211 <div class="doc-section">
213 <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>
215 <p>The format of the AcquireNextImage method is:</p>
218 void AcquireNextImage(const ImageInfo *image_info,Image *image)
221 <p>A description of each parameter follows:</p></ol>
224 <ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
227 <ol><p>the image.</p></ol>
230 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
231 _8c.html" target="source" name="AppendImages">AppendImages</a></h2>
232 <div class="doc-section">
234 <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>
236 <p>The current gravity setting now effects how the image is justified in the final image.</p></ol>
238 <p>The format of the AppendImages method is:</p>
241 Image *AppendImages(const Image *image,const MagickBooleanType stack,
242 ExceptionInfo *exception)
245 <p>A description of each parameter follows:</p></ol>
248 <ol><p>the image sequence.</p></ol>
251 <ol><p>A value other than 0 stacks the images top-to-bottom.</p></ol>
254 <ol><p>return any errors or warnings in this structure.</p></ol>
257 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
258 _8c.html" target="source" name="AverageImages">AverageImages</a></h2>
259 <div class="doc-section">
261 <p>AverageImages() takes a set of images and averages them together. Each image in the set must have the same width and height. AverageImages() returns a single image with each corresponding pixel component of each image averaged. On failure, a NULL image is returned and exception describes the reason for the failure.</p></ol>
263 <p>The format of the AverageImages method is:</p>
266 Image *AverageImages(Image *image,ExceptionInfo *exception)
269 <p>A description of each parameter follows:</p></ol>
272 <ol><p>the image sequence.</p></ol>
275 <ol><p>return any errors or warnings in this structure.</p></ol>
278 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
279 _8c.html" target="source" name="CatchImageException">CatchImageException</a></h2>
280 <div class="doc-section">
282 <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>
284 <p>The format of the CatchImageException method is:</p>
287 ExceptionType CatchImageException(Image *image)
290 <p>A description of each parameter follows:</p></ol>
293 <ol><p>An image sequence.</p></ol>
296 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
297 _8c.html" target="source" name="ClipImagePath">ClipImagePath</a></h2>
298 <div class="doc-section">
300 <p>ClipImagePath() sets the image clip mask based any clipping path information if it exists.</p></ol>
302 <p>The format of the ClipImagePath method is:</p>
305 MagickBooleanType ClipImagePath(Image *image,const char *pathname,
306 const MagickBooleanType inside)
309 <p>A description of each parameter follows:</p></ol>
312 <ol><p>the image.</p></ol>
315 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
318 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
321 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
322 _8c.html" target="source" name="CloneImage">CloneImage</a></h2>
323 <div class="doc-section">
325 <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>
327 <p>The format of the CloneImage method is:</p>
330 Image *CloneImage(const Image *image,const unsigned long columns,
331 const unsigned long rows,const MagickBooleanType orphan,
332 ExceptionInfo *exception)
335 <p>A description of each parameter follows:</p></ol>
338 <ol><p>the image.</p></ol>
341 <ol><p>the number of columns in the cloned image.</p></ol>
344 <ol><p>the number of rows in the cloned image.</p></ol>
347 <ol><p>With a value other than 0, the cloned image is detached from its parent I/O stream.</p></ol>
350 <ol><p>return any errors or warnings in this structure.</p></ol>
353 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
354 _8c.html" target="source" name="CloneImageInfo">CloneImageInfo</a></h2>
355 <div class="doc-section">
357 <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>
359 <p>The format of the CloneImageInfo method is:</p>
362 ImageInfo *CloneImageInfo(const ImageInfo *image_info)
365 <p>A description of each parameter follows:</p></ol>
368 <ol><p>the image info.</p></ol>
371 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
372 _8c.html" target="source" name="CombineImages">CombineImages</a></h2>
373 <div class="doc-section">
375 <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>
377 <p>The format of the CombineImages method is:</p>
380 Image *CombineImages(const Image *image,const ChannelType channel,
381 ExceptionInfo *exception)
384 <p>A description of each parameter follows:</p></ol>
387 <ol><p>the image.</p></ol>
390 <ol><p>return any errors or warnings in this structure.</p></ol>
393 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
394 _8c.html" target="source" name="CycleColormap">CycleColormap</a></h2>
395 <div class="doc-section">
397 <p>CycleColormap() displaces an image's colormap by a given number of positions. If you cycle the colormap a number of times you can produce a psychodelic effect.</p></ol>
399 <p>The format of the CycleColormapImage method is:</p>
402 MagickBooleanType CycleColormapImage(Image *image,const long displace)
405 <p>A description of each parameter follows:</p></ol>
408 <ol><p>the image.</p></ol>
411 <ol><p>displace the colormap this amount.</p></ol>
414 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
415 _8c.html" target="source" name="DestroyImage">DestroyImage</a></h2>
416 <div class="doc-section">
418 <p>DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p></ol>
420 <p>The format of the DestroyImage method is:</p>
423 Image *DestroyImage(Image *image)
426 <p>A description of each parameter follows:</p></ol>
429 <ol><p>the image.</p></ol>
432 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
433 _8c.html" target="source" name="DestroyImageInfo">DestroyImageInfo</a></h2>
434 <div class="doc-section">
436 <p>DestroyImageInfo() deallocates memory associated with an ImageInfo structure.</p></ol>
438 <p>The format of the DestroyImageInfo method is:</p>
441 ImageInfo *DestroyImageInfo(ImageInfo *image_info)
444 <p>A description of each parameter follows:</p></ol>
447 <ol><p>the image info.</p></ol>
450 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
451 _8c.html" target="source" name="GetImageAlphaChannel">GetImageAlphaChannel</a></h2>
452 <div class="doc-section">
454 <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>
456 <p>The format of the GetImageAlphaChannel method is:</p>
459 MagickBooleanType GetImageAlphaChannel(const Image *image)
462 <p>A description of each parameter follows:</p></ol>
465 <ol><p>the image.</p></ol>
468 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
469 _8c.html" target="source" name="GetImageClipMask">GetImageClipMask</a></h2>
470 <div class="doc-section">
472 <p>GetImageClipMask() returns the clip path associated with the image.</p></ol>
474 <p>The format of the GetImageClipMask method is:</p>
477 Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
480 <p>A description of each parameter follows:</p></ol>
483 <ol><p>the image.</p></ol>
486 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
487 _8c.html" target="source" name="GetImageException">GetImageException</a></h2>
488 <div class="doc-section">
490 <p>GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.</p></ol>
492 <p>The format of the GetImageException method is:</p>
495 void GetImageException(Image *image,ExceptionInfo *exception)
498 <p>A description of each parameter follows:</p></ol>
501 <ol><p>Specifies a pointer to a list of one or more images.</p></ol>
504 <ol><p>return the highest severity exception.</p></ol>
507 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
508 _8c.html" target="source" name="GetImageInfo">GetImageInfo</a></h2>
509 <div class="doc-section">
511 <p>GetImageInfo() initializes image_info to default values.</p></ol>
513 <p>The format of the GetImageInfo method is:</p>
516 void GetImageInfo(ImageInfo *image_info)
519 <p>A description of each parameter follows:</p></ol>
522 <ol><p>the image info.</p></ol>
525 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
526 _8c.html" target="source" name="GetImageMask">GetImageMask</a></h2>
527 <div class="doc-section">
529 <p>GetImageMask() returns the mask associated with the image.</p></ol>
531 <p>The format of the GetImageMask method is:</p>
534 Image *GetImageMask(const Image *image,ExceptionInfo *exception)
537 <p>A description of each parameter follows:</p></ol>
540 <ol><p>the image.</p></ol>
543 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
544 _8c.html" target="source" name="GetImageType">GetImageType</a></h2>
545 <div class="doc-section">
547 <p>GetImageType() returns the potential type of image:</p></ol>
549 <p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte</p></ol>
551 <p>To ensure the image type matches its potential, use SetImageType():</p>
554 (void) SetImageType(image,GetImageType(image));
557 <p>The format of the GetImageType method is:</p>
560 ImageType GetImageType(const Image *image,ExceptionInfo *exception)
563 <p>A description of each parameter follows:</p></ol>
566 <ol><p>the image.</p></ol>
569 <ol><p>return any errors or warnings in this structure.</p></ol>
572 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
573 _8c.html" target="source" name="GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a></h2>
574 <div class="doc-section">
576 <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>
578 <p>The format of the GetImageVirtualPixelMethod() method is:</p>
581 VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
584 <p>A description of each parameter follows:</p></ol>
587 <ol><p>the image.</p></ol>
590 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
591 _8c.html" target="source" name="InterpretImageFilename">InterpretImageFilename</a></h2>
592 <div class="doc-section">
594 <p>InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.</p></ol>
596 <p>The format of the InterpretImageFilename method is:</p>
599 size_t InterpretImageFilename(const ImageInfo *image_info,
600 Image *image,const char *format,int value,char *filename)
603 <p>A description of each parameter follows.</p></ol>
606 <ol><p>the image info..</p></ol>
609 <ol><p>the image.</p></ol>
612 <ol><p>A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.</p></ol>
615 <ol><p>Numeric value to substitute into format filename.</p></ol>
618 <ol><p>return the formatted filename in this character buffer.</p></ol>
621 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
622 _8c.html" target="source" name="IsHighDynamicRangeImage">IsHighDynamicRangeImage</a></h2>
623 <div class="doc-section">
625 <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>
627 <p>The format of the IsHighDynamicRangeImage method is:</p>
630 MagickBooleanType IsHighDynamicRangeImage(const Image *image,
631 ExceptionInfo *exception)
634 <p>A description of each parameter follows:</p></ol>
637 <ol><p>the image.</p></ol>
640 <ol><p>return any errors or warnings in this structure.</p></ol>
643 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
644 _8c.html" target="source" name="IsImageObject">IsImageObject</a></h2>
645 <div class="doc-section">
647 <p>IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.</p></ol>
649 <p>The format of the IsImageObject method is:</p>
652 MagickBooleanType IsImageObject(const Image *image)
655 <p>A description of each parameter follows:</p></ol>
658 <ol><p>the image.</p></ol>
661 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
662 _8c.html" target="source" name="IsTaintImage">IsTaintImage</a></h2>
663 <div class="doc-section">
665 <p>IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.</p></ol>
667 <p>The format of the IsTaintImage method is:</p>
670 MagickBooleanType IsTaintImage(const Image *image)
673 <p>A description of each parameter follows:</p></ol>
676 <ol><p>the image.</p></ol>
679 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
680 _8c.html" target="source" name="ModifyImage">ModifyImage</a></h2>
681 <div class="doc-section">
683 <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>
685 <p>The format of the ModifyImage method is:</p>
688 MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
691 <p>A description of each parameter follows:</p></ol>
694 <ol><p>the image.</p></ol>
697 <ol><p>return any errors or warnings in this structure.</p></ol>
700 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
701 _8c.html" target="source" name="NewMagickImage">NewMagickImage</a></h2>
702 <div class="doc-section">
704 <p>NewMagickImage() creates a blank image canvas of the specified size and background color.</p></ol>
706 <p>The format of the NewMagickImage method is:</p>
709 Image *NewMagickImage(const ImageInfo *image_info,
710 const unsigned long width,const unsigned long height,
711 const MagickPixelPacket *background)
714 <p>A description of each parameter follows:</p></ol>
717 <ol><p>the image.</p></ol>
720 <ol><p>the image width.</p></ol>
723 <ol><p>the image height.</p></ol>
726 <ol><p>the image color.</p></ol>
729 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
730 _8c.html" target="source" name="ReferenceImage">ReferenceImage</a></h2>
731 <div class="doc-section">
733 <p>ReferenceImage() increments the reference count associated with an image returning a pointer to the image.</p></ol>
735 <p>The format of the ReferenceImage method is:</p>
738 Image *ReferenceImage(Image *image)
741 <p>A description of each parameter follows:</p></ol>
744 <ol><p>the image.</p></ol>
747 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
748 _8c.html" target="source" name="ResetImagePage">ResetImagePage</a></h2>
749 <div class="doc-section">
751 <p>ResetImagePage() resets the image page canvas and position.</p></ol>
753 <p>The format of the ResetImagePage method is:</p>
756 MagickBooleanType ResetImagePage(Image *image,const char *page)
759 <p>A description of each parameter follows:</p></ol>
762 <ol><p>the image.</p></ol>
765 <ol><p>the relative page specification.</p></ol>
768 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
769 _8c.html" target="source" name="SeparateImageChannel">SeparateImageChannel</a></h2>
770 <div class="doc-section">
772 <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>
774 <p>The format of the SeparateImageChannel method is:</p>
777 MagickBooleanType SeparateImageChannel(Image *image,
778 const ChannelType channel)
781 <p>A description of each parameter follows:</p></ol>
784 <ol><p>the image.</p></ol>
787 <ol><p>Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
790 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
791 _8c.html" target="source" name="SeparateImages">SeparateImages</a></h2>
792 <div class="doc-section">
794 <p>SeparateImages() returns a separate grayscale image for each channel specified.</p></ol>
796 <p>The format of the SeparateImages method is:</p>
799 MagickBooleanType SeparateImages(const Image *image,
800 const ChannelType channel,ExceptionInfo *exception)
803 <p>A description of each parameter follows:</p></ol>
806 <ol><p>the image.</p></ol>
809 <ol><p>Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
812 <ol><p>return any errors or warnings in this structure.</p></ol>
815 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
816 _8c.html" target="source" name="SetImageAlphaChannel">SetImageAlphaChannel</a></h2>
817 <div class="doc-section">
819 <p>SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p></ol>
821 <p>The format of the SetImageAlphaChannel method is:</p>
824 MagickBooleanType SetImageAlphaChannel(Image *image,
825 const AlphaChannelType alpha_type)
828 <p>A description of each parameter follows:</p></ol>
831 <ol><p>the image.</p></ol>
834 <ol><p>The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.</p></ol>
837 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
838 _8c.html" target="source" name="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></ol>
843 <p>The format of the SetImage method is:</p>
846 MagickBooleanType SetImageBackgroundColor(Image *image)
849 <p>A description of each parameter follows:</p></ol>
852 <ol><p>the image.</p></ol>
855 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
856 _8c.html" target="source" name="SetImageStorageClass">SetImageStorageClass</a></h2>
857 <div class="doc-section">
859 <p>SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.</p></ol>
861 <p>The format of the SetImageStorageClass method is:</p>
864 MagickBooleanType SetImageStorageClass(Image *image,
865 const ClassType storage_class)
868 <p>A description of each parameter follows:</p></ol>
871 <ol><p>the image.</p></ol>
873 <h5>storage_class</h5>
874 <ol><p>The image class.</p></ol>
877 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
878 _8c.html" target="source" name="SetImageClipMask">SetImageClipMask</a></h2>
879 <div class="doc-section">
881 <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>
883 <p>The format of the SetImageClipMask method is:</p>
886 MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
889 <p>A description of each parameter follows:</p></ol>
892 <ol><p>the image.</p></ol>
895 <ol><p>the image clip path.</p></ol>
898 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
899 _8c.html" target="source" name="SetImageExtent">SetImageExtent</a></h2>
900 <div class="doc-section">
902 <p>SetImageExtent() sets the image size (i.e. columns & rows).</p></ol>
904 <p>The format of the SetImageExtent method is:</p>
907 MagickBooleanType SetImageExtent(Image *image,
908 const unsigned long columns,const unsigned long rows)
911 <p>A description of each parameter follows:</p></ol>
914 <ol><p>the image.</p></ol>
917 <ol><p>The image width in pixels.</p></ol>
920 <ol><p>The image height in pixels.</p></ol>
923 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
924 _8c.html" target="source" name="SetImageInfoBlob">SetImageInfoBlob</a></h2>
925 <div class="doc-section">
927 <p>SetImageInfoBlob() sets the image info blob member.</p></ol>
929 <p>The format of the SetImageInfoBlob method is:</p>
932 void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
936 <p>A description of each parameter follows:</p></ol>
939 <ol><p>the image info.</p></ol>
942 <ol><p>the blob.</p></ol>
945 <ol><p>the blob length.</p></ol>
948 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
949 _8c.html" target="source" name="SetImageInfoFile">SetImageInfoFile</a></h2>
950 <div class="doc-section">
952 <p>SetImageInfoFile() sets the image info file member.</p></ol>
954 <p>The format of the SetImageInfoFile method is:</p>
957 void SetImageInfoFile(ImageInfo *image_info,FILE *file)
960 <p>A description of each parameter follows:</p></ol>
963 <ol><p>the image info.</p></ol>
966 <ol><p>the file.</p></ol>
969 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
970 _8c.html" target="source" name="SetImageMask">SetImageMask</a></h2>
971 <div class="doc-section">
973 <p>SetImageMask() associates a mask with the image. The mask must be the same dimensions as the image.</p></ol>
975 <p>The format of the SetImageMask method is:</p>
978 MagickBooleanType SetImageMask(Image *image,const Image *mask)
981 <p>A description of each parameter follows:</p></ol>
984 <ol><p>the image.</p></ol>
987 <ol><p>the image mask.</p></ol>
990 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
991 _8c.html" target="source" name="SetImageOpacity">SetImageOpacity</a></h2>
992 <div class="doc-section">
994 <p>SetImageOpacity() sets the opacity levels of the image.</p></ol>
996 <p>The format of the SetImageOpacity method is:</p>
999 MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
1002 <p>A description of each parameter follows:</p></ol>
1005 <ol><p>the image.</p></ol>
1008 <ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
1011 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
1012 _8c.html" target="source" name="SetImageType">SetImageType</a></h2>
1013 <div class="doc-section">
1015 <p>SetImageType() sets the type of image. Choose from these types:</p></ol>
1017 <p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte OptimizeType</p></ol>
1019 <p>The format of the SetImageType method is:</p>
1022 MagickBooleanType SetImageType(Image *image,const ImageType type)
1025 <p>A description of each parameter follows:</p></ol>
1028 <ol><p>the image.</p></ol>
1031 <ol><p>Image type.</p></ol>
1034 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
1035 _8c.html" target="source" name="SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a></h2>
1036 <div class="doc-section">
1038 <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>
1040 <p>The format of the SetImageVirtualPixelMethod() method is:</p>
1043 VirtualPixelMethod SetImageVirtualPixelMethod(const Image *image,
1044 const VirtualPixelMethod virtual_pixel_method)
1047 <p>A description of each parameter follows:</p></ol>
1050 <ol><p>the image.</p></ol>
1052 <h5>virtual_pixel_method</h5>
1053 <ol><p>choose the type of virtual pixel.</p></ol>
1056 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
1057 _8c.html" target="source" name="StripImage">StripImage</a></h2>
1058 <div class="doc-section">
1060 <p>StripImage() strips an image of all profiles and comments.</p></ol>
1062 <p>The format of the StripImage method is:</p>
1065 MagickBooleanType StripImage(Image *image)
1068 <p>A description of each parameter follows:</p></ol>
1071 <ol><p>the image.</p></ol>
1074 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
1075 _8c.html" target="source" name="TextureImage">TextureImage</a></h2>
1076 <div class="doc-section">
1078 <p>TextureImage() repeatedly tiles the texture image across and down the image canvas.</p></ol>
1080 <p>The format of the TextureImage method is:</p>
1083 MagickBooleanType TextureImage(Image *image,const Image *texture)
1086 <p>A description of each parameter follows:</p></ol>
1089 <ol><p>the image.</p></ol>
1092 <ol><p>This image is the texture to layer on the background.</p></ol>
1098 <div id="linkbar">
\r
1099 <!-- <span id="linkbar-west"> </span> -->
\r
1100 <span id="linkbar-center">
\r
1101 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
1102 <a href="../../www/mailing-list.html">Mailing Lists</a> •
\r
1103 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
1105 <span id="linkbar-east"> </span>
\r
1107 <div class="footer">
\r
1108 <span id="footer-west">© 1999-2009 ImageMagick Studio LLC</span>
\r
1109 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
1111 <div style="clear: both; margin: 0; width: 100%; "></div>
\r