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" dir="ltr">
\r
5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
\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="all">
\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-2010 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 title="About ImageMagick" href="../../index.html">About ImageMagick</a>
50 <div class="sep"></div>
\r
52 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
63 <div class="sep"></div>
\r
65 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
68 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
71 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
77 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
80 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
83 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
86 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
89 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
91 <div class="sep"></div>
\r
93 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
96 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
99 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
102 <a title="Resources" href="../../www/resources.html">Resources</a>
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
108 <a title="Download" href="../../www/download.html">Download</a>
110 <div class="sep"></div>
\r
112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
114 <div class="sep"></div>
\r
116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
121 <div class="sep"></div>
\r
123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
125 <div class="sponsbox">
126 <div class="sponsor">
127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
129 <div class="sponsor">
130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
132 <div class="sponsor">
133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
135 <div class="sponsor">
136 <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
138 <div class="sponsor">
139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
141 <div class="sponsor">
142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
144 <div class="sponsor">
145 <a title="Sponsor: Lampe Berger" href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
155 <p class="navigation-index">[<a href="#AcquireImage">AcquireImage</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="#GetImageInfoFile">GetImageInfoFile</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="#SetImageColor">SetImageColor</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>
157 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
158 _8c.html" target="source" name="AcquireImage">AcquireImage</a></h2>
159 <div class="doc-section">
161 <p>AcquireImage() returns a pointer to an image structure initialized to default values.</p></ol>
163 <p>The format of the AcquireImage method is:</p>
166 Image *AcquireImage(const ImageInfo *image_info)
169 <p>A description of each parameter follows:</p></ol>
172 <ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
175 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
176 _8c.html" target="source" name="AcquireImageInfo">AcquireImageInfo</a></h2>
177 <div class="doc-section">
179 <p>AcquireImageInfo() allocates the ImageInfo structure.</p></ol>
181 <p>The format of the AcquireImageInfo method is:</p>
184 ImageInfo *AcquireImageInfo(void)
188 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
189 _8c.html" target="source" name="AcquireNextImage">AcquireNextImage</a></h2>
190 <div class="doc-section">
192 <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>
194 <p>The format of the AcquireNextImage method is:</p>
197 void AcquireNextImage(const ImageInfo *image_info,Image *image)
200 <p>A description of each parameter follows:</p></ol>
203 <ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
206 <ol><p>the image.</p></ol>
209 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
210 _8c.html" target="source" name="AppendImages">AppendImages</a></h2>
211 <div class="doc-section">
213 <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>
215 <p>The current gravity setting now effects how the image is justified in the final image.</p></ol>
217 <p>The format of the AppendImages method is:</p>
220 Image *AppendImages(const Image *image,const MagickBooleanType stack,
221 ExceptionInfo *exception)
224 <p>A description of each parameter follows:</p></ol>
227 <ol><p>the image sequence.</p></ol>
230 <ol><p>A value other than 0 stacks the images top-to-bottom.</p></ol>
233 <ol><p>return any errors or warnings in this structure.</p></ol>
236 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
237 _8c.html" target="source" name="CatchImageException">CatchImageException</a></h2>
238 <div class="doc-section">
240 <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>
242 <p>The format of the CatchImageException method is:</p>
245 ExceptionType CatchImageException(Image *image)
248 <p>A description of each parameter follows:</p></ol>
251 <ol><p>An image sequence.</p></ol>
254 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
255 _8c.html" target="source" name="ClipImagePath">ClipImagePath</a></h2>
256 <div class="doc-section">
258 <p>ClipImagePath() sets the image clip mask based any clipping path information if it exists.</p></ol>
260 <p>The format of the ClipImagePath method is:</p>
263 MagickBooleanType ClipImagePath(Image *image,const char *pathname,
264 const MagickBooleanType inside)
267 <p>A description of each parameter follows:</p></ol>
270 <ol><p>the image.</p></ol>
273 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
276 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
279 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
280 _8c.html" target="source" name="CloneImage">CloneImage</a></h2>
281 <div class="doc-section">
283 <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>
285 <p>The format of the CloneImage method is:</p>
288 Image *CloneImage(const Image *image,const size_t columns,
289 const size_t rows,const MagickBooleanType orphan,
290 ExceptionInfo *exception)
293 <p>A description of each parameter follows:</p></ol>
296 <ol><p>the image.</p></ol>
299 <ol><p>the number of columns in the cloned image.</p></ol>
302 <ol><p>the number of rows in the cloned image.</p></ol>
305 <ol><p>With a value other than 0, the cloned image is detached from its parent I/O stream.</p></ol>
308 <ol><p>return any errors or warnings in this structure.</p></ol>
311 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
312 _8c.html" target="source" name="CloneImageInfo">CloneImageInfo</a></h2>
313 <div class="doc-section">
315 <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>
317 <p>The format of the CloneImageInfo method is:</p>
320 ImageInfo *CloneImageInfo(const ImageInfo *image_info)
323 <p>A description of each parameter follows:</p></ol>
326 <ol><p>the image info.</p></ol>
329 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
330 _8c.html" target="source" name="CombineImages">CombineImages</a></h2>
331 <div class="doc-section">
333 <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>
335 <p>The format of the CombineImages method is:</p>
338 Image *CombineImages(const Image *image,const ChannelType channel,
339 ExceptionInfo *exception)
342 <p>A description of each parameter follows:</p></ol>
345 <ol><p>the image.</p></ol>
348 <ol><p>return any errors or warnings in this structure.</p></ol>
351 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
352 _8c.html" target="source" name="DestroyImage">DestroyImage</a></h2>
353 <div class="doc-section">
355 <p>DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p></ol>
357 <p>The format of the DestroyImage method is:</p>
360 Image *DestroyImage(Image *image)
363 <p>A description of each parameter follows:</p></ol>
366 <ol><p>the image.</p></ol>
369 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
370 _8c.html" target="source" name="DestroyImageInfo">DestroyImageInfo</a></h2>
371 <div class="doc-section">
373 <p>DestroyImageInfo() deallocates memory associated with an ImageInfo structure.</p></ol>
375 <p>The format of the DestroyImageInfo method is:</p>
378 ImageInfo *DestroyImageInfo(ImageInfo *image_info)
381 <p>A description of each parameter follows:</p></ol>
384 <ol><p>the image info.</p></ol>
387 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
388 _8c.html" target="source" name="GetImageAlphaChannel">GetImageAlphaChannel</a></h2>
389 <div class="doc-section">
391 <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>
393 <p>The format of the GetImageAlphaChannel method is:</p>
396 MagickBooleanType GetImageAlphaChannel(const Image *image)
399 <p>A description of each parameter follows:</p></ol>
402 <ol><p>the image.</p></ol>
405 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
406 _8c.html" target="source" name="GetImageClipMask">GetImageClipMask</a></h2>
407 <div class="doc-section">
409 <p>GetImageClipMask() returns the clip path associated with the image.</p></ol>
411 <p>The format of the GetImageClipMask method is:</p>
414 Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
417 <p>A description of each parameter follows:</p></ol>
420 <ol><p>the image.</p></ol>
423 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
424 _8c.html" target="source" name="GetImageException">GetImageException</a></h2>
425 <div class="doc-section">
427 <p>GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.</p></ol>
429 <p>The format of the GetImageException method is:</p>
432 void GetImageException(Image *image,ExceptionInfo *exception)
435 <p>A description of each parameter follows:</p></ol>
438 <ol><p>Specifies a pointer to a list of one or more images.</p></ol>
441 <ol><p>return the highest severity exception.</p></ol>
444 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
445 _8c.html" target="source" name="GetImageInfo">GetImageInfo</a></h2>
446 <div class="doc-section">
448 <p>GetImageInfo() initializes image_info to default values.</p></ol>
450 <p>The format of the GetImageInfo method is:</p>
453 void GetImageInfo(ImageInfo *image_info)
456 <p>A description of each parameter follows:</p></ol>
459 <ol><p>the image info.</p></ol>
462 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
463 _8c.html" target="source" name="GetImageInfoFile">GetImageInfoFile</a></h2>
464 <div class="doc-section">
466 <p>GetImageInfoFile() returns the image info file member.</p></ol>
468 <p>The format of the GetImageInfoFile method is:</p>
471 FILE *GetImageInfoFile(const ImageInfo *image_info)
474 <p>A description of each parameter follows:</p></ol>
477 <ol><p>the image info.</p></ol>
480 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
481 _8c.html" target="source" name="GetImageMask">GetImageMask</a></h2>
482 <div class="doc-section">
484 <p>GetImageMask() returns the mask associated with the image.</p></ol>
486 <p>The format of the GetImageMask method is:</p>
489 Image *GetImageMask(const Image *image,ExceptionInfo *exception)
492 <p>A description of each parameter follows:</p></ol>
495 <ol><p>the image.</p></ol>
498 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
499 _8c.html" target="source" name="GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a></h2>
500 <div class="doc-section">
502 <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>
504 <p>The format of the GetImageVirtualPixelMethod() method is:</p>
507 VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
510 <p>A description of each parameter follows:</p></ol>
513 <ol><p>the image.</p></ol>
516 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
517 _8c.html" target="source" name="InterpretImageFilename">InterpretImageFilename</a></h2>
518 <div class="doc-section">
520 <p>InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.</p></ol>
522 <p>The format of the InterpretImageFilename method is:</p>
525 size_t InterpretImageFilename(const ImageInfo *image_info,
526 Image *image,const char *format,int value,char *filename)
529 <p>A description of each parameter follows.</p></ol>
532 <ol><p>the image info..</p></ol>
535 <ol><p>the image.</p></ol>
538 <ol><p>A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.</p></ol>
541 <ol><p>Numeric value to substitute into format filename.</p></ol>
544 <ol><p>return the formatted filename in this character buffer.</p></ol>
547 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
548 _8c.html" target="source" name="IsHighDynamicRangeImage">IsHighDynamicRangeImage</a></h2>
549 <div class="doc-section">
551 <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>
553 <p>The format of the IsHighDynamicRangeImage method is:</p>
556 MagickBooleanType IsHighDynamicRangeImage(const Image *image,
557 ExceptionInfo *exception)
560 <p>A description of each parameter follows:</p></ol>
563 <ol><p>the image.</p></ol>
566 <ol><p>return any errors or warnings in this structure.</p></ol>
569 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
570 _8c.html" target="source" name="IsImageObject">IsImageObject</a></h2>
571 <div class="doc-section">
573 <p>IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.</p></ol>
575 <p>The format of the IsImageObject method is:</p>
578 MagickBooleanType IsImageObject(const Image *image)
581 <p>A description of each parameter follows:</p></ol>
584 <ol><p>the image.</p></ol>
587 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
588 _8c.html" target="source" name="IsTaintImage">IsTaintImage</a></h2>
589 <div class="doc-section">
591 <p>IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.</p></ol>
593 <p>The format of the IsTaintImage method is:</p>
596 MagickBooleanType IsTaintImage(const Image *image)
599 <p>A description of each parameter follows:</p></ol>
602 <ol><p>the image.</p></ol>
605 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
606 _8c.html" target="source" name="ModifyImage">ModifyImage</a></h2>
607 <div class="doc-section">
609 <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>
611 <p>The format of the ModifyImage method is:</p>
614 MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
617 <p>A description of each parameter follows:</p></ol>
620 <ol><p>the image.</p></ol>
623 <ol><p>return any errors or warnings in this structure.</p></ol>
626 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
627 _8c.html" target="source" name="NewMagickImage">NewMagickImage</a></h2>
628 <div class="doc-section">
630 <p>NewMagickImage() creates a blank image canvas of the specified size and background color.</p></ol>
632 <p>The format of the NewMagickImage method is:</p>
635 Image *NewMagickImage(const ImageInfo *image_info,
636 const size_t width,const size_t height,
637 const MagickPixelPacket *background)
640 <p>A description of each parameter follows:</p></ol>
643 <ol><p>the image.</p></ol>
646 <ol><p>the image width.</p></ol>
649 <ol><p>the image height.</p></ol>
652 <ol><p>the image color.</p></ol>
655 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
656 _8c.html" target="source" name="ReferenceImage">ReferenceImage</a></h2>
657 <div class="doc-section">
659 <p>ReferenceImage() increments the reference count associated with an image returning a pointer to the image.</p></ol>
661 <p>The format of the ReferenceImage method is:</p>
664 Image *ReferenceImage(Image *image)
667 <p>A description of each parameter follows:</p></ol>
670 <ol><p>the image.</p></ol>
673 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
674 _8c.html" target="source" name="ResetImagePage">ResetImagePage</a></h2>
675 <div class="doc-section">
677 <p>ResetImagePage() resets the image page canvas and position.</p></ol>
679 <p>The format of the ResetImagePage method is:</p>
682 MagickBooleanType ResetImagePage(Image *image,const char *page)
685 <p>A description of each parameter follows:</p></ol>
688 <ol><p>the image.</p></ol>
691 <ol><p>the relative page specification.</p></ol>
694 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
695 _8c.html" target="source" name="SeparateImageChannel">SeparateImageChannel</a></h2>
696 <div class="doc-section">
698 <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>
700 <p>The format of the SeparateImageChannel method is:</p>
703 MagickBooleanType SeparateImageChannel(Image *image,
704 const ChannelType channel)
707 <p>A description of each parameter follows:</p></ol>
710 <ol><p>the image.</p></ol>
713 <ol><p>Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
716 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
717 _8c.html" target="source" name="SeparateImages">SeparateImages</a></h2>
718 <div class="doc-section">
720 <p>SeparateImages() returns a separate grayscale image for each channel specified.</p></ol>
722 <p>The format of the SeparateImages method is:</p>
725 MagickBooleanType SeparateImages(const Image *image,
726 const ChannelType channel,ExceptionInfo *exception)
729 <p>A description of each parameter follows:</p></ol>
732 <ol><p>the image.</p></ol>
735 <ol><p>Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
738 <ol><p>return any errors or warnings in this structure.</p></ol>
741 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
742 _8c.html" target="source" name="SetImageAlphaChannel">SetImageAlphaChannel</a></h2>
743 <div class="doc-section">
745 <p>SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p></ol>
747 <p>The format of the SetImageAlphaChannel method is:</p>
750 MagickBooleanType SetImageAlphaChannel(Image *image,
751 const AlphaChannelType alpha_type)
754 <p>A description of each parameter follows:</p></ol>
757 <ol><p>the image.</p></ol>
760 <ol><p>The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.</p></ol>
763 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
764 _8c.html" target="source" name="SetImageBackgroundColor">SetImageBackgroundColor</a></h2>
765 <div class="doc-section">
767 <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>
769 <p>The format of the SetImage method is:</p>
772 MagickBooleanType SetImageBackgroundColor(Image *image)
775 <p>A description of each parameter follows:</p></ol>
778 <ol><p>the image.</p></ol>
781 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
782 _8c.html" target="source" name="SetImageColor">SetImageColor</a></h2>
783 <div class="doc-section">
785 <p>SetImageColor() set the entire image canvas to the specified color.</p></ol>
787 <p>The format of the SetImageColor method is:</p>
790 MagickBooleanType SetImageColor(Image *image,
791 const MagickPixelPacket *color)
794 <p>A description of each parameter follows:</p></ol>
797 <ol><p>the image.</p></ol>
800 <ol><p>the image color.</p></ol>
803 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
804 _8c.html" target="source" name="SetImageStorageClass">SetImageStorageClass</a></h2>
805 <div class="doc-section">
807 <p>SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.</p></ol>
809 <p>The format of the SetImageStorageClass method is:</p>
812 MagickBooleanType SetImageStorageClass(Image *image,
813 const ClassType storage_class)
816 <p>A description of each parameter follows:</p></ol>
819 <ol><p>the image.</p></ol>
821 <h5>storage_class</h5>
822 <ol><p>The image class.</p></ol>
825 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
826 _8c.html" target="source" name="SetImageClipMask">SetImageClipMask</a></h2>
827 <div class="doc-section">
829 <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>
831 <p>The format of the SetImageClipMask method is:</p>
834 MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
837 <p>A description of each parameter follows:</p></ol>
840 <ol><p>the image.</p></ol>
843 <ol><p>the image clip path.</p></ol>
846 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
847 _8c.html" target="source" name="SetImageExtent">SetImageExtent</a></h2>
848 <div class="doc-section">
850 <p>SetImageExtent() sets the image size (i.e. columns & rows).</p></ol>
852 <p>The format of the SetImageExtent method is:</p>
855 MagickBooleanType SetImageExtent(Image *image,
856 const size_t columns,const size_t rows)
859 <p>A description of each parameter follows:</p></ol>
862 <ol><p>the image.</p></ol>
865 <ol><p>The image width in pixels.</p></ol>
868 <ol><p>The image height in pixels.</p></ol>
871 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
872 _8c.html" target="source" name="SetImageInfoBlob">SetImageInfoBlob</a></h2>
873 <div class="doc-section">
875 <p>SetImageInfoBlob() sets the image info blob member.</p></ol>
877 <p>The format of the SetImageInfoBlob method is:</p>
880 void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
884 <p>A description of each parameter follows:</p></ol>
887 <ol><p>the image info.</p></ol>
890 <ol><p>the blob.</p></ol>
893 <ol><p>the blob length.</p></ol>
896 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
897 _8c.html" target="source" name="SetImageInfoFile">SetImageInfoFile</a></h2>
898 <div class="doc-section">
900 <p>SetImageInfoFile() sets the image info file member.</p></ol>
902 <p>The format of the SetImageInfoFile method is:</p>
905 void SetImageInfoFile(ImageInfo *image_info,FILE *file)
908 <p>A description of each parameter follows:</p></ol>
911 <ol><p>the image info.</p></ol>
914 <ol><p>the file.</p></ol>
917 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
918 _8c.html" target="source" name="SetImageMask">SetImageMask</a></h2>
919 <div class="doc-section">
921 <p>SetImageMask() associates a mask with the image. The mask must be the same dimensions as the image.</p></ol>
923 <p>The format of the SetImageMask method is:</p>
926 MagickBooleanType SetImageMask(Image *image,const Image *mask)
929 <p>A description of each parameter follows:</p></ol>
932 <ol><p>the image.</p></ol>
935 <ol><p>the image mask.</p></ol>
938 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
939 _8c.html" target="source" name="SetImageOpacity">SetImageOpacity</a></h2>
940 <div class="doc-section">
942 <p>SetImageOpacity() sets the opacity levels of the image.</p></ol>
944 <p>The format of the SetImageOpacity method is:</p>
947 MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
950 <p>A description of each parameter follows:</p></ol>
953 <ol><p>the image.</p></ol>
956 <ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
959 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
960 _8c.html" target="source" name="SetImageType">SetImageType</a></h2>
961 <div class="doc-section">
963 <p>SetImageType() sets the type of image. Choose from these types:</p></ol>
965 <p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte OptimizeType</p></ol>
967 <p>The format of the SetImageType method is:</p>
970 MagickBooleanType SetImageType(Image *image,const ImageType type)
973 <p>A description of each parameter follows:</p></ol>
976 <ol><p>the image.</p></ol>
979 <ol><p>Image type.</p></ol>
982 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
983 _8c.html" target="source" name="SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a></h2>
984 <div class="doc-section">
986 <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>
988 <p>The format of the SetImageVirtualPixelMethod() method is:</p>
991 VirtualPixelMethod SetImageVirtualPixelMethod(const Image *image,
992 const VirtualPixelMethod virtual_pixel_method)
995 <p>A description of each parameter follows:</p></ol>
998 <ol><p>the image.</p></ol>
1000 <h5>virtual_pixel_method</h5>
1001 <ol><p>choose the type of virtual pixel.</p></ol>
1004 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
1005 _8c.html" target="source" name="StripImage">StripImage</a></h2>
1006 <div class="doc-section">
1008 <p>StripImage() strips an image of all profiles and comments.</p></ol>
1010 <p>The format of the StripImage method is:</p>
1013 MagickBooleanType StripImage(Image *image)
1016 <p>A description of each parameter follows:</p></ol>
1019 <ol><p>the image.</p></ol>
1022 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
1023 _8c.html" target="source" name="SyncImageSettings">SyncImageSettings</a></h2>
1024 <div class="doc-section">
1026 <p>SyncImageSettings() sync the image info options to the image.</p></ol>
1028 <p>The format of the SyncImageSettings method is:</p>
1031 MagickBooleanType SyncImageSettings(const ImageInfo *image_info,
1033 MagickBooleanType SyncImagesSettings(const ImageInfo *image_info,
1037 <p>A description of each parameter follows:</p></ol>
1040 <ol><p>the image info.</p></ol>
1043 <ol><p>the image.</p></ol>
1049 <div id="linkbar">
\r
1050 <!-- <span id="linkbar-west"> </span> -->
\r
1051 <span id="linkbar-center">
\r
1052 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
1053 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
1055 <span id="linkbar-east"> </span>
\r
1057 <div class="footer">
\r
1058 <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
\r
1059 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
1061 <div style="clear: both; margin: 0; width: 100%; "></div>
\r