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