blob: cbfc7a1bc13d1d06af6005479f0f00f405acbf30 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001<!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 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3de29cc2010-04-15 02:34:44 +00005 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +00006 <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 +00008 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +00009 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +000010 </style>
cristy3ed852e2009-09-05 21:47:34 +000011 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickWand, C API for ImageMagick: Deprecated 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="magickwc, api, for, imagemagick:, deprecated, 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 +000025 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000026 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +000027</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 +000045<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000046
cristy3ed852e2009-09-05 21:47:34 +000047<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000048 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000049</div>
cristy3eaa0ef2010-03-06 20:35:26 +000050<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000051<div class="menu">
cristybb503372010-05-27 20:51:26 +000052 <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 +000065 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000066</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000069</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000072</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000074 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
cristy3eaa0ef2010-03-06 20:35:26 +000091<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000092<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
cristybb503372010-05-27 20:51:26 +0000104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy3ed852e2009-09-05 21:47:34 +0000107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000108 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000124
125<div class="sponsbox">
126<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy320dd6e2010-04-16 20:11:40 +0000128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy5f2356f2009-11-16 00:40:46 +0000134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000136 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristyc1c61662009-09-30 14:04:37 +0000137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000139 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy3ed852e2009-09-05 21:47:34 +0000140</div>
cristyc1aee832010-05-08 00:36:47 +0000141<div class="sponsor">
cristya8902942010-07-30 00:49:52 +0000142 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristyc1aee832010-05-08 00:36:47 +0000143</div>
cristy3ed852e2009-09-05 21:47:34 +0000144</div>
145</div>
cristyce69bb02010-07-27 19:49:46 +0000146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000147
cristyce69bb02010-07-27 19:49:46 +0000148<div class="eastbar">
149 <script type="text/javascript">
150 <!--
151 google_ad_client = "pub-3129977114552745";
152 /* 160x600, created 7/27/10 */
153 google_ad_slot = "0574824969";
154 google_ad_width = 160;
155 google_ad_height = 600;
156 //-->
157 </script>
158 <script type="text/javascript"
159 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
160 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000161</div>
162
163<div class="main">
164
cristyc3ebda22010-06-27 17:11:57 +0000165<p class="navigation-index">[<a href="#MagickAverageImages">MagickAverageImages</a> &bull; <a href="#ClonePixelView">ClonePixelView</a> &bull; <a href="#DestroyPixelView">DestroyPixelView</a> &bull; <a href="#DuplexTransferPixelViewIterator">DuplexTransferPixelViewIterator</a> &bull; <a href="#GetPixelViewException">GetPixelViewException</a> &bull; <a href="#GetPixelViewHeight">GetPixelViewHeight</a> &bull; <a href="#GetPixelViewIterator">GetPixelViewIterator</a> &bull; <a href="#GetPixelViewPixels">GetPixelViewPixels</a> &bull; <a href="#GetPixelViewWand">GetPixelViewWand</a> &bull; <a href="#GetPixelViewWidth">GetPixelViewWidth</a> &bull; <a href="#GetPixelViewX">GetPixelViewX</a> &bull; <a href="#GetPixelViewY">GetPixelViewY</a> &bull; <a href="#IsPixelView">IsPixelView</a> &bull; <a href="#MagickClipPathImage">MagickClipPathImage</a> &bull; <a href="#DrawGetFillAlpha">DrawGetFillAlpha</a> &bull; <a href="#DrawGetStrokeAlpha">DrawGetStrokeAlpha</a> &bull; <a href="#DrawPeekGraphicWand">DrawPeekGraphicWand</a> &bull; <a href="#DrawPopGraphicContext">DrawPopGraphicContext</a> &bull; <a href="#DrawPushGraphicContext">DrawPushGraphicContext</a> &bull; <a href="#DrawSetFillAlpha">DrawSetFillAlpha</a> &bull; <a href="#DrawSetStrokeAlpha">DrawSetStrokeAlpha</a> &bull; <a href="#MagickColorFloodfillImage">MagickColorFloodfillImage</a> &bull; <a href="#MagickDescribeImage">MagickDescribeImage</a> &bull; <a href="#MagickFlattenImages">MagickFlattenImages</a> &bull; <a href="#MagickGetImageAttribute">MagickGetImageAttribute</a> &bull; <a href="#MagickGetImageMatte">MagickGetImageMatte</a> &bull; <a href="#MagickGetImagePixels">MagickGetImagePixels</a> &bull; <a href="#MagickGetImageSize">MagickGetImageSize</a> &bull; <a href="#MagickMapImage">MagickMapImage</a> &bull; <a href="#MagickMatteFloodfillImage">MagickMatteFloodfillImage</a> &bull; <a href="#MagickMaximumImages">MagickMaximumImages</a> &bull; <a href="#MagickMinimumImages">MagickMinimumImages</a> &bull; <a href="#MagickMosaicImages">MagickMosaicImages</a> &bull; <a href="#MagickOpaqueImage">MagickOpaqueImage</a> &bull; <a href="#MagickPaintFloodfillImage">MagickPaintFloodfillImage</a> &bull; <a href="#MagickPaintOpaqueImage">MagickPaintOpaqueImage</a> &bull; <a href="#MagickPaintTransparentImage">MagickPaintTransparentImage</a> &bull; <a href="#MagickRecolorImage">MagickRecolorImage</a> &bull; <a href="#MagickSetImageAttribute">MagickSetImageAttribute</a> &bull; <a href="#MagickSetImageIndex">MagickSetImageIndex</a> &bull; <a href="#MagickTransparentImage">MagickTransparentImage</a> &bull; <a href="#MagickRegionOfInterestImage">MagickRegionOfInterestImage</a> &bull; <a href="#MagickSetImagePixels">MagickSetImagePixels</a> &bull; <a href="#MagickWriteImageBlob">MagickWriteImageBlob</a> &bull; <a href="#NewPixelView">NewPixelView</a> &bull; <a href="#NewPixelViewRegion">NewPixelViewRegion</a> &bull; <a href="#PixelGetNextRow">PixelGetNextRow</a> &bull; <a href="#PixelIteratorGetException">PixelIteratorGetException</a> &bull; <a href="#SetPixelViewIterator">SetPixelViewIterator</a> &bull; <a href="#TransferPixelViewIterator">TransferPixelViewIterator</a> &bull; <a href="#UpdatePixelViewIterator">UpdatePixelViewIterator</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000166
167<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy63fed272010-03-07 19:08:45 +0000168_8c.html" target="source" name="MagickAverageImages">MagickAverageImages</a></h2>
169<div class="doc-section">
170
171<p>MagickAverageImages() average a set of images.</p></ol>
172
173<p>The format of the MagickAverageImages method is:</p>
174
175<pre class="code">
176 MagickWand *MagickAverageImages(MagickWand *wand)
177</pre>
178
179<p>A description of each parameter follows:</p></ol>
180
181<h5>wand</h5>
182<ol><p>the magick wand.</p></ol>
183
184 </div>
185<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristyc3ebda22010-06-27 17:11:57 +0000186_8c.html" target="source" name="ClonePixelView">ClonePixelView</a></h2>
187<div class="doc-section">
188
189<p>ClonePixelView() makes a copy of the specified pixel view.</p></ol>
190
191<p>The format of the ClonePixelView method is:</p>
192
193<pre class="code">
194 PixelView *ClonePixelView(const PixelView *pixel_view)
195</pre>
196
197<p>A description of each parameter follows:</p></ol>
198
199<h5>pixel_view</h5>
200<ol><p>the pixel view.</p></ol>
201
202 </div>
203<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
204_8c.html" target="source" name="DestroyPixelView">DestroyPixelView</a></h2>
205<div class="doc-section">
206
207<p>DestroyPixelView() deallocates memory associated with a pixel view.</p></ol>
208
209<p>The format of the DestroyPixelView method is:</p>
210
211<pre class="code">
212 PixelView *DestroyPixelView(PixelView *pixel_view,
213 const size_t number_wands,const size_t number_threads)
214</pre>
215
216<p>A description of each parameter follows:</p></ol>
217
218<h5>pixel_view</h5>
219<ol><p>the pixel view.</p></ol>
220
221<h5>number_wand</h5>
222<ol><p>the number of pixel wands.</p></ol>
223
224<h5>number_threads</h5>
225<ol><p>number of threads.</p></ol>
226
227 </div>
228<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
229_8c.html" target="source" name="DuplexTransferPixelViewIterator">DuplexTransferPixelViewIterator</a></h2>
230<div class="doc-section">
231
232<p>DuplexTransferPixelViewIterator() iterates over three pixel views in parallel and calls your transfer method for each scanline of the view. The source and duplex pixel region is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. However, the destination pixel view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.</p></ol>
233
234<p>Use this pragma:</p>
235
236<pre class="text">
237 #pragma omp critical
238</pre>
239
240<p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p></ol>
241
242<p>The format of the DuplexTransferPixelViewIterator method is:</p>
243
244<pre class="code">
245 MagickBooleanType DuplexTransferPixelViewIterator(PixelView *source,
246 PixelView *duplex,PixelView *destination,
247 DuplexTransferPixelViewMethod transfer,void *context)
248</pre>
249
250<p>A description of each parameter follows:</p></ol>
251
252<h5>source</h5>
253<ol><p>the source pixel view.</p></ol>
254
255<h5>duplex</h5>
256<ol><p>the duplex pixel view.</p></ol>
257
258<h5>destination</h5>
259<ol><p>the destination pixel view.</p></ol>
260
261<h5>transfer</h5>
262<ol><p>the transfer callback method.</p></ol>
263
264<h5>context</h5>
265<ol><p>the user defined context.</p></ol>
266
267 </div>
268<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
269_8c.html" target="source" name="GetPixelViewException">GetPixelViewException</a></h2>
270<div class="doc-section">
271
272<p>GetPixelViewException() returns the severity, reason, and description of any error that occurs when utilizing a pixel view.</p></ol>
273
274<p>The format of the GetPixelViewException method is:</p>
275
276<pre class="code">
277 char *GetPixelViewException(const PixelWand *pixel_view,
278 ExceptionType *severity)
279</pre>
280
281<p>A description of each parameter follows:</p></ol>
282
283<h5>pixel_view</h5>
284<ol><p>the pixel pixel_view.</p></ol>
285
286<h5>severity</h5>
287<ol><p>the severity of the error is returned here.</p></ol>
288
289 </div>
290<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
291_8c.html" target="source" name="GetPixelViewHeight">GetPixelViewHeight</a></h2>
292<div class="doc-section">
293
294<p>GetPixelViewHeight() returns the pixel view height.</p></ol>
295
296<p>The format of the GetPixelViewHeight method is:</p>
297
298<pre class="code">
299 size_t GetPixelViewHeight(const PixelView *pixel_view)
300</pre>
301
302<p>A description of each parameter follows:</p></ol>
303
304<h5>pixel_view</h5>
305<ol><p>the pixel view.</p></ol>
306
307 </div>
308<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
309_8c.html" target="source" name="GetPixelViewIterator">GetPixelViewIterator</a></h2>
310<div class="doc-section">
311
312<p>GetPixelViewIterator() iterates over the pixel view in parallel and calls your get method for each scanline of the view. The pixel region is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. Any updates to the pixels in your callback are ignored.</p></ol>
313
314<p>Use this pragma:</p>
315
316<pre class="text">
317 #pragma omp critical
318</pre>
319
320<p>to define a section of code in your callback get method that must be executed by a single thread at a time.</p></ol>
321
322<p>The format of the GetPixelViewIterator method is:</p>
323
324<pre class="code">
325 MagickBooleanType GetPixelViewIterator(PixelView *source,
326 GetPixelViewMethod get,void *context)
327</pre>
328
329<p>A description of each parameter follows:</p></ol>
330
331<h5>source</h5>
332<ol><p>the source pixel view.</p></ol>
333
334<h5>get</h5>
335<ol><p>the get callback method.</p></ol>
336
337<h5>context</h5>
338<ol><p>the user defined context.</p></ol>
339
340 </div>
341<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
342_8c.html" target="source" name="GetPixelViewPixels">GetPixelViewPixels</a></h2>
343<div class="doc-section">
344
345<p>GetPixelViewPixels() returns the pixel view pixel_wands.</p></ol>
346
347<p>The format of the GetPixelViewPixels method is:</p>
348
349<pre class="code">
350 PixelWand *GetPixelViewPixels(const PixelView *pixel_view)
351</pre>
352
353<p>A description of each parameter follows:</p></ol>
354
355<h5>pixel_view</h5>
356<ol><p>the pixel view.</p></ol>
357
358 </div>
359<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
360_8c.html" target="source" name="GetPixelViewWand">GetPixelViewWand</a></h2>
361<div class="doc-section">
362
363<p>GetPixelViewWand() returns the magick wand associated with the pixel view.</p></ol>
364
365<p>The format of the GetPixelViewWand method is:</p>
366
367<pre class="code">
368 MagickWand *GetPixelViewWand(const PixelView *pixel_view)
369</pre>
370
371<p>A description of each parameter follows:</p></ol>
372
373<h5>pixel_view</h5>
374<ol><p>the pixel view.</p></ol>
375
376 </div>
377<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
378_8c.html" target="source" name="GetPixelViewWidth">GetPixelViewWidth</a></h2>
379<div class="doc-section">
380
381<p>GetPixelViewWidth() returns the pixel view width.</p></ol>
382
383<p>The format of the GetPixelViewWidth method is:</p>
384
385<pre class="code">
386 size_t GetPixelViewWidth(const PixelView *pixel_view)
387</pre>
388
389<p>A description of each parameter follows:</p></ol>
390
391<h5>pixel_view</h5>
392<ol><p>the pixel view.</p></ol>
393
394 </div>
395<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
396_8c.html" target="source" name="GetPixelViewX">GetPixelViewX</a></h2>
397<div class="doc-section">
398
399<p>GetPixelViewX() returns the pixel view x offset.</p></ol>
400
401<p>The format of the GetPixelViewX method is:</p>
402
403<pre class="code">
404 ssize_t GetPixelViewX(const PixelView *pixel_view)
405</pre>
406
407<p>A description of each parameter follows:</p></ol>
408
409<h5>pixel_view</h5>
410<ol><p>the pixel view.</p></ol>
411
412 </div>
413<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
414_8c.html" target="source" name="GetPixelViewY">GetPixelViewY</a></h2>
415<div class="doc-section">
416
417<p>GetPixelViewY() returns the pixel view y offset.</p></ol>
418
419<p>The format of the GetPixelViewY method is:</p>
420
421<pre class="code">
422 ssize_t GetPixelViewY(const PixelView *pixel_view)
423</pre>
424
425<p>A description of each parameter follows:</p></ol>
426
427<h5>pixel_view</h5>
428<ol><p>the pixel view.</p></ol>
429
430 </div>
431<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
432_8c.html" target="source" name="IsPixelView">IsPixelView</a></h2>
433<div class="doc-section">
434
435<p>IsPixelView() returns MagickTrue if the the parameter is verified as a pixel view container.</p></ol>
436
437<p>The format of the IsPixelView method is:</p>
438
439<pre class="code">
440 MagickBooleanType IsPixelView(const PixelView *pixel_view)
441</pre>
442
443<p>A description of each parameter follows:</p></ol>
444
445<h5>pixel_view</h5>
446<ol><p>the pixel view.</p></ol>
447
448 </div>
449<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy3ed852e2009-09-05 21:47:34 +0000450_8c.html" target="source" name="MagickClipPathImage">MagickClipPathImage</a></h2>
451<div class="doc-section">
452
cristyeaedf062010-05-29 22:36:02 +0000453<p>MagickClipPathImage() clips along the named paths from the 8BIM profile, if present. Later operations take effect inside the path. Id may be a number if preceded with #, to work on a numbered path, e.g., "#1" to use the first path.</p></ol>
cristy3ed852e2009-09-05 21:47:34 +0000454
455<p>The format of the MagickClipPathImage method is:</p>
456
457<pre class="code">
458 MagickBooleanType MagickClipPathImage(MagickWand *wand,
459 const char *pathname,const MagickBooleanType inside)
460</pre>
461
462<p>A description of each parameter follows:</p></ol>
463
464<h5>wand</h5>
465<ol><p>the magick wand.</p></ol>
466
467<h5>pathname</h5>
468<ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
469
470<h5>inside</h5>
471<ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
472
473 </div>
474<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
475_8c.html" target="source" name="DrawGetFillAlpha">DrawGetFillAlpha</a></h2>
476<div class="doc-section">
477
478<p>DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture. Fully opaque is 1.0.</p></ol>
479
480<p>The format of the DrawGetFillAlpha method is:</p>
481
482<pre class="code">
483 double DrawGetFillAlpha(const DrawingWand *wand)
484</pre>
485
486<p>A description of each parameter follows:</p></ol>
487
488<h5>wand</h5>
489<ol><p>the drawing wand.</p></ol>
490
491 </div>
492<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
493_8c.html" target="source" name="DrawGetStrokeAlpha">DrawGetStrokeAlpha</a></h2>
494<div class="doc-section">
495
496<p>DrawGetStrokeAlpha() returns the alpha of stroked object outlines.</p></ol>
497
498<p>The format of the DrawGetStrokeAlpha method is:</p>
499
500<pre class="code">
501 double DrawGetStrokeAlpha(const DrawingWand *wand)
502</pre>
503
504<p>A description of each parameter follows:</p></ol>
505
506<h5>wand</h5>
507<ol><p>the drawing wand. </p>
508 </div>
509<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
510_8c.html" target="source" name="DrawPeekGraphicWand">DrawPeekGraphicWand</a></h2>
511<div class="doc-section">
512
513<p>DrawPeekGraphicWand() returns the current drawing wand.</p></ol>
514
515<p>The format of the PeekDrawingWand method is:</p>
516
517<pre class="code">
518 DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
519</pre>
520
521<p>A description of each parameter follows:</p></ol>
522
523<h5>wand</h5>
524<ol><p>the drawing wand.</p></ol>
525
526 </div>
527<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
528_8c.html" target="source" name="DrawPopGraphicContext">DrawPopGraphicContext</a></h2>
529<div class="doc-section">
530
531<p>DrawPopGraphicContext() destroys the current drawing wand and returns to the previously pushed drawing wand. Multiple drawing wands may exist. It is an error to attempt to pop more drawing wands than have been pushed, and it is proper form to pop all drawing wands which have been pushed.</p></ol>
532
533<p>The format of the DrawPopGraphicContext method is:</p>
534
535<pre class="code">
536 MagickBooleanType DrawPopGraphicContext(DrawingWand *wand)
537</pre>
538
539<p>A description of each parameter follows:</p></ol>
540
541<h5>wand</h5>
542<ol><p>the drawing wand.</p></ol>
543
544 </div>
545<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
546_8c.html" target="source" name="DrawPushGraphicContext">DrawPushGraphicContext</a></h2>
547<div class="doc-section">
548
549<p>DrawPushGraphicContext() clones the current drawing wand to create a new drawing wand. The original drawing wand(s) may be returned to by invoking PopDrawingWand(). The drawing wands are stored on a drawing wand stack. For every Pop there must have already been an equivalent Push.</p></ol>
550
551<p>The format of the DrawPushGraphicContext method is:</p>
552
553<pre class="code">
554 MagickBooleanType DrawPushGraphicContext(DrawingWand *wand)
555</pre>
556
557<p>A description of each parameter follows:</p></ol>
558
559<h5>wand</h5>
560<ol><p>the drawing wand.</p></ol>
561
562 </div>
563<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
564_8c.html" target="source" name="DrawSetFillAlpha">DrawSetFillAlpha</a></h2>
565<div class="doc-section">
566
567<p>DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture. Fully opaque is 1.0.</p></ol>
568
569<p>The format of the DrawSetFillAlpha method is:</p>
570
571<pre class="code">
572 void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
573</pre>
574
575<p>A description of each parameter follows:</p></ol>
576
577<h5>wand</h5>
578<ol><p>the drawing wand.</p></ol>
579
580<h5>fill_alpha</h5>
581<ol><p>fill alpha</p></ol>
582
583 </div>
584<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
585_8c.html" target="source" name="DrawSetStrokeAlpha">DrawSetStrokeAlpha</a></h2>
586<div class="doc-section">
587
588<p>DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.</p></ol>
589
590<p>The format of the DrawSetStrokeAlpha method is:</p>
591
592<pre class="code">
593 void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
594</pre>
595
596<p>A description of each parameter follows:</p></ol>
597
598<h5>wand</h5>
599<ol><p>the drawing wand.</p></ol>
600
601<h5>stroke_alpha</h5>
602<ol><p>stroke alpha. The value 1.0 is opaque.</p></ol>
603
604 </div>
605<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
606_8c.html" target="source" name="MagickColorFloodfillImage">MagickColorFloodfillImage</a></h2>
607<div class="doc-section">
608
609<p>MagickColorFloodfillImage() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.</p></ol>
610
611<p>The format of the MagickColorFloodfillImage method is:</p>
612
613<pre class="code">
614 MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
615 const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
cristybb503372010-05-27 20:51:26 +0000616 const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000617</pre>
618
619<p>A description of each parameter follows:</p></ol>
620
621<h5>wand</h5>
622<ol><p>the magick wand.</p></ol>
623
624<h5>fill</h5>
625<ol><p>the floodfill color pixel wand.</p></ol>
626
627<h5>fuzz</h5>
628<ol><p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p></ol>
629
630<h5>bordercolor</h5>
631<ol><p>the border color pixel wand.</p></ol>
632
633<h5>x,y</h5>
634<ol><p>the starting location of the operation.</p></ol>
635
636 </div>
637<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
638_8c.html" target="source" name="MagickDescribeImage">MagickDescribeImage</a></h2>
639<div class="doc-section">
640
641<p>MagickDescribeImage() identifies an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p></ol>
642
643<p>The format of the MagickDescribeImage method is:</p>
644
645<pre class="code">
646 const char *MagickDescribeImage(MagickWand *wand)
647</pre>
648
649<p>A description of each parameter follows:</p></ol>
650
651<h5>wand</h5>
652<ol><p>the magick wand.</p></ol>
653
654 </div>
655<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
656_8c.html" target="source" name="MagickFlattenImages">MagickFlattenImages</a></h2>
657<div class="doc-section">
658
659<p>MagickFlattenImages() merges a sequence of images. This useful for combining Photoshop layers into a single image.</p></ol>
660
661<p>The format of the MagickFlattenImages method is:</p>
662
663<pre class="code">
664 MagickWand *MagickFlattenImages(MagickWand *wand)
665</pre>
666
667<p>A description of each parameter follows:</p></ol>
668
669<h5>wand</h5>
670<ol><p>the magick wand.</p></ol>
671
672 </div>
673<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
674_8c.html" target="source" name="MagickGetImageAttribute">MagickGetImageAttribute</a></h2>
675<div class="doc-section">
676
677<p>MagickGetImageAttribute() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
678
679<p>The format of the MagickGetImageAttribute method is:</p>
680
681<pre class="code">
682 char *MagickGetImageAttribute(MagickWand *wand,const char *property)
683</pre>
684
685<p>A description of each parameter follows:</p></ol>
686
687<h5>wand</h5>
688<ol><p>the magick wand.</p></ol>
689
690<h5>property</h5>
691<ol><p>the property.</p></ol>
692
693 </div>
694<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
695_8c.html" target="source" name="MagickGetImageMatte">MagickGetImageMatte</a></h2>
696<div class="doc-section">
697
698<p>MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.</p></ol>
699
700<p>The format of the MagickGetImageMatte method is:</p>
701
702<pre class="code">
cristybb503372010-05-27 20:51:26 +0000703 size_t MagickGetImageMatte(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000704</pre>
705
706<p>A description of each parameter follows:</p></ol>
707
708<h5>wand</h5>
709<ol><p>the magick wand.</p></ol>
710
711 </div>
712<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
713_8c.html" target="source" name="MagickGetImagePixels">MagickGetImagePixels</a></h2>
714<div class="doc-section">
715
cristybb503372010-05-27 20:51:26 +0000716<p>MagickGetImagePixels() extracts pixel data from an image and returns it to you. The method returns MagickTrue on success otherwise MagickFalse if an error is encountered. The data is returned as char, short int, int, ssize_t, float, or double in the order specified by map.</p></ol>
cristy3ed852e2009-09-05 21:47:34 +0000717
718<p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
719
720<pre class="text">
721 MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
722</pre>
723
724<p>The format of the MagickGetImagePixels method is:</p>
725
726<pre class="code">
727 MagickBooleanType MagickGetImagePixels(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000728 const ssize_t x,const ssize_t y,const size_t columns,
729 const size_t rows,const char *map,const StorageType storage,
cristy3ed852e2009-09-05 21:47:34 +0000730 void *pixels)
731</pre>
732
733<p>A description of each parameter follows:</p></ol>
734
735<h5>wand</h5>
736<ol><p>the magick wand.</p></ol>
737
738<h5>x, y, columns, rows</h5>
739<ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
740
741<h5>map</h5>
742<ol><p>This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.</p></ol>
743
744<h5>storage</h5>
745<ol><p>Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel, LongPixel, QuantumPixel, or ShortPixel.</p></ol>
746
747<h5>pixels</h5>
748<ol><p>This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.</p></ol>
749
750 </div>
751<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
752_8c.html" target="source" name="MagickGetImageSize">MagickGetImageSize</a></h2>
753<div class="doc-section">
754
755<p>MagickGetImageSize() returns the image length in bytes.</p></ol>
756
757<p>The format of the MagickGetImageSize method is:</p>
758
759<pre class="code">
760 MagickBooleanType MagickGetImageSize(MagickWand *wand,
761 MagickSizeType *length)
762</pre>
763
764<p>A description of each parameter follows:</p></ol>
765
766<h5>wand</h5>
767<ol><p>the magick wand.</p></ol>
768
769<h5>length</h5>
770<ol><p>the image length in bytes.</p></ol>
771
772 </div>
773<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
774_8c.html" target="source" name="MagickMapImage">MagickMapImage</a></h2>
775<div class="doc-section">
776
777<p>MagickMapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
778
779<p>The format of the MagickMapImage method is:</p>
780
781<pre class="code">
782 MagickBooleanType MagickMapImage(MagickWand *wand,
783 const MagickWand *map_wand,const MagickBooleanType dither)
784</pre>
785
786<p>A description of each parameter follows:</p></ol>
787
788<h5>wand</h5>
789<ol><p>the magick wand.</p></ol>
790
791<h5>map</h5>
792<ol><p>the map wand.</p></ol>
793
794<h5>dither</h5>
795<ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
796
797 </div>
798<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
799_8c.html" target="source" name="MagickMatteFloodfillImage">MagickMatteFloodfillImage</a></h2>
800<div class="doc-section">
801
802<p>MagickMatteFloodfillImage() changes the transparency value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the transparency value is changed for any neighbor pixel that does not match the bordercolor member of image.</p></ol>
803
804<p>The format of the MagickMatteFloodfillImage method is:</p>
805
806<pre class="code">
807 MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
808 const double alpha,const double fuzz,const PixelWand *bordercolor,
cristybb503372010-05-27 20:51:26 +0000809 const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000810</pre>
811
812<p>A description of each parameter follows:</p></ol>
813
814<h5>wand</h5>
815<ol><p>the magick wand.</p></ol>
816
817<h5>alpha</h5>
818<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
819
820<h5>fuzz</h5>
821<ol><p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p></ol>
822
823<h5>bordercolor</h5>
824<ol><p>the border color pixel wand.</p></ol>
825
826<h5>x,y</h5>
827<ol><p>the starting location of the operation.</p></ol>
828
829 </div>
830<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy63fed272010-03-07 19:08:45 +0000831_8c.html" target="source" name="MagickMaximumImages">MagickMaximumImages</a></h2>
832<div class="doc-section">
833
834<p>MagickMaximumImages() returns the maximum intensity of an image sequence.</p></ol>
835
836<p>The format of the MagickMaximumImages method is:</p>
837
838<pre class="code">
839 MagickWand *MagickMaximumImages(MagickWand *wand)
840</pre>
841
842<p>A description of each parameter follows:</p></ol>
843
844<h5>wand</h5>
845<ol><p>the magick wand.</p></ol>
846
847 </div>
848<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
849_8c.html" target="source" name="MagickMinimumImages">MagickMinimumImages</a></h2>
850<div class="doc-section">
851
852<p>MagickMinimumImages() returns the minimum intensity of an image sequence.</p></ol>
853
854<p>The format of the MagickMinimumImages method is:</p>
855
856<pre class="code">
857 MagickWand *MagickMinimumImages(MagickWand *wand)
858</pre>
859
860<p>A description of each parameter follows:</p></ol>
861
862<h5>wand</h5>
863<ol><p>the magick wand.</p></ol>
864
865 </div>
866<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy3ed852e2009-09-05 21:47:34 +0000867_8c.html" target="source" name="MagickMosaicImages">MagickMosaicImages</a></h2>
868<div class="doc-section">
869
870<p>MagickMosaicImages() inlays an image sequence to form a single coherent picture. It returns a wand with each image in the sequence composited at the location defined by the page offset of the image.</p></ol>
871
872<p>The format of the MagickMosaicImages method is:</p>
873
874<pre class="code">
875 MagickWand *MagickMosaicImages(MagickWand *wand)
876</pre>
877
878<p>A description of each parameter follows:</p></ol>
879
880<h5>wand</h5>
881<ol><p>the magick wand.</p></ol>
882
883 </div>
884<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
885_8c.html" target="source" name="MagickOpaqueImage">MagickOpaqueImage</a></h2>
886<div class="doc-section">
887
888<p>MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
889
890<p>The format of the MagickOpaqueImage method is:</p>
891
892<pre class="code">
893 MagickBooleanType MagickOpaqueImage(MagickWand *wand,
894 const PixelWand *target,const PixelWand *fill,const double fuzz)
895</pre>
896
897<p>A description of each parameter follows:</p></ol>
898
899<h5>wand</h5>
900<ol><p>the magick wand.</p></ol>
901
902<h5>channel</h5>
903<ol><p>the channel(s).</p></ol>
904
905<h5>target</h5>
906<ol><p>Change this target color to the fill color within the image.</p></ol>
907
908<h5>fill</h5>
909<ol><p>the fill pixel wand.</p></ol>
910
911<h5>fuzz</h5>
912<ol><p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p></ol>
913
914 </div>
915<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
916_8c.html" target="source" name="MagickPaintFloodfillImage">MagickPaintFloodfillImage</a></h2>
917<div class="doc-section">
918
919<p>MagickPaintFloodfillImage() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.</p></ol>
920
921<p>The format of the MagickPaintFloodfillImage method is:</p>
922
923<pre class="code">
924 MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
925 const ChannelType channel,const PixelWand *fill,const double fuzz,
cristybb503372010-05-27 20:51:26 +0000926 const PixelWand *bordercolor,const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000927</pre>
928
929<p>A description of each parameter follows:</p></ol>
930
931<h5>wand</h5>
932<ol><p>the magick wand.</p></ol>
933
934<h5>channel</h5>
935<ol><p>the channel(s).</p></ol>
936
937<h5>fill</h5>
938<ol><p>the floodfill color pixel wand.</p></ol>
939
940<h5>fuzz</h5>
941<ol><p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p></ol>
942
943<h5>bordercolor</h5>
944<ol><p>the border color pixel wand.</p></ol>
945
946<h5>x,y</h5>
947<ol><p>the starting location of the operation.</p></ol>
948
949 </div>
950<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
951_8c.html" target="source" name="MagickPaintOpaqueImage">MagickPaintOpaqueImage</a></h2>
952<div class="doc-section">
953
954<p>MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
955
956<p>The format of the MagickPaintOpaqueImage method is:</p>
957
958<pre class="code">
959 MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
960 const PixelWand *target,const PixelWand *fill,const double fuzz)
961 MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
962 const ChannelType channel,const PixelWand *target,
963 const PixelWand *fill,const double fuzz)
964</pre>
965
966<p>A description of each parameter follows:</p></ol>
967
968<h5>wand</h5>
969<ol><p>the magick wand.</p></ol>
970
971<h5>channel</h5>
972<ol><p>the channel(s).</p></ol>
973
974<h5>target</h5>
975<ol><p>Change this target color to the fill color within the image.</p></ol>
976
977<h5>fill</h5>
978<ol><p>the fill pixel wand.</p></ol>
979
980<h5>fuzz</h5>
981<ol><p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p></ol>
982
983 </div>
984<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
985_8c.html" target="source" name="MagickPaintTransparentImage">MagickPaintTransparentImage</a></h2>
986<div class="doc-section">
987
988<p>MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
989
990<p>The format of the MagickPaintTransparentImage method is:</p>
991
992<pre class="code">
993 MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
994 const PixelWand *target,const double alpha,const double fuzz)
995</pre>
996
997<p>A description of each parameter follows:</p></ol>
998
999<h5>wand</h5>
1000<ol><p>the magick wand.</p></ol>
1001
1002<h5>target</h5>
1003<ol><p>Change this target color to specified opacity value within the image.</p></ol>
1004
1005<h5>alpha</h5>
1006<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
1007
1008<h5>fuzz</h5>
1009<ol><p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p></ol>
1010
1011 </div>
1012<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy0291e2d2010-04-04 17:50:18 +00001013_8c.html" target="source" name="MagickRecolorImage">MagickRecolorImage</a></h2>
1014<div class="doc-section">
1015
1016<p>MagickRecolorImage() apply color transformation to an image. The method permits saturation changes, hue rotation, luminance to alpha, and various other effects. Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255).</p></ol>
1017
1018<p>The format of the MagickRecolorImage method is:</p>
1019
1020<pre class="code">
1021 MagickBooleanType MagickRecolorImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +00001022 const size_t order,const double *color_matrix)
cristy0291e2d2010-04-04 17:50:18 +00001023</pre>
1024
1025<p>A description of each parameter follows:</p></ol>
1026
1027<h5>wand</h5>
1028<ol><p>the magick wand.</p></ol>
1029
1030<h5>order</h5>
1031<ol><p>the number of columns and rows in the color matrix.</p></ol>
1032
1033<h5>color_matrix</h5>
1034<ol><p>An array of doubles representing the color matrix.</p></ol>
1035
1036 </div>
1037<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy3ed852e2009-09-05 21:47:34 +00001038_8c.html" target="source" name="MagickSetImageAttribute">MagickSetImageAttribute</a></h2>
1039<div class="doc-section">
1040
1041<p>MagickSetImageAttribute() associates a property with an image.</p></ol>
1042
1043<p>The format of the MagickSetImageAttribute method is:</p>
1044
1045<pre class="code">
1046 MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
1047 const char *property,const char *value)
1048</pre>
1049
1050<p>A description of each parameter follows:</p></ol>
1051
1052<h5>wand</h5>
1053<ol><p>the magick wand.</p></ol>
1054
1055<h5>property</h5>
1056<ol><p>the property.</p></ol>
1057
1058<h5>value</h5>
1059<ol><p>the value.</p></ol>
1060
1061 </div>
1062<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1063_8c.html" target="source" name="MagickSetImageIndex">MagickSetImageIndex</a></h2>
1064<div class="doc-section">
1065
1066<p>MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.</p></ol>
1067
1068<p>The format of the MagickSetImageIndex method is:</p>
1069
1070<pre class="code">
cristybb503372010-05-27 20:51:26 +00001071 MagickBooleanType MagickSetImageIndex(MagickWand *wand,const ssize_t index)
cristy3ed852e2009-09-05 21:47:34 +00001072</pre>
1073
1074<p>A description of each parameter follows:</p></ol>
1075
1076<h5>wand</h5>
1077<ol><p>the magick wand.</p></ol>
1078
1079<h5>index</h5>
1080<ol><p>the scene number.</p></ol>
1081
1082 </div>
1083<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1084_8c.html" target="source" name="MagickTransparentImage">MagickTransparentImage</a></h2>
1085<div class="doc-section">
1086
1087<p>MagickTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
1088
1089<p>The format of the MagickTransparentImage method is:</p>
1090
1091<pre class="code">
1092 MagickBooleanType MagickTransparentImage(MagickWand *wand,
1093 const PixelWand *target,const double alpha,const double fuzz)
1094</pre>
1095
1096<p>A description of each parameter follows:</p></ol>
1097
1098<h5>wand</h5>
1099<ol><p>the magick wand.</p></ol>
1100
1101<h5>target</h5>
1102<ol><p>Change this target color to specified opacity value within the image.</p></ol>
1103
1104<h5>alpha</h5>
1105<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
1106
1107<h5>fuzz</h5>
1108<ol><p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p></ol>
1109
1110 </div>
1111<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1112_8c.html" target="source" name="MagickRegionOfInterestImage">MagickRegionOfInterestImage</a></h2>
1113<div class="doc-section">
1114
1115<p>MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.</p></ol>
1116
1117<p>The format of the MagickRegionOfInterestImage method is:</p>
1118
1119<pre class="code">
1120 MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +00001121 const size_t width,const size_t height,const ssize_t x,
1122 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +00001123</pre>
1124
1125<p>A description of each parameter follows:</p></ol>
1126
1127<h5>wand</h5>
1128<ol><p>the magick wand.</p></ol>
1129
1130<h5>width</h5>
1131<ol><p>the region width.</p></ol>
1132
1133<h5>height</h5>
1134<ol><p>the region height.</p></ol>
1135
1136<h5>x</h5>
1137<ol><p>the region x offset.</p></ol>
1138
1139<h5>y</h5>
1140<ol><p>the region y offset.</p></ol>
1141
1142 </div>
1143<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1144_8c.html" target="source" name="MagickSetImagePixels">MagickSetImagePixels</a></h2>
1145<div class="doc-section">
1146
cristybb503372010-05-27 20:51:26 +00001147<p>MagickSetImagePixels() accepts pixel datand stores it in the image at the location you specify. The method returns MagickFalse on success otherwise MagickTrue if an error is encountered. The pixel data can be either char, short int, int, ssize_t, float, or double in the order specified by map.</p></ol>
cristy3ed852e2009-09-05 21:47:34 +00001148
1149<p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
1150
1151<pre class="text">
1152 MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
1153</pre>
1154
1155<p>The format of the MagickSetImagePixels method is:</p>
1156
1157<pre class="code">
1158 MagickBooleanType MagickSetImagePixels(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +00001159 const ssize_t x,const ssize_t y,const size_t columns,
1160 const size_t rows,const char *map,const StorageType storage,
cristy3ed852e2009-09-05 21:47:34 +00001161 const void *pixels)
1162</pre>
1163
1164<p>A description of each parameter follows:</p></ol>
1165
1166<h5>wand</h5>
1167<ol><p>the magick wand.</p></ol>
1168
1169<h5>x, y, columns, rows</h5>
1170<ol><p>These values define the perimeter of a region of pixels you want to define.</p></ol>
1171
1172<h5>map</h5>
1173<ol><p>This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.</p></ol>
1174
1175<h5>storage</h5>
1176<ol><p>Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, ShortPixel, IntegerPixel, LongPixel, FloatPixel, or DoublePixel.</p></ol>
1177
1178<h5>pixels</h5>
1179<ol><p>This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.</p></ol>
1180
1181 </div>
1182<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1183_8c.html" target="source" name="MagickWriteImageBlob">MagickWriteImageBlob</a></h2>
1184<div class="doc-section">
1185
1186<p>MagickWriteImageBlob() implements direct to memory image formats. It returns the image as a blob and its length. Use MagickSetFormat() to set the format of the returned blob (GIF, JPEG, PNG, etc.).</p></ol>
1187
1188<p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p></ol>
1189
1190<p>The format of the MagickWriteImageBlob method is:</p>
1191
1192<pre class="code">
1193 unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
1194</pre>
1195
1196<p>A description of each parameter follows:</p></ol>
1197
1198<h5>wand</h5>
1199<ol><p>the magick wand.</p></ol>
1200
1201<h5>length</h5>
1202<ol><p>the length of the blob.</p></ol>
1203
1204 </div>
1205<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristyc3ebda22010-06-27 17:11:57 +00001206_8c.html" target="source" name="NewPixelView">NewPixelView</a></h2>
1207<div class="doc-section">
1208
1209<p>NewPixelView() returns a pixel view required for all other methods in the Pixel View API.</p></ol>
1210
1211<p>The format of the NewPixelView method is:</p>
1212
1213<pre class="code">
1214 PixelView *NewPixelView(MagickWand *wand)
1215</pre>
1216
1217<p>A description of each parameter follows:</p></ol>
1218
1219<h5>wand</h5>
1220<ol><p>the wand.</p></ol>
1221
1222 </div>
1223<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1224_8c.html" target="source" name="NewPixelViewRegion">NewPixelViewRegion</a></h2>
1225<div class="doc-section">
1226
1227<p>NewPixelViewRegion() returns a pixel view required for all other methods in the Pixel View API.</p></ol>
1228
1229<p>The format of the NewPixelViewRegion method is:</p>
1230
1231<pre class="code">
1232 PixelView *NewPixelViewRegion(MagickWand *wand,const ssize_t x,
1233 const ssize_t y,const size_t width,const size_t height)
1234</pre>
1235
1236<p>A description of each parameter follows:</p></ol>
1237
1238<h5>wand</h5>
1239<ol><p>the magick wand.</p></ol>
1240
1241<h5>x,y,columns,rows</h5>
1242<ol><p>These values define the perimeter of a region of pixel_wands view.</p></ol>
1243
1244 </div>
1245<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy3ed852e2009-09-05 21:47:34 +00001246_8c.html" target="source" name="PixelGetNextRow">PixelGetNextRow</a></h2>
1247<div class="doc-section">
1248
1249<p>PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
1250
1251<p>The format of the PixelGetNextRow method is:</p>
1252
1253<pre class="code">
1254 PixelWand **PixelGetNextRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +00001255 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +00001256</pre>
1257
1258<p>A description of each parameter follows:</p></ol>
1259
1260<h5>iterator</h5>
1261<ol><p>the pixel iterator.</p></ol>
1262
1263<h5>number_wands</h5>
1264<ol><p>the number of pixel wands.</p></ol>
1265
1266 </div>
1267<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1268_8c.html" target="source" name="PixelIteratorGetException">PixelIteratorGetException</a></h2>
1269<div class="doc-section">
1270
1271<p>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
1272
1273<p>The format of the PixelIteratorGetException method is:</p>
1274
1275<pre class="code">
1276 char *PixelIteratorGetException(const Pixeliterator *iterator,
1277 ExceptionType *severity)
1278</pre>
1279
1280<p>A description of each parameter follows:</p></ol>
1281
1282<h5>iterator</h5>
1283<ol><p>the pixel iterator.</p></ol>
1284
1285<h5>severity</h5>
1286<ol><p>the severity of the error is returned here.</p></ol>
1287
1288 </div>
cristyc3ebda22010-06-27 17:11:57 +00001289<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1290_8c.html" target="source" name="SetPixelViewIterator">SetPixelViewIterator</a></h2>
1291<div class="doc-section">
1292
1293<p>SetPixelViewIterator() iterates over the pixel view in parallel and calls your set method for each scanline of the view. The pixel region is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension. The pixels are initiallly undefined and any settings you make in the callback method are automagically synced back to your image.</p></ol>
1294
1295<p>Use this pragma:</p>
1296
1297<pre class="text">
1298 #pragma omp critical
1299</pre>
1300
1301<p>to define a section of code in your callback set method that must be executed by a single thread at a time.</p></ol>
1302
1303<p>The format of the SetPixelViewIterator method is:</p>
1304
1305<pre class="code">
1306 MagickBooleanType SetPixelViewIterator(PixelView *destination,
1307 SetPixelViewMethod set,void *context)
1308</pre>
1309
1310<p>A description of each parameter follows:</p></ol>
1311
1312<h5>destination</h5>
1313<ol><p>the pixel view.</p></ol>
1314
1315<h5>set</h5>
1316<ol><p>the set callback method.</p></ol>
1317
1318<h5>context</h5>
1319<ol><p>the user defined context.</p></ol>
1320
1321 </div>
1322<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1323_8c.html" target="source" name="TransferPixelViewIterator">TransferPixelViewIterator</a></h2>
1324<div class="doc-section">
1325
1326<p>TransferPixelViewIterator() iterates over two pixel views in parallel and calls your transfer method for each scanline of the view. The source pixel region is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. However, the destination pixel view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.</p></ol>
1327
1328<p>Use this pragma:</p>
1329
1330<pre class="text">
1331 #pragma omp critical
1332</pre>
1333
1334<p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p></ol>
1335
1336<p>The format of the TransferPixelViewIterator method is:</p>
1337
1338<pre class="code">
1339 MagickBooleanType TransferPixelViewIterator(PixelView *source,
1340 PixelView *destination,TransferPixelViewMethod transfer,void *context)
1341</pre>
1342
1343<p>A description of each parameter follows:</p></ol>
1344
1345<h5>source</h5>
1346<ol><p>the source pixel view.</p></ol>
1347
1348<h5>destination</h5>
1349<ol><p>the destination pixel view.</p></ol>
1350
1351<h5>transfer</h5>
1352<ol><p>the transfer callback method.</p></ol>
1353
1354<h5>context</h5>
1355<ol><p>the user defined context.</p></ol>
1356
1357 </div>
1358<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1359_8c.html" target="source" name="UpdatePixelViewIterator">UpdatePixelViewIterator</a></h2>
1360<div class="doc-section">
1361
1362<p>UpdatePixelViewIterator() iterates over the pixel view in parallel and calls your update method for each scanline of the view. The pixel region is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted. Updates to pixels in your callback are automagically synced back to the image.</p></ol>
1363
1364<p>Use this pragma:</p>
1365
1366<pre class="text">
1367 #pragma omp critical
1368</pre>
1369
1370<p>to define a section of code in your callback update method that must be executed by a single thread at a time.</p></ol>
1371
1372<p>The format of the UpdatePixelViewIterator method is:</p>
1373
1374<pre class="code">
1375 MagickBooleanType UpdatePixelViewIterator(PixelView *source,
1376 UpdatePixelViewMethod update,void *context)
1377</pre>
1378
1379<p>A description of each parameter follows:</p></ol>
1380
1381<h5>source</h5>
1382<ol><p>the source pixel view.</p></ol>
1383
1384<h5>update</h5>
1385<ol><p>the update callback method.</p></ol>
1386
1387<h5>context</h5>
1388<ol><p>the user defined context.</p></ol>
1389
1390 </div>
cristy3eaa0ef2010-03-06 20:35:26 +00001391
1392</div>
1393
1394<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00001395 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00001396 <span id="linkbar-center">
1397 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00001398 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00001399 </span>
1400 <span id="linkbar-east">&nbsp;</span>
1401 </div>
1402 <div class="footer">
1403 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
1404 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
1405 </div>
1406 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00001407 <script type="text/javascript">
1408 var _gaq = _gaq || [];
1409 _gaq.push(['_setAccount', 'UA-17690367-1']);
1410 _gaq.push(['_trackPageview']);
1411
1412 (function() {
1413 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
1414 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
1415 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
1416 })();
1417 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00001418</body>
1419</html>