Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / f3bb478904b5290d048cee6d114356634187b5f2 / . / www / api / image.html
blob: 900e47e44955aa4cfe66584cd6b25cd8da2a21a2 [file] [log] [blame]
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame^]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
7 <style type="text/css" media="screen,projection"><!--
8 @import url("../../www/magick.css");
9 --></style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame^]26</head>
27
28<body id="www-imagemagick-org">
29<div class="titlebar">
30<a href="../../index.html">
31 <img src="../../images/script.png" alt="[ImageMagick]"
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
33<a href="http://www.networkredux.com">
34 <img src="../../images/networkredux.png" alt="[sponsor]"
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
36<a href="http://www.imagemagick.org/discourse-server/">
37 <img src="../../images/logo.jpg" alt=""
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
39<a href="../../index.html">
40 <img src="../../images/sprite.jpg" alt=""
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
42</div>
43
44<div class="eastbar">
45
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]46<div class="menu">
47 <a href="../../index.html">About ImageMagick</a>
48</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame^]49<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame^]80<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame^]105<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106<div class="menu">
107 <a href="../../www/download.html">Download</a>
108</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame^]109<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame^]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame^]120<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121<div class="menu">
122 <a href="../../www/sponsors.html">Sponsors:</a>
123
124<div class="sponsbox">
125<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame^]126 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
127</div>
128<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]129 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
130</div>
131<div class="sponsor">
132 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
133</div>
134<div class="sponsor">
135 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
136</div>
137<div class="sponsor">
138 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
139</div>
140<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame^]141 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142</div>
143</div>
144</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame^]145
146
147</div>
148
149<div class="main">
150
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]151<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>
152
153<h2><a href="http://www.imagemagick.org/api/MagickCore/image
154_8c.html" target="source" name="AcquireImage">AcquireImage</a></h2>
155<div class="doc-section">
156
157<p>AcquireImage() returns a pointer to an image structure initialized to default values.</p></ol>
158
159<p>The format of the AcquireImage method is:</p>
160
161<pre class="code">
162 Image *AcquireImage(const ImageInfo *image_info)
163</pre>
164
165<p>A description of each parameter follows:</p></ol>
166
167<h5>image_info</h5>
168<ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
169
170 </div>
171<h2><a href="http://www.imagemagick.org/api/MagickCore/image
172_8c.html" target="source" name="AcquireImageColormap">AcquireImageColormap</a></h2>
173<div class="doc-section">
174
175<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>
176
177<p>The format of the AcquireImageColormap method is:</p>
178
179<pre class="code">
180 MagickBooleanType AcquireImageColormap(Image *image,
181 const unsigned long colors)
182</pre>
183
184<p>A description of each parameter follows:</p></ol>
185
186<h5>image</h5>
187<ol><p>the image.</p></ol>
188
189<h5>colors</h5>
190<ol><p>the number of colors in the image colormap.</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="AverageImages">AverageImages</a></h2>
256<div class="doc-section">
257
258<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>
259
260<p>The format of the AverageImages method is:</p>
261
262<pre class="code">
263 Image *AverageImages(Image *image,ExceptionInfo *exception)
264</pre>
265
266<p>A description of each parameter follows:</p></ol>
267
268<h5>image</h5>
269<ol><p>the image sequence.</p></ol>
270
271<h5>exception</h5>
272<ol><p>return any errors or warnings in this structure.</p></ol>
273
274 </div>
275<h2><a href="http://www.imagemagick.org/api/MagickCore/image
276_8c.html" target="source" name="CatchImageException">CatchImageException</a></h2>
277<div class="doc-section">
278
279<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>
280
281<p>The format of the CatchImageException method is:</p>
282
283<pre class="code">
284 ExceptionType CatchImageException(Image *image)
285</pre>
286
287<p>A description of each parameter follows:</p></ol>
288
289<h5>image</h5>
290<ol><p>An image sequence.</p></ol>
291
292 </div>
293<h2><a href="http://www.imagemagick.org/api/MagickCore/image
294_8c.html" target="source" name="ClipImagePath">ClipImagePath</a></h2>
295<div class="doc-section">
296
297<p>ClipImagePath() sets the image clip mask based any clipping path information if it exists.</p></ol>
298
299<p>The format of the ClipImagePath method is:</p>
300
301<pre class="code">
302 MagickBooleanType ClipImagePath(Image *image,const char *pathname,
303 const MagickBooleanType inside)
304</pre>
305
306<p>A description of each parameter follows:</p></ol>
307
308<h5>image</h5>
309<ol><p>the image.</p></ol>
310
311<h5>pathname</h5>
312<ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
313
314<h5>inside</h5>
315<ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
316
317 </div>
318<h2><a href="http://www.imagemagick.org/api/MagickCore/image
319_8c.html" target="source" name="CloneImage">CloneImage</a></h2>
320<div class="doc-section">
321
322<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>
323
324<p>The format of the CloneImage method is:</p>
325
326<pre class="code">
327 Image *CloneImage(const Image *image,const unsigned long columns,
328 const unsigned long rows,const MagickBooleanType orphan,
329 ExceptionInfo *exception)
330</pre>
331
332<p>A description of each parameter follows:</p></ol>
333
334<h5>image</h5>
335<ol><p>the image.</p></ol>
336
337<h5>columns</h5>
338<ol><p>the number of columns in the cloned image.</p></ol>
339
340<h5>rows</h5>
341<ol><p>the number of rows in the cloned image.</p></ol>
342
343<h5>detach</h5>
344<ol><p>With a value other than 0, the cloned image is detached from its parent I/O stream.</p></ol>
345
346<h5>exception</h5>
347<ol><p>return any errors or warnings in this structure.</p></ol>
348
349 </div>
350<h2><a href="http://www.imagemagick.org/api/MagickCore/image
351_8c.html" target="source" name="CloneImageInfo">CloneImageInfo</a></h2>
352<div class="doc-section">
353
354<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>
355
356<p>The format of the CloneImageInfo method is:</p>
357
358<pre class="code">
359 ImageInfo *CloneImageInfo(const ImageInfo *image_info)
360</pre>
361
362<p>A description of each parameter follows:</p></ol>
363
364<h5>image_info</h5>
365<ol><p>the image info.</p></ol>
366
367 </div>
368<h2><a href="http://www.imagemagick.org/api/MagickCore/image
369_8c.html" target="source" name="CombineImages">CombineImages</a></h2>
370<div class="doc-section">
371
372<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>
373
374<p>The format of the CombineImages method is:</p>
375
376<pre class="code">
377 Image *CombineImages(const Image *image,const ChannelType channel,
378 ExceptionInfo *exception)
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<h5>exception</h5>
387<ol><p>return any errors or warnings in this structure.</p></ol>
388
389 </div>
390<h2><a href="http://www.imagemagick.org/api/MagickCore/image
391_8c.html" target="source" name="CycleColormap">CycleColormap</a></h2>
392<div class="doc-section">
393
394<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>
395
396<p>The format of the CycleColormapImage method is:</p>
397
398<pre class="code">
399 MagickBooleanType CycleColormapImage(Image *image,const long displace)
400</pre>
401
402<p>A description of each parameter follows:</p></ol>
403
404<h5>image</h5>
405<ol><p>the image.</p></ol>
406
407<h5>displace</h5>
408<ol><p>displace the colormap this amount.</p></ol>
409
410 </div>
411<h2><a href="http://www.imagemagick.org/api/MagickCore/image
412_8c.html" target="source" name="DestroyImage">DestroyImage</a></h2>
413<div class="doc-section">
414
415<p>DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p></ol>
416
417<p>The format of the DestroyImage method is:</p>
418
419<pre class="code">
420 Image *DestroyImage(Image *image)
421</pre>
422
423<p>A description of each parameter follows:</p></ol>
424
425<h5>image</h5>
426<ol><p>the image.</p></ol>
427
428 </div>
429<h2><a href="http://www.imagemagick.org/api/MagickCore/image
430_8c.html" target="source" name="DestroyImageInfo">DestroyImageInfo</a></h2>
431<div class="doc-section">
432
433<p>DestroyImageInfo() deallocates memory associated with an ImageInfo structure.</p></ol>
434
435<p>The format of the DestroyImageInfo method is:</p>
436
437<pre class="code">
438 ImageInfo *DestroyImageInfo(ImageInfo *image_info)
439</pre>
440
441<p>A description of each parameter follows:</p></ol>
442
443<h5>image_info</h5>
444<ol><p>the image info.</p></ol>
445
446 </div>
447<h2><a href="http://www.imagemagick.org/api/MagickCore/image
448_8c.html" target="source" name="GetImageAlphaChannel">GetImageAlphaChannel</a></h2>
449<div class="doc-section">
450
451<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>
452
453<p>The format of the GetImageAlphaChannel method is:</p>
454
455<pre class="code">
456 MagickBooleanType GetImageAlphaChannel(const Image *image)
457</pre>
458
459<p>A description of each parameter follows:</p></ol>
460
461<h5>image</h5>
462<ol><p>the image.</p></ol>
463
464 </div>
465<h2><a href="http://www.imagemagick.org/api/MagickCore/image
466_8c.html" target="source" name="GetImageClipMask">GetImageClipMask</a></h2>
467<div class="doc-section">
468
469<p>GetImageClipMask() returns the clip path associated with the image.</p></ol>
470
471<p>The format of the GetImageClipMask method is:</p>
472
473<pre class="code">
474 Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
475</pre>
476
477<p>A description of each parameter follows:</p></ol>
478
479<h5>image</h5>
480<ol><p>the image.</p></ol>
481
482 </div>
483<h2><a href="http://www.imagemagick.org/api/MagickCore/image
484_8c.html" target="source" name="GetImageException">GetImageException</a></h2>
485<div class="doc-section">
486
487<p>GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.</p></ol>
488
489<p>The format of the GetImageException method is:</p>
490
491<pre class="code">
492 void GetImageException(Image *image,ExceptionInfo *exception)
493</pre>
494
495<p>A description of each parameter follows:</p></ol>
496
497<h5>image</h5>
498<ol><p>Specifies a pointer to a list of one or more images.</p></ol>
499
500<h5>exception</h5>
501<ol><p>return the highest severity exception.</p></ol>
502
503 </div>
504<h2><a href="http://www.imagemagick.org/api/MagickCore/image
505_8c.html" target="source" name="GetImageInfo">GetImageInfo</a></h2>
506<div class="doc-section">
507
508<p>GetImageInfo() initializes image_info to default values.</p></ol>
509
510<p>The format of the GetImageInfo method is:</p>
511
512<pre class="code">
513 void GetImageInfo(ImageInfo *image_info)
514</pre>
515
516<p>A description of each parameter follows:</p></ol>
517
518<h5>image_info</h5>
519<ol><p>the image info.</p></ol>
520
521 </div>
522<h2><a href="http://www.imagemagick.org/api/MagickCore/image
523_8c.html" target="source" name="GetImageMask">GetImageMask</a></h2>
524<div class="doc-section">
525
526<p>GetImageMask() returns the mask associated with the image.</p></ol>
527
528<p>The format of the GetImageMask method is:</p>
529
530<pre class="code">
531 Image *GetImageMask(const Image *image,ExceptionInfo *exception)
532</pre>
533
534<p>A description of each parameter follows:</p></ol>
535
536<h5>image</h5>
537<ol><p>the image.</p></ol>
538
539 </div>
540<h2><a href="http://www.imagemagick.org/api/MagickCore/image
541_8c.html" target="source" name="GetImageType">GetImageType</a></h2>
542<div class="doc-section">
543
544<p>GetImageType() returns the potential type of image:</p></ol>
545
546<p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte</p></ol>
547
548<p>To ensure the image type matches its potential, use SetImageType():</p>
549
550<pre class="text">
551 (void) SetImageType(image,GetImageType(image));
552</pre>
553
554<p>The format of the GetImageType method is:</p>
555
556<pre class="code">
557 ImageType GetImageType(const Image *image,ExceptionInfo *exception)
558</pre>
559
560<p>A description of each parameter follows:</p></ol>
561
562<h5>image</h5>
563<ol><p>the image.</p></ol>
564
565<h5>exception</h5>
566<ol><p>return any errors or warnings in this structure.</p></ol>
567
568 </div>
569<h2><a href="http://www.imagemagick.org/api/MagickCore/image
570_8c.html" target="source" name="GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a></h2>
571<div class="doc-section">
572
573<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>
574
575<p>The format of the GetImageVirtualPixelMethod() method is:</p>
576
577<pre class="code">
578 VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
579</pre>
580
581<p>A description of each parameter follows:</p></ol>
582
583<h5>image</h5>
584<ol><p>the image.</p></ol>
585
586 </div>
587<h2><a href="http://www.imagemagick.org/api/MagickCore/image
588_8c.html" target="source" name="InterpretImageFilename">InterpretImageFilename</a></h2>
589<div class="doc-section">
590
591<p>InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.</p></ol>
592
593<p>The format of the InterpretImageFilename method is:</p>
594
595<pre class="code">
596 size_t InterpretImageFilename(const ImageInfo *image_info,
597 Image *image,const char *format,int value,char *filename)
598</pre>
599
600<p>A description of each parameter follows.</p></ol>
601
602<h5>image_info</h5>
603<ol><p>the image info..</p></ol>
604
605<h5>image</h5>
606<ol><p>the image.</p></ol>
607
608<h5>format</h5>
609<ol><p>A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.</p></ol>
610
611<h5>value</h5>
612<ol><p>Numeric value to substitute into format filename.</p></ol>
613
614<h5>filename</h5>
615<ol><p>return the formatted filename in this character buffer.</p></ol>
616
617 </div>
618<h2><a href="http://www.imagemagick.org/api/MagickCore/image
619_8c.html" target="source" name="IsHighDynamicRangeImage">IsHighDynamicRangeImage</a></h2>
620<div class="doc-section">
621
622<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>
623
624<p>The format of the IsHighDynamicRangeImage method is:</p>
625
626<pre class="code">
627 MagickBooleanType IsHighDynamicRangeImage(const Image *image,
628 ExceptionInfo *exception)
629</pre>
630
631<p>A description of each parameter follows:</p></ol>
632
633<h5>image</h5>
634<ol><p>the image.</p></ol>
635
636<h5>exception</h5>
637<ol><p>return any errors or warnings in this structure.</p></ol>
638
639 </div>
640<h2><a href="http://www.imagemagick.org/api/MagickCore/image
641_8c.html" target="source" name="IsImageObject">IsImageObject</a></h2>
642<div class="doc-section">
643
644<p>IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.</p></ol>
645
646<p>The format of the IsImageObject method is:</p>
647
648<pre class="code">
649 MagickBooleanType IsImageObject(const Image *image)
650</pre>
651
652<p>A description of each parameter follows:</p></ol>
653
654<h5>image</h5>
655<ol><p>the image.</p></ol>
656
657 </div>
658<h2><a href="http://www.imagemagick.org/api/MagickCore/image
659_8c.html" target="source" name="IsTaintImage">IsTaintImage</a></h2>
660<div class="doc-section">
661
662<p>IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.</p></ol>
663
664<p>The format of the IsTaintImage method is:</p>
665
666<pre class="code">
667 MagickBooleanType IsTaintImage(const Image *image)
668</pre>
669
670<p>A description of each parameter follows:</p></ol>
671
672<h5>image</h5>
673<ol><p>the image.</p></ol>
674
675 </div>
676<h2><a href="http://www.imagemagick.org/api/MagickCore/image
677_8c.html" target="source" name="ModifyImage">ModifyImage</a></h2>
678<div class="doc-section">
679
680<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>
681
682<p>The format of the ModifyImage method is:</p>
683
684<pre class="code">
685 MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
686</pre>
687
688<p>A description of each parameter follows:</p></ol>
689
690<h5>image</h5>
691<ol><p>the image.</p></ol>
692
693<h5>exception</h5>
694<ol><p>return any errors or warnings in this structure.</p></ol>
695
696 </div>
697<h2><a href="http://www.imagemagick.org/api/MagickCore/image
698_8c.html" target="source" name="NewMagickImage">NewMagickImage</a></h2>
699<div class="doc-section">
700
701<p>NewMagickImage() creates a blank image canvas of the specified size and background color.</p></ol>
702
703<p>The format of the NewMagickImage method is:</p>
704
705<pre class="code">
706 Image *NewMagickImage(const ImageInfo *image_info,
707 const unsigned long width,const unsigned long height,
708 const MagickPixelPacket *background)
709</pre>
710
711<p>A description of each parameter follows:</p></ol>
712
713<h5>image</h5>
714<ol><p>the image.</p></ol>
715
716<h5>width</h5>
717<ol><p>the image width.</p></ol>
718
719<h5>height</h5>
720<ol><p>the image height.</p></ol>
721
722<h5>background</h5>
723<ol><p>the image color.</p></ol>
724
725 </div>
726<h2><a href="http://www.imagemagick.org/api/MagickCore/image
727_8c.html" target="source" name="ReferenceImage">ReferenceImage</a></h2>
728<div class="doc-section">
729
730<p>ReferenceImage() increments the reference count associated with an image returning a pointer to the image.</p></ol>
731
732<p>The format of the ReferenceImage method is:</p>
733
734<pre class="code">
735 Image *ReferenceImage(Image *image)
736</pre>
737
738<p>A description of each parameter follows:</p></ol>
739
740<h5>image</h5>
741<ol><p>the image.</p></ol>
742
743 </div>
744<h2><a href="http://www.imagemagick.org/api/MagickCore/image
745_8c.html" target="source" name="ResetImagePage">ResetImagePage</a></h2>
746<div class="doc-section">
747
748<p>ResetImagePage() resets the image page canvas and position.</p></ol>
749
750<p>The format of the ResetImagePage method is:</p>
751
752<pre class="code">
753 MagickBooleanType ResetImagePage(Image *image,const char *page)
754</pre>
755
756<p>A description of each parameter follows:</p></ol>
757
758<h5>image</h5>
759<ol><p>the image.</p></ol>
760
761<h5>page</h5>
762<ol><p>the relative page specification.</p></ol>
763
764 </div>
765<h2><a href="http://www.imagemagick.org/api/MagickCore/image
766_8c.html" target="source" name="SeparateImageChannel">SeparateImageChannel</a></h2>
767<div class="doc-section">
768
769<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>
770
771<p>The format of the SeparateImageChannel method is:</p>
772
773<pre class="code">
774 MagickBooleanType SeparateImageChannel(Image *image,
775 const ChannelType channel)
776</pre>
777
778<p>A description of each parameter follows:</p></ol>
779
780<h5>image</h5>
781<ol><p>the image.</p></ol>
782
783<h5>channel</h5>
784<ol><p>Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
785
786 </div>
787<h2><a href="http://www.imagemagick.org/api/MagickCore/image
788_8c.html" target="source" name="SeparateImages">SeparateImages</a></h2>
789<div class="doc-section">
790
791<p>SeparateImages() returns a separate grayscale image for each channel specified.</p></ol>
792
793<p>The format of the SeparateImages method is:</p>
794
795<pre class="code">
796 MagickBooleanType SeparateImages(const Image *image,
797 const ChannelType channel,ExceptionInfo *exception)
798</pre>
799
800<p>A description of each parameter follows:</p></ol>
801
802<h5>image</h5>
803<ol><p>the image.</p></ol>
804
805<h5>channel</h5>
806<ol><p>Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
807
808<h5>exception</h5>
809<ol><p>return any errors or warnings in this structure.</p></ol>
810
811 </div>
812<h2><a href="http://www.imagemagick.org/api/MagickCore/image
813_8c.html" target="source" name="SetImageAlphaChannel">SetImageAlphaChannel</a></h2>
814<div class="doc-section">
815
816<p>SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p></ol>
817
818<p>The format of the SetImageAlphaChannel method is:</p>
819
820<pre class="code">
821 MagickBooleanType SetImageAlphaChannel(Image *image,
822 const AlphaChannelType alpha_type)
823</pre>
824
825<p>A description of each parameter follows:</p></ol>
826
827<h5>image</h5>
828<ol><p>the image.</p></ol>
829
830<h5>alpha_type</h5>
831<ol><p>The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.</p></ol>
832
833 </div>
834<h2><a href="http://www.imagemagick.org/api/MagickCore/image
835_8c.html" target="source" name="SetImageBackgroundColor">SetImageBackgroundColor</a></h2>
836<div class="doc-section">
837
838<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>
839
840<p>The format of the SetImage method is:</p>
841
842<pre class="code">
843 MagickBooleanType SetImageBackgroundColor(Image *image)
844</pre>
845
846<p>A description of each parameter follows:</p></ol>
847
848<h5>image</h5>
849<ol><p>the image.</p></ol>
850
851 </div>
852<h2><a href="http://www.imagemagick.org/api/MagickCore/image
853_8c.html" target="source" name="SetImageStorageClass">SetImageStorageClass</a></h2>
854<div class="doc-section">
855
856<p>SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.</p></ol>
857
858<p>The format of the SetImageStorageClass method is:</p>
859
860<pre class="code">
861 MagickBooleanType SetImageStorageClass(Image *image,
862 const ClassType storage_class)
863</pre>
864
865<p>A description of each parameter follows:</p></ol>
866
867<h5>image</h5>
868<ol><p>the image.</p></ol>
869
870<h5>storage_class</h5>
871<ol><p>The image class.</p></ol>
872
873 </div>
874<h2><a href="http://www.imagemagick.org/api/MagickCore/image
875_8c.html" target="source" name="SetImageClipMask">SetImageClipMask</a></h2>
876<div class="doc-section">
877
878<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>
879
880<p>The format of the SetImageClipMask method is:</p>
881
882<pre class="code">
883 MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
884</pre>
885
886<p>A description of each parameter follows:</p></ol>
887
888<h5>image</h5>
889<ol><p>the image.</p></ol>
890
891<h5>clip_mask</h5>
892<ol><p>the image clip path.</p></ol>
893
894 </div>
895<h2><a href="http://www.imagemagick.org/api/MagickCore/image
896_8c.html" target="source" name="SetImageExtent">SetImageExtent</a></h2>
897<div class="doc-section">
898
899<p>SetImageExtent() sets the image size (i.e. columns & rows).</p></ol>
900
901<p>The format of the SetImageExtent method is:</p>
902
903<pre class="code">
904 MagickBooleanType SetImageExtent(Image *image,
905 const unsigned long columns,const unsigned long rows)
906</pre>
907
908<p>A description of each parameter follows:</p></ol>
909
910<h5>image</h5>
911<ol><p>the image.</p></ol>
912
913<h5>columns</h5>
914<ol><p>The image width in pixels.</p></ol>
915
916<h5>rows</h5>
917<ol><p>The image height in pixels.</p></ol>
918
919 </div>
920<h2><a href="http://www.imagemagick.org/api/MagickCore/image
921_8c.html" target="source" name="SetImageInfoBlob">SetImageInfoBlob</a></h2>
922<div class="doc-section">
923
924<p>SetImageInfoBlob() sets the image info blob member.</p></ol>
925
926<p>The format of the SetImageInfoBlob method is:</p>
927
928<pre class="code">
929 void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
930 const size_t length)
931</pre>
932
933<p>A description of each parameter follows:</p></ol>
934
935<h5>image_info</h5>
936<ol><p>the image info.</p></ol>
937
938<h5>blob</h5>
939<ol><p>the blob.</p></ol>
940
941<h5>length</h5>
942<ol><p>the blob length.</p></ol>
943
944 </div>
945<h2><a href="http://www.imagemagick.org/api/MagickCore/image
946_8c.html" target="source" name="SetImageInfoFile">SetImageInfoFile</a></h2>
947<div class="doc-section">
948
949<p>SetImageInfoFile() sets the image info file member.</p></ol>
950
951<p>The format of the SetImageInfoFile method is:</p>
952
953<pre class="code">
954 void SetImageInfoFile(ImageInfo *image_info,FILE *file)
955</pre>
956
957<p>A description of each parameter follows:</p></ol>
958
959<h5>image_info</h5>
960<ol><p>the image info.</p></ol>
961
962<h5>file</h5>
963<ol><p>the file.</p></ol>
964
965 </div>
966<h2><a href="http://www.imagemagick.org/api/MagickCore/image
967_8c.html" target="source" name="SetImageMask">SetImageMask</a></h2>
968<div class="doc-section">
969
970<p>SetImageMask() associates a mask with the image. The mask must be the same dimensions as the image.</p></ol>
971
972<p>The format of the SetImageMask method is:</p>
973
974<pre class="code">
975 MagickBooleanType SetImageMask(Image *image,const Image *mask)
976</pre>
977
978<p>A description of each parameter follows:</p></ol>
979
980<h5>image</h5>
981<ol><p>the image.</p></ol>
982
983<h5>mask</h5>
984<ol><p>the image mask.</p></ol>
985
986 </div>
987<h2><a href="http://www.imagemagick.org/api/MagickCore/image
988_8c.html" target="source" name="SetImageOpacity">SetImageOpacity</a></h2>
989<div class="doc-section">
990
991<p>SetImageOpacity() sets the opacity levels of the image.</p></ol>
992
993<p>The format of the SetImageOpacity method is:</p>
994
995<pre class="code">
996 MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
997</pre>
998
999<p>A description of each parameter follows:</p></ol>
1000
1001<h5>image</h5>
1002<ol><p>the image.</p></ol>
1003
1004<h5>opacity</h5>
1005<ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
1006
1007 </div>
1008<h2><a href="http://www.imagemagick.org/api/MagickCore/image
1009_8c.html" target="source" name="SetImageType">SetImageType</a></h2>
1010<div class="doc-section">
1011
1012<p>SetImageType() sets the type of image. Choose from these types:</p></ol>
1013
1014<p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte OptimizeType</p></ol>
1015
1016<p>The format of the SetImageType method is:</p>
1017
1018<pre class="code">
1019 MagickBooleanType SetImageType(Image *image,const ImageType type)
1020</pre>
1021
1022<p>A description of each parameter follows:</p></ol>
1023
1024<h5>image</h5>
1025<ol><p>the image.</p></ol>
1026
1027<h5>type</h5>
1028<ol><p>Image type.</p></ol>
1029
1030 </div>
1031<h2><a href="http://www.imagemagick.org/api/MagickCore/image
1032_8c.html" target="source" name="SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a></h2>
1033<div class="doc-section">
1034
1035<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>
1036
1037<p>The format of the SetImageVirtualPixelMethod() method is:</p>
1038
1039<pre class="code">
1040 VirtualPixelMethod SetImageVirtualPixelMethod(const Image *image,
1041 const VirtualPixelMethod virtual_pixel_method)
1042</pre>
1043
1044<p>A description of each parameter follows:</p></ol>
1045
1046<h5>image</h5>
1047<ol><p>the image.</p></ol>
1048
1049<h5>virtual_pixel_method</h5>
1050<ol><p>choose the type of virtual pixel.</p></ol>
1051
1052 </div>
1053<h2><a href="http://www.imagemagick.org/api/MagickCore/image
1054_8c.html" target="source" name="StripImage">StripImage</a></h2>
1055<div class="doc-section">
1056
1057<p>StripImage() strips an image of all profiles and comments.</p></ol>
1058
1059<p>The format of the StripImage method is:</p>
1060
1061<pre class="code">
1062 MagickBooleanType StripImage(Image *image)
1063</pre>
1064
1065<p>A description of each parameter follows:</p></ol>
1066
1067<h5>image</h5>
1068<ol><p>the image.</p></ol>
1069
1070 </div>
1071<h2><a href="http://www.imagemagick.org/api/MagickCore/image
1072_8c.html" target="source" name="TextureImage">TextureImage</a></h2>
1073<div class="doc-section">
1074
1075<p>TextureImage() repeatedly tiles the texture image across and down the image canvas.</p></ol>
1076
1077<p>The format of the TextureImage method is:</p>
1078
1079<pre class="code">
1080 MagickBooleanType TextureImage(Image *image,const Image *texture)
1081</pre>
1082
1083<p>A description of each parameter follows:</p></ol>
1084
1085<h5>image</h5>
1086<ol><p>the image.</p></ol>
1087
1088<h5>texture</h5>
1089<ol><p>This image is the texture to layer on the background.</p></ol>
1090
1091 </div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame^]1092
1093</div>
1094
1095<div id="linkbar">
1096 <!-- <span id="linkbar-west">&nbsp;</span> -->
1097 <span id="linkbar-center">
1098 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
1099 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
1100 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
1101 </span>
1102 <span id="linkbar-east">&nbsp;</span>
1103 </div>
1104 <div class="footer">
1105 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
1106 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
1107 </div>
1108 <div style="clear: both; margin: 0; width: 100%; "></div>
1109</body>
1110</html>