]> granicus.if.org Git - imagemagick/blob - www/api/image.html
(no commit message)
[imagemagick] / www / api / image.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.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
4 <head>\r
5   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
7   <title>ImageMagick: MagickCore, C API for ImageMagick: Image Methods</title/>
8   <meta http-equiv="Content-Language" content="en-US"/>
9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
11   <meta name="Application-name" content="ImageMagick"/>
12   <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."/>
13   <meta name="Application-url" content="http://www.imagemagick.org"/>
14   <meta name="Generator" content="PHP"/>
15   <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"/>
16   <meta name="Rating" content="GENERAL"/>
17   <meta name="Robots" content="INDEX, FOLLOW"/>
18   <meta name="Generator" content="ImageMagick Studio LLC"/>
19   <meta name="Author" content="ImageMagick Studio LLC"/>
20   <meta name="Revisit-after" content="2 DAYS"/>
21   <meta name="Resource-type" content="document"/>
22   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
23   <meta name="Distribution" content="Global"/>
24   <link rel="icon" href="../../images/wand.png"  sizes="32x32"/>
25   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
26   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
27   <style type="text/css" media="all">\r
28     @import url("../../www/magick.css");\r
29   </style>\r
30 </head>\r
31 \r
32 <body id="www-imagemagick-org">\r
33 <div class="titlebar">\r
34 <a href="../../index.html">\r
35   <img src="../../images/script.png" alt="[ImageMagick]"\r
36   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
37 <a href="http://www.networkredux.com">\r
38   <img src="../../images/networkredux.png" alt="[sponsor]"\r
39   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
40 <a href="http://www.imagemagick.org/discourse-server/">\r
41   <img src="../../images/logo.jpg" alt=""\r
42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
43 <a href="../../index.html">\r
44   <img src="../../images/sprite.jpg" alt=""\r
45   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
46 </div>\r
47 \r
48 <div class="westbar">\r
49 \r
50 <div class="menu">
51   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
52 </div>
53 <div class="sep"></div>\r
54 <div class="menu">
55   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56 </div>
57 <div class="sub">
58     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59 </div>
60 <div class="sub">
61     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62 </div>
63 <div class="sub">
64     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65 </div>
66 <div class="sep"></div>\r
67 <div class="menu">
68   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
69 </div>
70 <div class="sub">
71     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
72 </div>
73 <div class="sub">
74     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
75 </div>
76 <div class="sub">
77     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
78 </div>
79 <div class="menu">
80   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
81 </div>
82 <div class="sub">
83     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
84 </div>
85 <div class="sub">
86     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
87 </div>
88 <div class="sub">
89     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
90 </div>
91 <div class="sub">
92     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
93 </div>
94 <div class="sep"></div>\r
95 <div  class="menu">
96    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
97 </div>
98 <div class="sub">
99     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
100 </div>
101 <div class="sub">
102     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
103  </div>
104 <div class="menu">
105   <a title="Resources" href="../../www/resources.html">Resources</a>
106 </div>
107 <div class="menu">
108   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109 </div>
110 <div class="menu">
111   <a title="Download" href="../../www/download.html">Download</a>
112 </div>
113 <div class="sep"></div>\r
114 <div class="menu">
115   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
116 </div>
117 <div class="sep"></div>\r
118 <div class="menu">
119   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
120 </div>
121 <div  class="sub">
122     <a title="Site Map: Links"href="../../www/links.html">Links</a>
123 </div>
124 <div class="sep"></div>\r
125 <div  class="menu">
126   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
127
128 <div class="sponsbox">
129 <div  class="sponsor">
130    <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
131 </div>
132 <div  class="sponsor">
133   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
134 </div>
135 <div  class="sponsor">
136   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137 </div>
138 <div  class="sponsor">
139   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140 </div>
141 <div  class="sponsor">
142   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
143 </div>
144 <div  class="sponsor">
145   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
146 </div>
147 <div  class="sponsor">
148   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
149 </div>
150 <div  class="sponsor">
151    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
152 </div>
153 </div>
154 </div>
155 </div>\r
156 \r
157 <div class="eastbar">\r
158   <script type="text/javascript">\r
159   <!--\r
160     google_ad_client = "pub-3129977114552745";\r
161     google_ad_slot = "0574824969";\r
162     google_ad_width = 160;\r
163     google_ad_height = 600;\r
164   //-->\r
165   </script>\r
166   <script type="text/javascript"\r
167     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
168   </script>\r
169 </div>\r
170 \r
171 <div class="main">\r
172 \r
173 <p class="navigation-index">[<a href="#AcquireImage">AcquireImage</a> &bull; <a href="#AcquireImageInfo">AcquireImageInfo</a> &bull; <a href="#AcquireNextImage">AcquireNextImage</a> &bull; <a href="#AppendImages">AppendImages</a> &bull; <a href="#CatchImageException">CatchImageException</a> &bull; <a href="#ClipImagePath">ClipImagePath</a> &bull; <a href="#CloneImage">CloneImage</a> &bull; <a href="#CloneImageInfo">CloneImageInfo</a> &bull; <a href="#CombineImages">CombineImages</a> &bull; <a href="#DestroyImage">DestroyImage</a> &bull; <a href="#DestroyImageInfo">DestroyImageInfo</a> &bull; <a href="#GetImageAlphaChannel">GetImageAlphaChannel</a> &bull; <a href="#GetImageClipMask">GetImageClipMask</a> &bull; <a href="#GetImageException">GetImageException</a> &bull; <a href="#GetImageInfo">GetImageInfo</a> &bull; <a href="#GetImageInfoFile">GetImageInfoFile</a> &bull; <a href="#GetImageMask">GetImageMask</a> &bull; <a href="#GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a> &bull; <a href="#InterpretImageFilename">InterpretImageFilename</a> &bull; <a href="#IsHighDynamicRangeImage">IsHighDynamicRangeImage</a> &bull; <a href="#IsImageObject">IsImageObject</a> &bull; <a href="#IsTaintImage">IsTaintImage</a> &bull; <a href="#ModifyImage">ModifyImage</a> &bull; <a href="#NewMagickImage">NewMagickImage</a> &bull; <a href="#ReferenceImage">ReferenceImage</a> &bull; <a href="#ResetImagePage">ResetImagePage</a> &bull; <a href="#SeparateImageChannel">SeparateImageChannel</a> &bull; <a href="#SeparateImages">SeparateImages</a> &bull; <a href="#SetImageAlphaChannel">SetImageAlphaChannel</a> &bull; <a href="#SetImageBackgroundColor">SetImageBackgroundColor</a> &bull; <a href="#SetImageColor">SetImageColor</a> &bull; <a href="#SetImageStorageClass">SetImageStorageClass</a> &bull; <a href="#SetImageClipMask">SetImageClipMask</a> &bull; <a href="#SetImageExtent">SetImageExtent</a> &bull; <a href="#SetImageInfoBlob">SetImageInfoBlob</a> &bull; <a href="#SetImageInfoFile">SetImageInfoFile</a> &bull; <a href="#SetImageMask">SetImageMask</a> &bull; <a href="#SetImageOpacity">SetImageOpacity</a> &bull; <a href="#SetImageType">SetImageType</a> &bull; <a href="#SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a> &bull; <a href="#StripImage">StripImage</a> &bull; <a href="#SyncImageSettings">SyncImageSettings</a>]</p>
174
175 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
176 _8c.html" target="source" name="AcquireImage">AcquireImage</a></h2>
177 <div class="doc-section">
178
179 <p>AcquireImage() returns a pointer to an image structure initialized to default values.</p></ol>
180
181 <p>The format of the AcquireImage method is:</p>
182
183 <pre class="code">
184   Image *AcquireImage(const ImageInfo *image_info)
185 </pre>
186
187 <p>A description of each parameter follows:</p></ol>
188
189 <h5>image_info</h5>
190 <ol><p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p></ol>
191
192  </div>
193 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
194 _8c.html" target="source" name="AcquireImageInfo">AcquireImageInfo</a></h2>
195 <div class="doc-section">
196
197 <p>AcquireImageInfo() allocates the ImageInfo structure.</p></ol>
198
199 <p>The format of the AcquireImageInfo method is:</p>
200
201 <pre class="code">
202   ImageInfo *AcquireImageInfo(void)
203 </pre>
204
205  </div>
206 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
207 _8c.html" target="source" name="AcquireNextImage">AcquireNextImage</a></h2>
208 <div class="doc-section">
209
210 <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>
211
212 <p>The format of the AcquireNextImage method is:</p>
213
214 <pre class="code">
215   void AcquireNextImage(const ImageInfo *image_info,Image *image)
216 </pre>
217
218 <p>A description of each parameter follows:</p></ol>
219
220 <h5>image_info</h5>
221 <ol><p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p></ol>
222
223 <h5>image</h5>
224 <ol><p>the image.</p></ol>
225
226  </div>
227 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
228 _8c.html" target="source" name="AppendImages">AppendImages</a></h2>
229 <div class="doc-section">
230
231 <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>
232
233 <p>The current gravity setting now effects how the image is justified in the final image.</p></ol>
234
235 <p>The format of the AppendImages method is:</p>
236
237 <pre class="code">
238   Image *AppendImages(const Image *image,const MagickBooleanType stack,
239     ExceptionInfo *exception)
240 </pre>
241
242 <p>A description of each parameter follows:</p></ol>
243
244 <h5>image</h5>
245 <ol><p>the image sequence.</p></ol>
246
247 <h5>stack</h5>
248 <ol><p>A value other than 0 stacks the images top-to-bottom.</p></ol>
249
250 <h5>exception</h5>
251 <ol><p>return any errors or warnings in this structure.</p></ol>
252
253  </div>
254 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
255 _8c.html" target="source" name="CatchImageException">CatchImageException</a></h2>
256 <div class="doc-section">
257
258 <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>
259
260 <p>The format of the CatchImageException method is:</p>
261
262 <pre class="code">
263   ExceptionType CatchImageException(Image *image)
264 </pre>
265
266 <p>A description of each parameter follows:</p></ol>
267
268 <h5>image</h5>
269 <ol><p>An image sequence.</p></ol>
270
271  </div>
272 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
273 _8c.html" target="source" name="ClipImagePath">ClipImagePath</a></h2>
274 <div class="doc-section">
275
276 <p>ClipImagePath() sets the image clip mask based any clipping path information if it exists.</p></ol>
277
278 <p>The format of the ClipImagePath method is:</p>
279
280 <pre class="code">
281   MagickBooleanType ClipImagePath(Image *image,const char *pathname,
282     const MagickBooleanType inside)
283 </pre>
284
285 <p>A description of each parameter follows:</p></ol>
286
287 <h5>image</h5>
288 <ol><p>the image.</p></ol>
289
290 <h5>pathname</h5>
291 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
292
293 <h5>inside</h5>
294 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
295
296  </div>
297 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
298 _8c.html" target="source" name="CloneImage">CloneImage</a></h2>
299 <div class="doc-section">
300
301 <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>
302
303 <p>The format of the CloneImage method is:</p>
304
305 <pre class="code">
306   Image *CloneImage(const Image *image,const size_t columns,
307     const size_t rows,const MagickBooleanType orphan,
308     ExceptionInfo *exception)
309 </pre>
310
311 <p>A description of each parameter follows:</p></ol>
312
313 <h5>image</h5>
314 <ol><p>the image.</p></ol>
315
316 <h5>columns</h5>
317 <ol><p>the number of columns in the cloned image.</p></ol>
318
319 <h5>rows</h5>
320 <ol><p>the number of rows in the cloned image.</p></ol>
321
322 <h5>detach</h5>
323 <ol><p>With a value other than 0, the cloned image is detached from its parent I/O stream.</p></ol>
324
325 <h5>exception</h5>
326 <ol><p>return any errors or warnings in this structure.</p></ol>
327
328  </div>
329 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
330 _8c.html" target="source" name="CloneImageInfo">CloneImageInfo</a></h2>
331 <div class="doc-section">
332
333 <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>
334
335 <p>The format of the CloneImageInfo method is:</p>
336
337 <pre class="code">
338   ImageInfo *CloneImageInfo(const ImageInfo *image_info)
339 </pre>
340
341 <p>A description of each parameter follows:</p></ol>
342
343 <h5>image_info</h5>
344 <ol><p>the image info.</p></ol>
345
346  </div>
347 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
348 _8c.html" target="source" name="CombineImages">CombineImages</a></h2>
349 <div class="doc-section">
350
351 <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>
352
353 <p>The format of the CombineImages method is:</p>
354
355 <pre class="code">
356   Image *CombineImages(const Image *image,const ChannelType channel,
357     ExceptionInfo *exception)
358 </pre>
359
360 <p>A description of each parameter follows:</p></ol>
361
362 <h5>image</h5>
363 <ol><p>the image.</p></ol>
364
365 <h5>exception</h5>
366 <ol><p>return any errors or warnings in this structure.</p></ol>
367
368  </div>
369 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
370 _8c.html" target="source" name="DestroyImage">DestroyImage</a></h2>
371 <div class="doc-section">
372
373 <p>DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p></ol>
374
375 <p>The format of the DestroyImage method is:</p>
376
377 <pre class="code">
378   Image *DestroyImage(Image *image)
379 </pre>
380
381 <p>A description of each parameter follows:</p></ol>
382
383 <h5>image</h5>
384 <ol><p>the image.</p></ol>
385
386  </div>
387 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
388 _8c.html" target="source" name="DestroyImageInfo">DestroyImageInfo</a></h2>
389 <div class="doc-section">
390
391 <p>DestroyImageInfo() deallocates memory associated with an ImageInfo structure.</p></ol>
392
393 <p>The format of the DestroyImageInfo method is:</p>
394
395 <pre class="code">
396   ImageInfo *DestroyImageInfo(ImageInfo *image_info)
397 </pre>
398
399 <p>A description of each parameter follows:</p></ol>
400
401 <h5>image_info</h5>
402 <ol><p>the image info.</p></ol>
403
404  </div>
405 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
406 _8c.html" target="source" name="GetImageAlphaChannel">GetImageAlphaChannel</a></h2>
407 <div class="doc-section">
408
409 <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>
410
411 <p>The format of the GetImageAlphaChannel method is:</p>
412
413 <pre class="code">
414   MagickBooleanType GetImageAlphaChannel(const Image *image)
415 </pre>
416
417 <p>A description of each parameter follows:</p></ol>
418
419 <h5>image</h5>
420 <ol><p>the image.</p></ol>
421
422  </div>
423 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
424 _8c.html" target="source" name="GetImageClipMask">GetImageClipMask</a></h2>
425 <div class="doc-section">
426
427 <p>GetImageClipMask() returns the clip path associated with the image.</p></ol>
428
429 <p>The format of the GetImageClipMask method is:</p>
430
431 <pre class="code">
432   Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
433 </pre>
434
435 <p>A description of each parameter follows:</p></ol>
436
437 <h5>image</h5>
438 <ol><p>the image.</p></ol>
439
440  </div>
441 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
442 _8c.html" target="source" name="GetImageException">GetImageException</a></h2>
443 <div class="doc-section">
444
445 <p>GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.</p></ol>
446
447 <p>The format of the GetImageException method is:</p>
448
449 <pre class="code">
450   void GetImageException(Image *image,ExceptionInfo *exception)
451 </pre>
452
453 <p>A description of each parameter follows:</p></ol>
454
455 <h5>image</h5>
456 <ol><p>Specifies a pointer to a list of one or more images.</p></ol>
457
458 <h5>exception</h5>
459 <ol><p>return the highest severity exception.</p></ol>
460
461  </div>
462 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
463 _8c.html" target="source" name="GetImageInfo">GetImageInfo</a></h2>
464 <div class="doc-section">
465
466 <p>GetImageInfo() initializes image_info to default values.</p></ol>
467
468 <p>The format of the GetImageInfo method is:</p>
469
470 <pre class="code">
471   void GetImageInfo(ImageInfo *image_info)
472 </pre>
473
474 <p>A description of each parameter follows:</p></ol>
475
476 <h5>image_info</h5>
477 <ol><p>the image info.</p></ol>
478
479  </div>
480 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
481 _8c.html" target="source" name="GetImageInfoFile">GetImageInfoFile</a></h2>
482 <div class="doc-section">
483
484 <p>GetImageInfoFile() returns the image info file member.</p></ol>
485
486 <p>The format of the GetImageInfoFile method is:</p>
487
488 <pre class="code">
489   FILE *GetImageInfoFile(const ImageInfo *image_info)
490 </pre>
491
492 <p>A description of each parameter follows:</p></ol>
493
494 <h5>image_info</h5>
495 <ol><p>the image info.</p></ol>
496
497  </div>
498 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
499 _8c.html" target="source" name="GetImageMask">GetImageMask</a></h2>
500 <div class="doc-section">
501
502 <p>GetImageMask() returns the mask associated with the image.</p></ol>
503
504 <p>The format of the GetImageMask method is:</p>
505
506 <pre class="code">
507   Image *GetImageMask(const Image *image,ExceptionInfo *exception)
508 </pre>
509
510 <p>A description of each parameter follows:</p></ol>
511
512 <h5>image</h5>
513 <ol><p>the image.</p></ol>
514
515  </div>
516 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
517 _8c.html" target="source" name="GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a></h2>
518 <div class="doc-section">
519
520 <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>
521
522 <p>The format of the GetImageVirtualPixelMethod() method is:</p>
523
524 <pre class="code">
525   VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
526 </pre>
527
528 <p>A description of each parameter follows:</p></ol>
529
530 <h5>image</h5>
531 <ol><p>the image.</p></ol>
532
533  </div>
534 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
535 _8c.html" target="source" name="InterpretImageFilename">InterpretImageFilename</a></h2>
536 <div class="doc-section">
537
538 <p>InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.</p></ol>
539
540 <p>The format of the InterpretImageFilename method is:</p>
541
542 <pre class="code">
543   size_t InterpretImageFilename(const ImageInfo *image_info,
544     Image *image,const char *format,int value,char *filename)
545 </pre>
546
547 <p>A description of each parameter follows.</p></ol>
548
549 <h5>image_info</h5>
550 <ol><p>the image info..</p></ol>
551
552 <h5>image</h5>
553 <ol><p>the image.</p></ol>
554
555 <h5>format</h5>
556 <ol><p>A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.</p></ol>
557
558 <h5>value</h5>
559 <ol><p>Numeric value to substitute into format filename.</p></ol>
560
561 <h5>filename</h5>
562 <ol><p>return the formatted filename in this character buffer.</p></ol>
563
564  </div>
565 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
566 _8c.html" target="source" name="IsHighDynamicRangeImage">IsHighDynamicRangeImage</a></h2>
567 <div class="doc-section">
568
569 <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>
570
571 <p>The format of the IsHighDynamicRangeImage method is:</p>
572
573 <pre class="code">
574   MagickBooleanType IsHighDynamicRangeImage(const Image *image,
575     ExceptionInfo *exception)
576 </pre>
577
578 <p>A description of each parameter follows:</p></ol>
579
580 <h5>image</h5>
581 <ol><p>the image.</p></ol>
582
583 <h5>exception</h5>
584 <ol><p>return any errors or warnings in this structure.</p></ol>
585
586  </div>
587 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
588 _8c.html" target="source" name="IsImageObject">IsImageObject</a></h2>
589 <div class="doc-section">
590
591 <p>IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.</p></ol>
592
593 <p>The format of the IsImageObject method is:</p>
594
595 <pre class="code">
596   MagickBooleanType IsImageObject(const Image *image)
597 </pre>
598
599 <p>A description of each parameter follows:</p></ol>
600
601 <h5>image</h5>
602 <ol><p>the image.</p></ol>
603
604  </div>
605 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
606 _8c.html" target="source" name="IsTaintImage">IsTaintImage</a></h2>
607 <div class="doc-section">
608
609 <p>IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.</p></ol>
610
611 <p>The format of the IsTaintImage method is:</p>
612
613 <pre class="code">
614   MagickBooleanType IsTaintImage(const Image *image)
615 </pre>
616
617 <p>A description of each parameter follows:</p></ol>
618
619 <h5>image</h5>
620 <ol><p>the image.</p></ol>
621
622  </div>
623 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
624 _8c.html" target="source" name="ModifyImage">ModifyImage</a></h2>
625 <div class="doc-section">
626
627 <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>
628
629 <p>The format of the ModifyImage method is:</p>
630
631 <pre class="code">
632   MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
633 </pre>
634
635 <p>A description of each parameter follows:</p></ol>
636
637 <h5>image</h5>
638 <ol><p>the image.</p></ol>
639
640 <h5>exception</h5>
641 <ol><p>return any errors or warnings in this structure.</p></ol>
642
643  </div>
644 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
645 _8c.html" target="source" name="NewMagickImage">NewMagickImage</a></h2>
646 <div class="doc-section">
647
648 <p>NewMagickImage() creates a blank image canvas of the specified size and background color.</p></ol>
649
650 <p>The format of the NewMagickImage method is:</p>
651
652 <pre class="code">
653   Image *NewMagickImage(const ImageInfo *image_info,
654     const size_t width,const size_t height,
655     const MagickPixelPacket *background)
656 </pre>
657
658 <p>A description of each parameter follows:</p></ol>
659
660 <h5>image</h5>
661 <ol><p>the image.</p></ol>
662
663 <h5>width</h5>
664 <ol><p>the image width.</p></ol>
665
666 <h5>height</h5>
667 <ol><p>the image height.</p></ol>
668
669 <h5>background</h5>
670 <ol><p>the image color.</p></ol>
671
672  </div>
673 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
674 _8c.html" target="source" name="ReferenceImage">ReferenceImage</a></h2>
675 <div class="doc-section">
676
677 <p>ReferenceImage() increments the reference count associated with an image returning a pointer to the image.</p></ol>
678
679 <p>The format of the ReferenceImage method is:</p>
680
681 <pre class="code">
682   Image *ReferenceImage(Image *image)
683 </pre>
684
685 <p>A description of each parameter follows:</p></ol>
686
687 <h5>image</h5>
688 <ol><p>the image.</p></ol>
689
690  </div>
691 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
692 _8c.html" target="source" name="ResetImagePage">ResetImagePage</a></h2>
693 <div class="doc-section">
694
695 <p>ResetImagePage() resets the image page canvas and position.</p></ol>
696
697 <p>The format of the ResetImagePage method is:</p>
698
699 <pre class="code">
700   MagickBooleanType ResetImagePage(Image *image,const char *page)
701 </pre>
702
703 <p>A description of each parameter follows:</p></ol>
704
705 <h5>image</h5>
706 <ol><p>the image.</p></ol>
707
708 <h5>page</h5>
709 <ol><p>the relative page specification.</p></ol>
710
711  </div>
712 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
713 _8c.html" target="source" name="SeparateImageChannel">SeparateImageChannel</a></h2>
714 <div class="doc-section">
715
716 <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>
717
718 <p>The format of the SeparateImageChannel method is:</p>
719
720 <pre class="code">
721   MagickBooleanType SeparateImageChannel(Image *image,
722     const ChannelType channel)
723 </pre>
724
725 <p>A description of each parameter follows:</p></ol>
726
727 <h5>image</h5>
728 <ol><p>the image.</p></ol>
729
730 <h5>channel</h5>
731 <ol><p>Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
732
733  </div>
734 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
735 _8c.html" target="source" name="SeparateImages">SeparateImages</a></h2>
736 <div class="doc-section">
737
738 <p>SeparateImages() returns a separate grayscale image for each channel specified.</p></ol>
739
740 <p>The format of the SeparateImages method is:</p>
741
742 <pre class="code">
743   MagickBooleanType SeparateImages(const Image *image,
744     const ChannelType channel,ExceptionInfo *exception)
745 </pre>
746
747 <p>A description of each parameter follows:</p></ol>
748
749 <h5>image</h5>
750 <ol><p>the image.</p></ol>
751
752 <h5>channel</h5>
753 <ol><p>Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
754
755 <h5>exception</h5>
756 <ol><p>return any errors or warnings in this structure.</p></ol>
757
758  </div>
759 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
760 _8c.html" target="source" name="SetImageAlphaChannel">SetImageAlphaChannel</a></h2>
761 <div class="doc-section">
762
763 <p>SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p></ol>
764
765 <p>The format of the SetImageAlphaChannel method is:</p>
766
767 <pre class="code">
768   MagickBooleanType SetImageAlphaChannel(Image *image,
769     const AlphaChannelType alpha_type)
770 </pre>
771
772 <p>A description of each parameter follows:</p></ol>
773
774 <h5>image</h5>
775 <ol><p>the image.</p></ol>
776
777 <h5>alpha_type</h5>
778 <ol><p>The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.</p></ol>
779
780  </div>
781 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
782 _8c.html" target="source" name="SetImageBackgroundColor">SetImageBackgroundColor</a></h2>
783 <div class="doc-section">
784
785 <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>
786
787 <p>The format of the SetImage method is:</p>
788
789 <pre class="code">
790   MagickBooleanType SetImageBackgroundColor(Image *image)
791 </pre>
792
793 <p>A description of each parameter follows:</p></ol>
794
795 <h5>image</h5>
796 <ol><p>the image.</p></ol>
797
798  </div>
799 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
800 _8c.html" target="source" name="SetImageColor">SetImageColor</a></h2>
801 <div class="doc-section">
802
803 <p>SetImageColor() set the entire image canvas to the specified color.</p></ol>
804
805 <p>The format of the SetImageColor method is:</p>
806
807 <pre class="code">
808   MagickBooleanType SetImageColor(Image *image,
809     const MagickPixelPacket *color)
810 </pre>
811
812 <p>A description of each parameter follows:</p></ol>
813
814 <h5>image</h5>
815 <ol><p>the image.</p></ol>
816
817 <h5>background</h5>
818 <ol><p>the image color.</p></ol>
819
820  </div>
821 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
822 _8c.html" target="source" name="SetImageStorageClass">SetImageStorageClass</a></h2>
823 <div class="doc-section">
824
825 <p>SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.</p></ol>
826
827 <p>The format of the SetImageStorageClass method is:</p>
828
829 <pre class="code">
830   MagickBooleanType SetImageStorageClass(Image *image,
831     const ClassType storage_class)
832 </pre>
833
834 <p>A description of each parameter follows:</p></ol>
835
836 <h5>image</h5>
837 <ol><p>the image.</p></ol>
838
839 <h5>storage_class</h5>
840 <ol><p>The image class.</p></ol>
841
842  </div>
843 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
844 _8c.html" target="source" name="SetImageClipMask">SetImageClipMask</a></h2>
845 <div class="doc-section">
846
847 <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>
848
849 <p>The format of the SetImageClipMask method is:</p>
850
851 <pre class="code">
852   MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
853 </pre>
854
855 <p>A description of each parameter follows:</p></ol>
856
857 <h5>image</h5>
858 <ol><p>the image.</p></ol>
859
860 <h5>clip_mask</h5>
861 <ol><p>the image clip path.</p></ol>
862
863  </div>
864 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
865 _8c.html" target="source" name="SetImageExtent">SetImageExtent</a></h2>
866 <div class="doc-section">
867
868 <p>SetImageExtent() sets the image size (i.e. columns & rows).</p></ol>
869
870 <p>The format of the SetImageExtent method is:</p>
871
872 <pre class="code">
873   MagickBooleanType SetImageExtent(Image *image,
874     const size_t columns,const size_t rows)
875 </pre>
876
877 <p>A description of each parameter follows:</p></ol>
878
879 <h5>image</h5>
880 <ol><p>the image.</p></ol>
881
882 <h5>columns</h5>
883 <ol><p>The image width in pixels.</p></ol>
884
885 <h5>rows</h5>
886 <ol><p>The image height in pixels.</p></ol>
887
888  </div>
889 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
890 _8c.html" target="source" name="SetImageInfoBlob">SetImageInfoBlob</a></h2>
891 <div class="doc-section">
892
893 <p>SetImageInfoBlob() sets the image info blob member.</p></ol>
894
895 <p>The format of the SetImageInfoBlob method is:</p>
896
897 <pre class="code">
898   void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
899     const size_t length)
900 </pre>
901
902 <p>A description of each parameter follows:</p></ol>
903
904 <h5>image_info</h5>
905 <ol><p>the image info.</p></ol>
906
907 <h5>blob</h5>
908 <ol><p>the blob.</p></ol>
909
910 <h5>length</h5>
911 <ol><p>the blob length.</p></ol>
912
913  </div>
914 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
915 _8c.html" target="source" name="SetImageInfoFile">SetImageInfoFile</a></h2>
916 <div class="doc-section">
917
918 <p>SetImageInfoFile() sets the image info file member.</p></ol>
919
920 <p>The format of the SetImageInfoFile method is:</p>
921
922 <pre class="code">
923   void SetImageInfoFile(ImageInfo *image_info,FILE *file)
924 </pre>
925
926 <p>A description of each parameter follows:</p></ol>
927
928 <h5>image_info</h5>
929 <ol><p>the image info.</p></ol>
930
931 <h5>file</h5>
932 <ol><p>the file.</p></ol>
933
934  </div>
935 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
936 _8c.html" target="source" name="SetImageMask">SetImageMask</a></h2>
937 <div class="doc-section">
938
939 <p>SetImageMask() associates a mask with the image.  The mask must be the same dimensions as the image.</p></ol>
940
941 <p>The format of the SetImageMask method is:</p>
942
943 <pre class="code">
944   MagickBooleanType SetImageMask(Image *image,const Image *mask)
945 </pre>
946
947 <p>A description of each parameter follows:</p></ol>
948
949 <h5>image</h5>
950 <ol><p>the image.</p></ol>
951
952 <h5>mask</h5>
953 <ol><p>the image mask.</p></ol>
954
955  </div>
956 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
957 _8c.html" target="source" name="SetImageOpacity">SetImageOpacity</a></h2>
958 <div class="doc-section">
959
960 <p>SetImageOpacity() sets the opacity levels of the image.</p></ol>
961
962 <p>The format of the SetImageOpacity method is:</p>
963
964 <pre class="code">
965   MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
966 </pre>
967
968 <p>A description of each parameter follows:</p></ol>
969
970 <h5>image</h5>
971 <ol><p>the image.</p></ol>
972
973 <h5>opacity</h5>
974 <ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
975
976  </div>
977 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
978 _8c.html" target="source" name="SetImageType">SetImageType</a></h2>
979 <div class="doc-section">
980
981 <p>SetImageType() sets the type of image.  Choose from these types:</p></ol>
982
983 <p>Bilevel        Grayscale       GrayscaleMatte Palette        PaletteMatte    TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte OptimizeType</p></ol>
984
985 <p>The format of the SetImageType method is:</p>
986
987 <pre class="code">
988   MagickBooleanType SetImageType(Image *image,const ImageType type)
989 </pre>
990
991 <p>A description of each parameter follows:</p></ol>
992
993 <h5>image</h5>
994 <ol><p>the image.</p></ol>
995
996 <h5>type</h5>
997 <ol><p>Image type.</p></ol>
998
999  </div>
1000 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
1001 _8c.html" target="source" name="SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a></h2>
1002 <div class="doc-section">
1003
1004 <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>
1005
1006 <p>The format of the SetImageVirtualPixelMethod() method is:</p>
1007
1008 <pre class="code">
1009   VirtualPixelMethod SetImageVirtualPixelMethod(const Image *image,
1010     const VirtualPixelMethod virtual_pixel_method)
1011 </pre>
1012
1013 <p>A description of each parameter follows:</p></ol>
1014
1015 <h5>image</h5>
1016 <ol><p>the image.</p></ol>
1017
1018 <h5>virtual_pixel_method</h5>
1019 <ol><p>choose the type of virtual pixel.</p></ol>
1020
1021  </div>
1022 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
1023 _8c.html" target="source" name="StripImage">StripImage</a></h2>
1024 <div class="doc-section">
1025
1026 <p>StripImage() strips an image of all profiles and comments.</p></ol>
1027
1028 <p>The format of the StripImage method is:</p>
1029
1030 <pre class="code">
1031   MagickBooleanType StripImage(Image *image)
1032 </pre>
1033
1034 <p>A description of each parameter follows:</p></ol>
1035
1036 <h5>image</h5>
1037 <ol><p>the image.</p></ol>
1038
1039  </div>
1040 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
1041 _8c.html" target="source" name="SyncImageSettings">SyncImageSettings</a></h2>
1042 <div class="doc-section">
1043
1044 <p>SyncImageSettings() sync the image info options to the image.</p></ol>
1045
1046 <p>The format of the SyncImageSettings method is:</p>
1047
1048 <pre class="code">
1049   MagickBooleanType SyncImageSettings(const ImageInfo *image_info,
1050     Image *image)
1051   MagickBooleanType SyncImagesSettings(const ImageInfo *image_info,
1052     Image *image)
1053 </pre>
1054
1055 <p>A description of each parameter follows:</p></ol>
1056
1057 <h5>image_info</h5>
1058 <ol><p>the image info.</p></ol>
1059
1060 <h5>image</h5>
1061 <ol><p>the image.</p></ol>
1062
1063  </div>
1064 \r
1065 </div>\r
1066 \r
1067 <div id="linkbar">\r
1068     <span id="linkbar-west">&nbsp;</span>\r
1069     <span id="linkbar-center">\r
1070       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
1071       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
1072     </span>\r
1073     <span id="linkbar-east">&nbsp;</span>\r
1074   </div>\r
1075   <div class="footer">\r
1076     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
1077     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
1078   </div>\r
1079   <div style="clear: both; margin: 0; width: 100%; "></div>\r
1080   <script type="text/javascript">\r
1081     var _gaq = _gaq || [];\r
1082     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
1083     _gaq.push(['_trackPageview']);\r
1084 \r
1085     (function() {\r
1086       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
1087       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
1088       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
1089     })();\r
1090   </script>\r
1091 </body>\r
1092 </html>\r