]> granicus.if.org Git - imagemagick/blob - www/api/image.html
f353a07231cef4c79a972a16f82bec800a7c31eb
[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">\r
4 <head>\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
9   --></style>\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"/>
26 </head>\r
27 \r
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
42 </div>\r
43 \r
44 <div class="eastbar">\r
45 \r
46 <div class="menu">
47   <a href="../../index.html">About ImageMagick</a>
48 </div>
49 <div class="sep"></div>\r
50 <div class="menu">
51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
52 </div>
53 <div class="sub">
54     <a href="../../www/command-line-processing.html">Processing</a>
55 </div>
56 <div class="sub">
57     <a href="../../www/command-line-options.html">Options</a>
58 </div>
59 <div class="sub">
60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
61 </div>
62 <div class="menu">
63   <a href="../../www/api.html">Program Interfaces</a>
64 </div>
65 <div class="sub">
66     <a href="../../www/magick-wand.html">MagickWand</a>
67 </div>
68 <div class="sub">
69     <a href="../../www/magick-core.html">MagickCore</a>
70 </div>
71 <div class="sub">
72     <a href="../../www/perl-magick.html">PerlMagick</a>
73 </div>
74 <div class="sub">
75     <a href="../../Magick++/">Magick++</a>
76 </div>
77 <div class="menu">
78   <a href="../../www/architecture.html">Architecture</a>
79 </div>
80 <div class="sep"></div>\r
81 <div  class="menu">
82    <a href="../../www/install-source.html">Install from Source</a>
83 </div>
84 <div class="sub">
85     <a href="../../www/install-source.html#unix">Unix</a>
86 </div>
87 <div class="sub">
88     <a href="../../www/install-source.html#windows">Windows</a>
89  </div>
90 <div class="menu">
91   <a href="../../www/binary-releases.html">Binary Releases</a>
92 </div>
93 <div class="sub">
94     <a href="../../www/binary-releases.html#unix">Unix</a>
95 </div>
96 <div class="sub">
97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
98 </div>
99 <div class="sub">
100     <a href="../../www/binary-releases.html#windows">Windows</a>
101 </div>
102 <div class="menu">
103   <a href="../../www/resources.html">Resources</a>
104 </div>
105 <div class="sep"></div>\r
106 <div class="menu">
107   <a href="../../www/download.html">Download</a>
108 </div>
109 <div class="sep"></div>\r
110 <div class="menu">
111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112 </div>
113 <div class="sep"></div>\r
114 <div class="menu">
115   <a href="../../www/sitemap.html">Site Map</a>
116 </div>
117 <div  class="sub">
118     <a href="../../www/links.html">Links</a>
119 </div>
120 <div class="sep"></div>\r
121 <div  class="menu">
122   <a href="../../www/sponsors.html">Sponsors:</a>
123
124 <div class="sponsbox">
125 <div  class="sponsor">
126    <a href="http://www.buerodruck.de/stempel-service/index.html">Stempel bestellen</a><!-- 200910000035+ -->
127 </div>
128 <div  class="sponsor">
129    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
130 </div>
131 <div  class="sponsor">
132    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
133 </div>
134 <div  class="sponsor">
135   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
136 </div>
137 <div  class="sponsor">
138   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
139 </div>
140 <div  class="sponsor">
141   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
142 </div>
143 <div  class="sponsor">
144   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
145 </div>
146 </div>
147 </div>
148 \r
149 \r
150 </div>\r
151 \r
152 <div class="main">\r
153 \r
154 <p class="navigation-index">[<a href="#AcquireImage">AcquireImage</a> &bull; <a href="#AcquireImageColormap">AcquireImageColormap</a> &bull; <a href="#AcquireImageInfo">AcquireImageInfo</a> &bull; <a href="#AcquireNextImage">AcquireNextImage</a> &bull; <a href="#AppendImages">AppendImages</a> &bull; <a href="#AverageImages">AverageImages</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="#CycleColormap">CycleColormap</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="#GetImageMask">GetImageMask</a> &bull; <a href="#GetImageType">GetImageType</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="#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="#TextureImage">TextureImage</a>]</p>
155
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">
159
160 <p>AcquireImage() returns a pointer to an image structure initialized to default values.</p></ol>
161
162 <p>The format of the AcquireImage method is:</p>
163
164 <pre class="code">
165   Image *AcquireImage(const ImageInfo *image_info)
166 </pre>
167
168 <p>A description of each parameter follows:</p></ol>
169
170 <h5>image_info</h5>
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>
172
173  </div>
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">
177
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>
179
180 <p>The format of the AcquireImageColormap method is:</p>
181
182 <pre class="code">
183   MagickBooleanType AcquireImageColormap(Image *image,
184     const unsigned long colors)
185 </pre>
186
187 <p>A description of each parameter follows:</p></ol>
188
189 <h5>image</h5>
190 <ol><p>the image.</p></ol>
191
192 <h5>colors</h5>
193 <ol><p>the number of colors in the image colormap.</p></ol>
194
195  </div>
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">
199
200 <p>AcquireImageInfo() allocates the ImageInfo structure.</p></ol>
201
202 <p>The format of the AcquireImageInfo method is:</p>
203
204 <pre class="code">
205   ImageInfo *AcquireImageInfo(void)
206 </pre>
207
208  </div>
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">
212
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>
214
215 <p>The format of the AcquireNextImage method is:</p>
216
217 <pre class="code">
218   void AcquireNextImage(const ImageInfo *image_info,Image *image)
219 </pre>
220
221 <p>A description of each parameter follows:</p></ol>
222
223 <h5>image_info</h5>
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>
225
226 <h5>image</h5>
227 <ol><p>the image.</p></ol>
228
229  </div>
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">
233
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>
235
236 <p>The current gravity setting now effects how the image is justified in the final image.</p></ol>
237
238 <p>The format of the AppendImages method is:</p>
239
240 <pre class="code">
241   Image *AppendImages(const Image *image,const MagickBooleanType stack,
242     ExceptionInfo *exception)
243 </pre>
244
245 <p>A description of each parameter follows:</p></ol>
246
247 <h5>image</h5>
248 <ol><p>the image sequence.</p></ol>
249
250 <h5>stack</h5>
251 <ol><p>A value other than 0 stacks the images top-to-bottom.</p></ol>
252
253 <h5>exception</h5>
254 <ol><p>return any errors or warnings in this structure.</p></ol>
255
256  </div>
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">
260
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>
262
263 <p>The format of the AverageImages method is:</p>
264
265 <pre class="code">
266   Image *AverageImages(Image *image,ExceptionInfo *exception)
267 </pre>
268
269 <p>A description of each parameter follows:</p></ol>
270
271 <h5>image</h5>
272 <ol><p>the image sequence.</p></ol>
273
274 <h5>exception</h5>
275 <ol><p>return any errors or warnings in this structure.</p></ol>
276
277  </div>
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">
281
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>
283
284 <p>The format of the CatchImageException method is:</p>
285
286 <pre class="code">
287   ExceptionType CatchImageException(Image *image)
288 </pre>
289
290 <p>A description of each parameter follows:</p></ol>
291
292 <h5>image</h5>
293 <ol><p>An image sequence.</p></ol>
294
295  </div>
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">
299
300 <p>ClipImagePath() sets the image clip mask based any clipping path information if it exists.</p></ol>
301
302 <p>The format of the ClipImagePath method is:</p>
303
304 <pre class="code">
305   MagickBooleanType ClipImagePath(Image *image,const char *pathname,
306     const MagickBooleanType inside)
307 </pre>
308
309 <p>A description of each parameter follows:</p></ol>
310
311 <h5>image</h5>
312 <ol><p>the image.</p></ol>
313
314 <h5>pathname</h5>
315 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
316
317 <h5>inside</h5>
318 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
319
320  </div>
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">
324
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>
326
327 <p>The format of the CloneImage method is:</p>
328
329 <pre class="code">
330   Image *CloneImage(const Image *image,const unsigned long columns,
331     const unsigned long rows,const MagickBooleanType orphan,
332     ExceptionInfo *exception)
333 </pre>
334
335 <p>A description of each parameter follows:</p></ol>
336
337 <h5>image</h5>
338 <ol><p>the image.</p></ol>
339
340 <h5>columns</h5>
341 <ol><p>the number of columns in the cloned image.</p></ol>
342
343 <h5>rows</h5>
344 <ol><p>the number of rows in the cloned image.</p></ol>
345
346 <h5>detach</h5>
347 <ol><p>With a value other than 0, the cloned image is detached from its parent I/O stream.</p></ol>
348
349 <h5>exception</h5>
350 <ol><p>return any errors or warnings in this structure.</p></ol>
351
352  </div>
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">
356
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>
358
359 <p>The format of the CloneImageInfo method is:</p>
360
361 <pre class="code">
362   ImageInfo *CloneImageInfo(const ImageInfo *image_info)
363 </pre>
364
365 <p>A description of each parameter follows:</p></ol>
366
367 <h5>image_info</h5>
368 <ol><p>the image info.</p></ol>
369
370  </div>
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">
374
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>
376
377 <p>The format of the CombineImages method is:</p>
378
379 <pre class="code">
380   Image *CombineImages(const Image *image,const ChannelType channel,
381     ExceptionInfo *exception)
382 </pre>
383
384 <p>A description of each parameter follows:</p></ol>
385
386 <h5>image</h5>
387 <ol><p>the image.</p></ol>
388
389 <h5>exception</h5>
390 <ol><p>return any errors or warnings in this structure.</p></ol>
391
392  </div>
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">
396
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>
398
399 <p>The format of the CycleColormapImage method is:</p>
400
401 <pre class="code">
402   MagickBooleanType CycleColormapImage(Image *image,const long displace)
403 </pre>
404
405 <p>A description of each parameter follows:</p></ol>
406
407 <h5>image</h5>
408 <ol><p>the image.</p></ol>
409
410 <h5>displace</h5>
411 <ol><p>displace the colormap this amount.</p></ol>
412
413  </div>
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">
417
418 <p>DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p></ol>
419
420 <p>The format of the DestroyImage method is:</p>
421
422 <pre class="code">
423   Image *DestroyImage(Image *image)
424 </pre>
425
426 <p>A description of each parameter follows:</p></ol>
427
428 <h5>image</h5>
429 <ol><p>the image.</p></ol>
430
431  </div>
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">
435
436 <p>DestroyImageInfo() deallocates memory associated with an ImageInfo structure.</p></ol>
437
438 <p>The format of the DestroyImageInfo method is:</p>
439
440 <pre class="code">
441   ImageInfo *DestroyImageInfo(ImageInfo *image_info)
442 </pre>
443
444 <p>A description of each parameter follows:</p></ol>
445
446 <h5>image_info</h5>
447 <ol><p>the image info.</p></ol>
448
449  </div>
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">
453
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>
455
456 <p>The format of the GetImageAlphaChannel method is:</p>
457
458 <pre class="code">
459   MagickBooleanType GetImageAlphaChannel(const Image *image)
460 </pre>
461
462 <p>A description of each parameter follows:</p></ol>
463
464 <h5>image</h5>
465 <ol><p>the image.</p></ol>
466
467  </div>
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">
471
472 <p>GetImageClipMask() returns the clip path associated with the image.</p></ol>
473
474 <p>The format of the GetImageClipMask method is:</p>
475
476 <pre class="code">
477   Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
478 </pre>
479
480 <p>A description of each parameter follows:</p></ol>
481
482 <h5>image</h5>
483 <ol><p>the image.</p></ol>
484
485  </div>
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">
489
490 <p>GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.</p></ol>
491
492 <p>The format of the GetImageException method is:</p>
493
494 <pre class="code">
495   void GetImageException(Image *image,ExceptionInfo *exception)
496 </pre>
497
498 <p>A description of each parameter follows:</p></ol>
499
500 <h5>image</h5>
501 <ol><p>Specifies a pointer to a list of one or more images.</p></ol>
502
503 <h5>exception</h5>
504 <ol><p>return the highest severity exception.</p></ol>
505
506  </div>
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">
510
511 <p>GetImageInfo() initializes image_info to default values.</p></ol>
512
513 <p>The format of the GetImageInfo method is:</p>
514
515 <pre class="code">
516   void GetImageInfo(ImageInfo *image_info)
517 </pre>
518
519 <p>A description of each parameter follows:</p></ol>
520
521 <h5>image_info</h5>
522 <ol><p>the image info.</p></ol>
523
524  </div>
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">
528
529 <p>GetImageMask() returns the mask associated with the image.</p></ol>
530
531 <p>The format of the GetImageMask method is:</p>
532
533 <pre class="code">
534   Image *GetImageMask(const Image *image,ExceptionInfo *exception)
535 </pre>
536
537 <p>A description of each parameter follows:</p></ol>
538
539 <h5>image</h5>
540 <ol><p>the image.</p></ol>
541
542  </div>
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">
546
547 <p>GetImageType() returns the potential type of image:</p></ol>
548
549 <p>Bilevel         Grayscale        GrayscaleMatte Palette         PaletteMatte     TrueColor TrueColorMatte  ColorSeparation  ColorSeparationMatte</p></ol>
550
551 <p>To ensure the image type matches its potential, use SetImageType():</p>
552
553 <pre class="text">
554       (void) SetImageType(image,GetImageType(image));
555 </pre>
556
557 <p>The format of the GetImageType method is:</p>
558
559 <pre class="code">
560   ImageType GetImageType(const Image *image,ExceptionInfo *exception)
561 </pre>
562
563 <p>A description of each parameter follows:</p></ol>
564
565 <h5>image</h5>
566 <ol><p>the image.</p></ol>
567
568 <h5>exception</h5>
569 <ol><p>return any errors or warnings in this structure.</p></ol>
570
571  </div>
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">
575
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>
577
578 <p>The format of the GetImageVirtualPixelMethod() method is:</p>
579
580 <pre class="code">
581   VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
582 </pre>
583
584 <p>A description of each parameter follows:</p></ol>
585
586 <h5>image</h5>
587 <ol><p>the image.</p></ol>
588
589  </div>
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">
593
594 <p>InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.</p></ol>
595
596 <p>The format of the InterpretImageFilename method is:</p>
597
598 <pre class="code">
599   size_t InterpretImageFilename(const ImageInfo *image_info,
600     Image *image,const char *format,int value,char *filename)
601 </pre>
602
603 <p>A description of each parameter follows.</p></ol>
604
605 <h5>image_info</h5>
606 <ol><p>the image info..</p></ol>
607
608 <h5>image</h5>
609 <ol><p>the image.</p></ol>
610
611 <h5>format</h5>
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>
613
614 <h5>value</h5>
615 <ol><p>Numeric value to substitute into format filename.</p></ol>
616
617 <h5>filename</h5>
618 <ol><p>return the formatted filename in this character buffer.</p></ol>
619
620  </div>
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">
624
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>
626
627 <p>The format of the IsHighDynamicRangeImage method is:</p>
628
629 <pre class="code">
630   MagickBooleanType IsHighDynamicRangeImage(const Image *image,
631     ExceptionInfo *exception)
632 </pre>
633
634 <p>A description of each parameter follows:</p></ol>
635
636 <h5>image</h5>
637 <ol><p>the image.</p></ol>
638
639 <h5>exception</h5>
640 <ol><p>return any errors or warnings in this structure.</p></ol>
641
642  </div>
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">
646
647 <p>IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.</p></ol>
648
649 <p>The format of the IsImageObject method is:</p>
650
651 <pre class="code">
652   MagickBooleanType IsImageObject(const Image *image)
653 </pre>
654
655 <p>A description of each parameter follows:</p></ol>
656
657 <h5>image</h5>
658 <ol><p>the image.</p></ol>
659
660  </div>
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">
664
665 <p>IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.</p></ol>
666
667 <p>The format of the IsTaintImage method is:</p>
668
669 <pre class="code">
670   MagickBooleanType IsTaintImage(const Image *image)
671 </pre>
672
673 <p>A description of each parameter follows:</p></ol>
674
675 <h5>image</h5>
676 <ol><p>the image.</p></ol>
677
678  </div>
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">
682
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>
684
685 <p>The format of the ModifyImage method is:</p>
686
687 <pre class="code">
688   MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
689 </pre>
690
691 <p>A description of each parameter follows:</p></ol>
692
693 <h5>image</h5>
694 <ol><p>the image.</p></ol>
695
696 <h5>exception</h5>
697 <ol><p>return any errors or warnings in this structure.</p></ol>
698
699  </div>
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">
703
704 <p>NewMagickImage() creates a blank image canvas of the specified size and background color.</p></ol>
705
706 <p>The format of the NewMagickImage method is:</p>
707
708 <pre class="code">
709   Image *NewMagickImage(const ImageInfo *image_info,
710     const unsigned long width,const unsigned long height,
711     const MagickPixelPacket *background)
712 </pre>
713
714 <p>A description of each parameter follows:</p></ol>
715
716 <h5>image</h5>
717 <ol><p>the image.</p></ol>
718
719 <h5>width</h5>
720 <ol><p>the image width.</p></ol>
721
722 <h5>height</h5>
723 <ol><p>the image height.</p></ol>
724
725 <h5>background</h5>
726 <ol><p>the image color.</p></ol>
727
728  </div>
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">
732
733 <p>ReferenceImage() increments the reference count associated with an image returning a pointer to the image.</p></ol>
734
735 <p>The format of the ReferenceImage method is:</p>
736
737 <pre class="code">
738   Image *ReferenceImage(Image *image)
739 </pre>
740
741 <p>A description of each parameter follows:</p></ol>
742
743 <h5>image</h5>
744 <ol><p>the image.</p></ol>
745
746  </div>
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">
750
751 <p>ResetImagePage() resets the image page canvas and position.</p></ol>
752
753 <p>The format of the ResetImagePage method is:</p>
754
755 <pre class="code">
756   MagickBooleanType ResetImagePage(Image *image,const char *page)
757 </pre>
758
759 <p>A description of each parameter follows:</p></ol>
760
761 <h5>image</h5>
762 <ol><p>the image.</p></ol>
763
764 <h5>page</h5>
765 <ol><p>the relative page specification.</p></ol>
766
767  </div>
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">
771
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>
773
774 <p>The format of the SeparateImageChannel method is:</p>
775
776 <pre class="code">
777   MagickBooleanType SeparateImageChannel(Image *image,
778     const ChannelType channel)
779 </pre>
780
781 <p>A description of each parameter follows:</p></ol>
782
783 <h5>image</h5>
784 <ol><p>the image.</p></ol>
785
786 <h5>channel</h5>
787 <ol><p>Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
788
789  </div>
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">
793
794 <p>SeparateImages() returns a separate grayscale image for each channel specified.</p></ol>
795
796 <p>The format of the SeparateImages method is:</p>
797
798 <pre class="code">
799   MagickBooleanType SeparateImages(const Image *image,
800     const ChannelType channel,ExceptionInfo *exception)
801 </pre>
802
803 <p>A description of each parameter follows:</p></ol>
804
805 <h5>image</h5>
806 <ol><p>the image.</p></ol>
807
808 <h5>channel</h5>
809 <ol><p>Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
810
811 <h5>exception</h5>
812 <ol><p>return any errors or warnings in this structure.</p></ol>
813
814  </div>
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">
818
819 <p>SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p></ol>
820
821 <p>The format of the SetImageAlphaChannel method is:</p>
822
823 <pre class="code">
824   MagickBooleanType SetImageAlphaChannel(Image *image,
825     const AlphaChannelType alpha_type)
826 </pre>
827
828 <p>A description of each parameter follows:</p></ol>
829
830 <h5>image</h5>
831 <ol><p>the image.</p></ol>
832
833 <h5>alpha_type</h5>
834 <ol><p>The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.</p></ol>
835
836  </div>
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">
840
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>
842
843 <p>The format of the SetImage method is:</p>
844
845 <pre class="code">
846   MagickBooleanType SetImageBackgroundColor(Image *image)
847 </pre>
848
849 <p>A description of each parameter follows:</p></ol>
850
851 <h5>image</h5>
852 <ol><p>the image.</p></ol>
853
854  </div>
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">
858
859 <p>SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.</p></ol>
860
861 <p>The format of the SetImageStorageClass method is:</p>
862
863 <pre class="code">
864   MagickBooleanType SetImageStorageClass(Image *image,
865     const ClassType storage_class)
866 </pre>
867
868 <p>A description of each parameter follows:</p></ol>
869
870 <h5>image</h5>
871 <ol><p>the image.</p></ol>
872
873 <h5>storage_class</h5>
874 <ol><p>The image class.</p></ol>
875
876  </div>
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">
880
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>
882
883 <p>The format of the SetImageClipMask method is:</p>
884
885 <pre class="code">
886   MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
887 </pre>
888
889 <p>A description of each parameter follows:</p></ol>
890
891 <h5>image</h5>
892 <ol><p>the image.</p></ol>
893
894 <h5>clip_mask</h5>
895 <ol><p>the image clip path.</p></ol>
896
897  </div>
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">
901
902 <p>SetImageExtent() sets the image size (i.e. columns & rows).</p></ol>
903
904 <p>The format of the SetImageExtent method is:</p>
905
906 <pre class="code">
907   MagickBooleanType SetImageExtent(Image *image,
908     const unsigned long columns,const unsigned long rows)
909 </pre>
910
911 <p>A description of each parameter follows:</p></ol>
912
913 <h5>image</h5>
914 <ol><p>the image.</p></ol>
915
916 <h5>columns</h5>
917 <ol><p>The image width in pixels.</p></ol>
918
919 <h5>rows</h5>
920 <ol><p>The image height in pixels.</p></ol>
921
922  </div>
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">
926
927 <p>SetImageInfoBlob() sets the image info blob member.</p></ol>
928
929 <p>The format of the SetImageInfoBlob method is:</p>
930
931 <pre class="code">
932   void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
933     const size_t length)
934 </pre>
935
936 <p>A description of each parameter follows:</p></ol>
937
938 <h5>image_info</h5>
939 <ol><p>the image info.</p></ol>
940
941 <h5>blob</h5>
942 <ol><p>the blob.</p></ol>
943
944 <h5>length</h5>
945 <ol><p>the blob length.</p></ol>
946
947  </div>
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">
951
952 <p>SetImageInfoFile() sets the image info file member.</p></ol>
953
954 <p>The format of the SetImageInfoFile method is:</p>
955
956 <pre class="code">
957   void SetImageInfoFile(ImageInfo *image_info,FILE *file)
958 </pre>
959
960 <p>A description of each parameter follows:</p></ol>
961
962 <h5>image_info</h5>
963 <ol><p>the image info.</p></ol>
964
965 <h5>file</h5>
966 <ol><p>the file.</p></ol>
967
968  </div>
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">
972
973 <p>SetImageMask() associates a mask with the image.  The mask must be the same dimensions as the image.</p></ol>
974
975 <p>The format of the SetImageMask method is:</p>
976
977 <pre class="code">
978   MagickBooleanType SetImageMask(Image *image,const Image *mask)
979 </pre>
980
981 <p>A description of each parameter follows:</p></ol>
982
983 <h5>image</h5>
984 <ol><p>the image.</p></ol>
985
986 <h5>mask</h5>
987 <ol><p>the image mask.</p></ol>
988
989  </div>
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">
993
994 <p>SetImageOpacity() sets the opacity levels of the image.</p></ol>
995
996 <p>The format of the SetImageOpacity method is:</p>
997
998 <pre class="code">
999   MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
1000 </pre>
1001
1002 <p>A description of each parameter follows:</p></ol>
1003
1004 <h5>image</h5>
1005 <ol><p>the image.</p></ol>
1006
1007 <h5>opacity</h5>
1008 <ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
1009
1010  </div>
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">
1014
1015 <p>SetImageType() sets the type of image.  Choose from these types:</p></ol>
1016
1017 <p>Bilevel        Grayscale       GrayscaleMatte Palette        PaletteMatte    TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte OptimizeType</p></ol>
1018
1019 <p>The format of the SetImageType method is:</p>
1020
1021 <pre class="code">
1022   MagickBooleanType SetImageType(Image *image,const ImageType type)
1023 </pre>
1024
1025 <p>A description of each parameter follows:</p></ol>
1026
1027 <h5>image</h5>
1028 <ol><p>the image.</p></ol>
1029
1030 <h5>type</h5>
1031 <ol><p>Image type.</p></ol>
1032
1033  </div>
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">
1037
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>
1039
1040 <p>The format of the SetImageVirtualPixelMethod() method is:</p>
1041
1042 <pre class="code">
1043   VirtualPixelMethod SetImageVirtualPixelMethod(const Image *image,
1044     const VirtualPixelMethod virtual_pixel_method)
1045 </pre>
1046
1047 <p>A description of each parameter follows:</p></ol>
1048
1049 <h5>image</h5>
1050 <ol><p>the image.</p></ol>
1051
1052 <h5>virtual_pixel_method</h5>
1053 <ol><p>choose the type of virtual pixel.</p></ol>
1054
1055  </div>
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">
1059
1060 <p>StripImage() strips an image of all profiles and comments.</p></ol>
1061
1062 <p>The format of the StripImage method is:</p>
1063
1064 <pre class="code">
1065   MagickBooleanType StripImage(Image *image)
1066 </pre>
1067
1068 <p>A description of each parameter follows:</p></ol>
1069
1070 <h5>image</h5>
1071 <ol><p>the image.</p></ol>
1072
1073  </div>
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">
1077
1078 <p>TextureImage() repeatedly tiles the texture image across and down the image canvas.</p></ol>
1079
1080 <p>The format of the TextureImage method is:</p>
1081
1082 <pre class="code">
1083   MagickBooleanType TextureImage(Image *image,const Image *texture)
1084 </pre>
1085
1086 <p>A description of each parameter follows:</p></ol>
1087
1088 <h5>image</h5>
1089 <ol><p>the image.</p></ol>
1090
1091 <h5>texture</h5>
1092 <ol><p>This image is the texture to layer on the background.</p></ol>
1093
1094  </div>
1095 \r
1096 </div>\r
1097 \r
1098 <div id="linkbar">\r
1099  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
1100     <span id="linkbar-center">\r
1101       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
1102       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
1103     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
1104     </span>\r
1105     <span id="linkbar-east">&nbsp;</span>\r
1106   </div>\r
1107   <div class="footer">\r
1108     <span id="footer-west">&copy; 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
1110   </div>\r
1111   <div style="clear: both; margin: 0; width: 100%; "></div>\r
1112 </body>\r
1113 </html>\r