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