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