blob: 57752d3f0d79db5e13074c1ebda3896a0775b267 [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>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +00007 <title>ImageMagick: MagickWand, C API for ImageMagick: Deprecated Methods</title>
cristy3ed852e2009-09-05 21:47:34 +00008 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000011 <meta name="Application-name" content="ImageMagick"/>
cristyffb69ed2010-12-25 00:06:48 +000012 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000013 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000014 <meta name="Generator" content="PHP"/>
15 <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"/>
cristy3ed852e2009-09-05 21:47:34 +000016 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +000022 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000023 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +000024 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +000030</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +000048<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000049
cristy3ed852e2009-09-05 21:47:34 +000050<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000051 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000052</div>
cristy3eaa0ef2010-03-06 20:35:26 +000053<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000054<div class="menu">
cristybb503372010-05-27 20:51:26 +000055 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</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: Processing" href="../../www/command-line-processing.html">Processing</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: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000092 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000093</div>
cristy3eaa0ef2010-03-06 20:35:26 +000094<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000095<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source" href="../../www/install-source.html">Install from Source</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: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
cristybb503372010-05-27 20:51:26 +0000107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000118<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000119 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
121<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000122 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000127
128<div class="sponsbox">
129<div class="sponsor">
cristy307ba182010-12-25 01:00:34 +0000130 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011040100025 atlas.multimedia-->
cristy7d52cd62010-10-01 17:26:59 +0000131</div>
132<div class="sponsor">
133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy320dd6e2010-04-16 20:11:40 +0000143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristyc1c61662009-09-30 14:04:37 +0000149</div>
cristy3ed852e2009-09-05 21:47:34 +0000150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000153
cristyce69bb02010-07-27 19:49:46 +0000154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000166</div>
167
168<div class="main">
169
cristy307ba182010-12-25 01:00:34 +0000170<h1>Module deprecate
171 Methods</h1>
cristyc3ebda22010-06-27 17:11:57 +0000172<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 +0000173
174<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy63fed272010-03-07 19:08:45 +0000175_8c.html" target="source" name="MagickAverageImages">MagickAverageImages</a></h2>
176<div class="doc-section">
177
178<p>MagickAverageImages() average a set of images.</p></ol>
179
180<p>The format of the MagickAverageImages method is:</p>
181
182<pre class="code">
183 MagickWand *MagickAverageImages(MagickWand *wand)
184</pre>
185
186<p>A description of each parameter follows:</p></ol>
187
188<h5>wand</h5>
189<ol><p>the magick wand.</p></ol>
190
191 </div>
192<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristyc3ebda22010-06-27 17:11:57 +0000193_8c.html" target="source" name="ClonePixelView">ClonePixelView</a></h2>
194<div class="doc-section">
195
196<p>ClonePixelView() makes a copy of the specified pixel view.</p></ol>
197
198<p>The format of the ClonePixelView method is:</p>
199
200<pre class="code">
201 PixelView *ClonePixelView(const PixelView *pixel_view)
202</pre>
203
204<p>A description of each parameter follows:</p></ol>
205
206<h5>pixel_view</h5>
207<ol><p>the pixel view.</p></ol>
208
209 </div>
210<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
211_8c.html" target="source" name="DestroyPixelView">DestroyPixelView</a></h2>
212<div class="doc-section">
213
214<p>DestroyPixelView() deallocates memory associated with a pixel view.</p></ol>
215
216<p>The format of the DestroyPixelView method is:</p>
217
218<pre class="code">
219 PixelView *DestroyPixelView(PixelView *pixel_view,
220 const size_t number_wands,const size_t number_threads)
221</pre>
222
223<p>A description of each parameter follows:</p></ol>
224
225<h5>pixel_view</h5>
226<ol><p>the pixel view.</p></ol>
227
228<h5>number_wand</h5>
229<ol><p>the number of pixel wands.</p></ol>
230
231<h5>number_threads</h5>
232<ol><p>number of threads.</p></ol>
233
234 </div>
235<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
236_8c.html" target="source" name="DuplexTransferPixelViewIterator">DuplexTransferPixelViewIterator</a></h2>
237<div class="doc-section">
238
239<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>
240
241<p>Use this pragma:</p>
242
243<pre class="text">
244 #pragma omp critical
245</pre>
246
247<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>
248
249<p>The format of the DuplexTransferPixelViewIterator method is:</p>
250
251<pre class="code">
252 MagickBooleanType DuplexTransferPixelViewIterator(PixelView *source,
253 PixelView *duplex,PixelView *destination,
254 DuplexTransferPixelViewMethod transfer,void *context)
255</pre>
256
257<p>A description of each parameter follows:</p></ol>
258
259<h5>source</h5>
260<ol><p>the source pixel view.</p></ol>
261
262<h5>duplex</h5>
263<ol><p>the duplex pixel view.</p></ol>
264
265<h5>destination</h5>
266<ol><p>the destination pixel view.</p></ol>
267
268<h5>transfer</h5>
269<ol><p>the transfer callback method.</p></ol>
270
271<h5>context</h5>
272<ol><p>the user defined context.</p></ol>
273
274 </div>
275<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
276_8c.html" target="source" name="GetPixelViewException">GetPixelViewException</a></h2>
277<div class="doc-section">
278
279<p>GetPixelViewException() returns the severity, reason, and description of any error that occurs when utilizing a pixel view.</p></ol>
280
281<p>The format of the GetPixelViewException method is:</p>
282
283<pre class="code">
284 char *GetPixelViewException(const PixelWand *pixel_view,
285 ExceptionType *severity)
286</pre>
287
288<p>A description of each parameter follows:</p></ol>
289
290<h5>pixel_view</h5>
291<ol><p>the pixel pixel_view.</p></ol>
292
293<h5>severity</h5>
294<ol><p>the severity of the error is returned here.</p></ol>
295
296 </div>
297<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
298_8c.html" target="source" name="GetPixelViewHeight">GetPixelViewHeight</a></h2>
299<div class="doc-section">
300
301<p>GetPixelViewHeight() returns the pixel view height.</p></ol>
302
303<p>The format of the GetPixelViewHeight method is:</p>
304
305<pre class="code">
306 size_t GetPixelViewHeight(const PixelView *pixel_view)
307</pre>
308
309<p>A description of each parameter follows:</p></ol>
310
311<h5>pixel_view</h5>
312<ol><p>the pixel view.</p></ol>
313
314 </div>
315<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
316_8c.html" target="source" name="GetPixelViewIterator">GetPixelViewIterator</a></h2>
317<div class="doc-section">
318
319<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>
320
321<p>Use this pragma:</p>
322
323<pre class="text">
324 #pragma omp critical
325</pre>
326
327<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>
328
329<p>The format of the GetPixelViewIterator method is:</p>
330
331<pre class="code">
332 MagickBooleanType GetPixelViewIterator(PixelView *source,
333 GetPixelViewMethod get,void *context)
334</pre>
335
336<p>A description of each parameter follows:</p></ol>
337
338<h5>source</h5>
339<ol><p>the source pixel view.</p></ol>
340
341<h5>get</h5>
342<ol><p>the get callback method.</p></ol>
343
344<h5>context</h5>
345<ol><p>the user defined context.</p></ol>
346
347 </div>
348<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
349_8c.html" target="source" name="GetPixelViewPixels">GetPixelViewPixels</a></h2>
350<div class="doc-section">
351
352<p>GetPixelViewPixels() returns the pixel view pixel_wands.</p></ol>
353
354<p>The format of the GetPixelViewPixels method is:</p>
355
356<pre class="code">
357 PixelWand *GetPixelViewPixels(const PixelView *pixel_view)
358</pre>
359
360<p>A description of each parameter follows:</p></ol>
361
362<h5>pixel_view</h5>
363<ol><p>the pixel view.</p></ol>
364
365 </div>
366<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
367_8c.html" target="source" name="GetPixelViewWand">GetPixelViewWand</a></h2>
368<div class="doc-section">
369
370<p>GetPixelViewWand() returns the magick wand associated with the pixel view.</p></ol>
371
372<p>The format of the GetPixelViewWand method is:</p>
373
374<pre class="code">
375 MagickWand *GetPixelViewWand(const PixelView *pixel_view)
376</pre>
377
378<p>A description of each parameter follows:</p></ol>
379
380<h5>pixel_view</h5>
381<ol><p>the pixel view.</p></ol>
382
383 </div>
384<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
385_8c.html" target="source" name="GetPixelViewWidth">GetPixelViewWidth</a></h2>
386<div class="doc-section">
387
388<p>GetPixelViewWidth() returns the pixel view width.</p></ol>
389
390<p>The format of the GetPixelViewWidth method is:</p>
391
392<pre class="code">
393 size_t GetPixelViewWidth(const PixelView *pixel_view)
394</pre>
395
396<p>A description of each parameter follows:</p></ol>
397
398<h5>pixel_view</h5>
399<ol><p>the pixel view.</p></ol>
400
401 </div>
402<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
403_8c.html" target="source" name="GetPixelViewX">GetPixelViewX</a></h2>
404<div class="doc-section">
405
406<p>GetPixelViewX() returns the pixel view x offset.</p></ol>
407
408<p>The format of the GetPixelViewX method is:</p>
409
410<pre class="code">
411 ssize_t GetPixelViewX(const PixelView *pixel_view)
412</pre>
413
414<p>A description of each parameter follows:</p></ol>
415
416<h5>pixel_view</h5>
417<ol><p>the pixel view.</p></ol>
418
419 </div>
420<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
421_8c.html" target="source" name="GetPixelViewY">GetPixelViewY</a></h2>
422<div class="doc-section">
423
424<p>GetPixelViewY() returns the pixel view y offset.</p></ol>
425
426<p>The format of the GetPixelViewY method is:</p>
427
428<pre class="code">
429 ssize_t GetPixelViewY(const PixelView *pixel_view)
430</pre>
431
432<p>A description of each parameter follows:</p></ol>
433
434<h5>pixel_view</h5>
435<ol><p>the pixel view.</p></ol>
436
437 </div>
438<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
439_8c.html" target="source" name="IsPixelView">IsPixelView</a></h2>
440<div class="doc-section">
441
442<p>IsPixelView() returns MagickTrue if the the parameter is verified as a pixel view container.</p></ol>
443
444<p>The format of the IsPixelView method is:</p>
445
446<pre class="code">
447 MagickBooleanType IsPixelView(const PixelView *pixel_view)
448</pre>
449
450<p>A description of each parameter follows:</p></ol>
451
452<h5>pixel_view</h5>
453<ol><p>the pixel view.</p></ol>
454
455 </div>
456<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy3ed852e2009-09-05 21:47:34 +0000457_8c.html" target="source" name="MagickClipPathImage">MagickClipPathImage</a></h2>
458<div class="doc-section">
459
cristyeaedf062010-05-29 22:36:02 +0000460<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 +0000461
462<p>The format of the MagickClipPathImage method is:</p>
463
464<pre class="code">
465 MagickBooleanType MagickClipPathImage(MagickWand *wand,
466 const char *pathname,const MagickBooleanType inside)
467</pre>
468
469<p>A description of each parameter follows:</p></ol>
470
471<h5>wand</h5>
472<ol><p>the magick wand.</p></ol>
473
474<h5>pathname</h5>
475<ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
476
477<h5>inside</h5>
478<ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
479
480 </div>
481<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
482_8c.html" target="source" name="DrawGetFillAlpha">DrawGetFillAlpha</a></h2>
483<div class="doc-section">
484
485<p>DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture. Fully opaque is 1.0.</p></ol>
486
487<p>The format of the DrawGetFillAlpha method is:</p>
488
489<pre class="code">
490 double DrawGetFillAlpha(const DrawingWand *wand)
491</pre>
492
493<p>A description of each parameter follows:</p></ol>
494
495<h5>wand</h5>
496<ol><p>the drawing wand.</p></ol>
497
498 </div>
499<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
500_8c.html" target="source" name="DrawGetStrokeAlpha">DrawGetStrokeAlpha</a></h2>
501<div class="doc-section">
502
503<p>DrawGetStrokeAlpha() returns the alpha of stroked object outlines.</p></ol>
504
505<p>The format of the DrawGetStrokeAlpha method is:</p>
506
507<pre class="code">
508 double DrawGetStrokeAlpha(const DrawingWand *wand)
509</pre>
510
511<p>A description of each parameter follows:</p></ol>
512
513<h5>wand</h5>
514<ol><p>the drawing wand. </p>
515 </div>
516<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
517_8c.html" target="source" name="DrawPeekGraphicWand">DrawPeekGraphicWand</a></h2>
518<div class="doc-section">
519
520<p>DrawPeekGraphicWand() returns the current drawing wand.</p></ol>
521
522<p>The format of the PeekDrawingWand method is:</p>
523
524<pre class="code">
525 DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
526</pre>
527
528<p>A description of each parameter follows:</p></ol>
529
530<h5>wand</h5>
531<ol><p>the drawing wand.</p></ol>
532
533 </div>
534<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
535_8c.html" target="source" name="DrawPopGraphicContext">DrawPopGraphicContext</a></h2>
536<div class="doc-section">
537
538<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>
539
540<p>The format of the DrawPopGraphicContext method is:</p>
541
542<pre class="code">
543 MagickBooleanType DrawPopGraphicContext(DrawingWand *wand)
544</pre>
545
546<p>A description of each parameter follows:</p></ol>
547
548<h5>wand</h5>
549<ol><p>the drawing wand.</p></ol>
550
551 </div>
552<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
553_8c.html" target="source" name="DrawPushGraphicContext">DrawPushGraphicContext</a></h2>
554<div class="doc-section">
555
556<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>
557
558<p>The format of the DrawPushGraphicContext method is:</p>
559
560<pre class="code">
561 MagickBooleanType DrawPushGraphicContext(DrawingWand *wand)
562</pre>
563
564<p>A description of each parameter follows:</p></ol>
565
566<h5>wand</h5>
567<ol><p>the drawing wand.</p></ol>
568
569 </div>
570<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
571_8c.html" target="source" name="DrawSetFillAlpha">DrawSetFillAlpha</a></h2>
572<div class="doc-section">
573
574<p>DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture. Fully opaque is 1.0.</p></ol>
575
576<p>The format of the DrawSetFillAlpha method is:</p>
577
578<pre class="code">
579 void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
580</pre>
581
582<p>A description of each parameter follows:</p></ol>
583
584<h5>wand</h5>
585<ol><p>the drawing wand.</p></ol>
586
587<h5>fill_alpha</h5>
588<ol><p>fill alpha</p></ol>
589
590 </div>
591<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
592_8c.html" target="source" name="DrawSetStrokeAlpha">DrawSetStrokeAlpha</a></h2>
593<div class="doc-section">
594
595<p>DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.</p></ol>
596
597<p>The format of the DrawSetStrokeAlpha method is:</p>
598
599<pre class="code">
600 void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
601</pre>
602
603<p>A description of each parameter follows:</p></ol>
604
605<h5>wand</h5>
606<ol><p>the drawing wand.</p></ol>
607
608<h5>stroke_alpha</h5>
609<ol><p>stroke alpha. The value 1.0 is opaque.</p></ol>
610
611 </div>
612<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
613_8c.html" target="source" name="MagickColorFloodfillImage">MagickColorFloodfillImage</a></h2>
614<div class="doc-section">
615
616<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>
617
618<p>The format of the MagickColorFloodfillImage method is:</p>
619
620<pre class="code">
621 MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
622 const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
cristybb503372010-05-27 20:51:26 +0000623 const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000624</pre>
625
626<p>A description of each parameter follows:</p></ol>
627
628<h5>wand</h5>
629<ol><p>the magick wand.</p></ol>
630
631<h5>fill</h5>
632<ol><p>the floodfill color pixel wand.</p></ol>
633
634<h5>fuzz</h5>
635<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>
636
637<h5>bordercolor</h5>
638<ol><p>the border color pixel wand.</p></ol>
639
640<h5>x,y</h5>
641<ol><p>the starting location of the operation.</p></ol>
642
643 </div>
644<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
645_8c.html" target="source" name="MagickDescribeImage">MagickDescribeImage</a></h2>
646<div class="doc-section">
647
648<p>MagickDescribeImage() identifies an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p></ol>
649
650<p>The format of the MagickDescribeImage method is:</p>
651
652<pre class="code">
653 const char *MagickDescribeImage(MagickWand *wand)
654</pre>
655
656<p>A description of each parameter follows:</p></ol>
657
658<h5>wand</h5>
659<ol><p>the magick wand.</p></ol>
660
661 </div>
662<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
663_8c.html" target="source" name="MagickFlattenImages">MagickFlattenImages</a></h2>
664<div class="doc-section">
665
666<p>MagickFlattenImages() merges a sequence of images. This useful for combining Photoshop layers into a single image.</p></ol>
667
668<p>The format of the MagickFlattenImages method is:</p>
669
670<pre class="code">
671 MagickWand *MagickFlattenImages(MagickWand *wand)
672</pre>
673
674<p>A description of each parameter follows:</p></ol>
675
676<h5>wand</h5>
677<ol><p>the magick wand.</p></ol>
678
679 </div>
680<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
681_8c.html" target="source" name="MagickGetImageAttribute">MagickGetImageAttribute</a></h2>
682<div class="doc-section">
683
684<p>MagickGetImageAttribute() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
685
686<p>The format of the MagickGetImageAttribute method is:</p>
687
688<pre class="code">
689 char *MagickGetImageAttribute(MagickWand *wand,const char *property)
690</pre>
691
692<p>A description of each parameter follows:</p></ol>
693
694<h5>wand</h5>
695<ol><p>the magick wand.</p></ol>
696
697<h5>property</h5>
698<ol><p>the property.</p></ol>
699
700 </div>
701<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
702_8c.html" target="source" name="MagickGetImageMatte">MagickGetImageMatte</a></h2>
703<div class="doc-section">
704
705<p>MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.</p></ol>
706
707<p>The format of the MagickGetImageMatte method is:</p>
708
709<pre class="code">
cristybb503372010-05-27 20:51:26 +0000710 size_t MagickGetImageMatte(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000711</pre>
712
713<p>A description of each parameter follows:</p></ol>
714
715<h5>wand</h5>
716<ol><p>the magick wand.</p></ol>
717
718 </div>
719<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
720_8c.html" target="source" name="MagickGetImagePixels">MagickGetImagePixels</a></h2>
721<div class="doc-section">
722
cristybb503372010-05-27 20:51:26 +0000723<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 +0000724
725<p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
726
727<pre class="text">
728 MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
729</pre>
730
731<p>The format of the MagickGetImagePixels method is:</p>
732
733<pre class="code">
734 MagickBooleanType MagickGetImagePixels(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000735 const ssize_t x,const ssize_t y,const size_t columns,
736 const size_t rows,const char *map,const StorageType storage,
cristy3ed852e2009-09-05 21:47:34 +0000737 void *pixels)
738</pre>
739
740<p>A description of each parameter follows:</p></ol>
741
742<h5>wand</h5>
743<ol><p>the magick wand.</p></ol>
744
745<h5>x, y, columns, rows</h5>
746<ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
747
748<h5>map</h5>
749<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>
750
751<h5>storage</h5>
752<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>
753
754<h5>pixels</h5>
755<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>
756
757 </div>
758<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
759_8c.html" target="source" name="MagickGetImageSize">MagickGetImageSize</a></h2>
760<div class="doc-section">
761
762<p>MagickGetImageSize() returns the image length in bytes.</p></ol>
763
764<p>The format of the MagickGetImageSize method is:</p>
765
766<pre class="code">
767 MagickBooleanType MagickGetImageSize(MagickWand *wand,
768 MagickSizeType *length)
769</pre>
770
771<p>A description of each parameter follows:</p></ol>
772
773<h5>wand</h5>
774<ol><p>the magick wand.</p></ol>
775
776<h5>length</h5>
777<ol><p>the image length in bytes.</p></ol>
778
779 </div>
780<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
781_8c.html" target="source" name="MagickMapImage">MagickMapImage</a></h2>
782<div class="doc-section">
783
784<p>MagickMapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
785
786<p>The format of the MagickMapImage method is:</p>
787
788<pre class="code">
789 MagickBooleanType MagickMapImage(MagickWand *wand,
790 const MagickWand *map_wand,const MagickBooleanType dither)
791</pre>
792
793<p>A description of each parameter follows:</p></ol>
794
795<h5>wand</h5>
796<ol><p>the magick wand.</p></ol>
797
798<h5>map</h5>
799<ol><p>the map wand.</p></ol>
800
801<h5>dither</h5>
802<ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
803
804 </div>
805<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
806_8c.html" target="source" name="MagickMatteFloodfillImage">MagickMatteFloodfillImage</a></h2>
807<div class="doc-section">
808
809<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>
810
811<p>The format of the MagickMatteFloodfillImage method is:</p>
812
813<pre class="code">
814 MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
815 const double alpha,const double fuzz,const PixelWand *bordercolor,
cristybb503372010-05-27 20:51:26 +0000816 const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000817</pre>
818
819<p>A description of each parameter follows:</p></ol>
820
821<h5>wand</h5>
822<ol><p>the magick wand.</p></ol>
823
824<h5>alpha</h5>
825<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
826
827<h5>fuzz</h5>
828<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>
829
830<h5>bordercolor</h5>
831<ol><p>the border color pixel wand.</p></ol>
832
833<h5>x,y</h5>
834<ol><p>the starting location of the operation.</p></ol>
835
836 </div>
837<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy63fed272010-03-07 19:08:45 +0000838_8c.html" target="source" name="MagickMaximumImages">MagickMaximumImages</a></h2>
839<div class="doc-section">
840
841<p>MagickMaximumImages() returns the maximum intensity of an image sequence.</p></ol>
842
843<p>The format of the MagickMaximumImages method is:</p>
844
845<pre class="code">
846 MagickWand *MagickMaximumImages(MagickWand *wand)
847</pre>
848
849<p>A description of each parameter follows:</p></ol>
850
851<h5>wand</h5>
852<ol><p>the magick wand.</p></ol>
853
854 </div>
855<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
856_8c.html" target="source" name="MagickMinimumImages">MagickMinimumImages</a></h2>
857<div class="doc-section">
858
859<p>MagickMinimumImages() returns the minimum intensity of an image sequence.</p></ol>
860
861<p>The format of the MagickMinimumImages method is:</p>
862
863<pre class="code">
864 MagickWand *MagickMinimumImages(MagickWand *wand)
865</pre>
866
867<p>A description of each parameter follows:</p></ol>
868
869<h5>wand</h5>
870<ol><p>the magick wand.</p></ol>
871
872 </div>
873<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy3ed852e2009-09-05 21:47:34 +0000874_8c.html" target="source" name="MagickMosaicImages">MagickMosaicImages</a></h2>
875<div class="doc-section">
876
877<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>
878
879<p>The format of the MagickMosaicImages method is:</p>
880
881<pre class="code">
882 MagickWand *MagickMosaicImages(MagickWand *wand)
883</pre>
884
885<p>A description of each parameter follows:</p></ol>
886
887<h5>wand</h5>
888<ol><p>the magick wand.</p></ol>
889
890 </div>
891<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
892_8c.html" target="source" name="MagickOpaqueImage">MagickOpaqueImage</a></h2>
893<div class="doc-section">
894
895<p>MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
896
897<p>The format of the MagickOpaqueImage method is:</p>
898
899<pre class="code">
900 MagickBooleanType MagickOpaqueImage(MagickWand *wand,
901 const PixelWand *target,const PixelWand *fill,const double fuzz)
902</pre>
903
904<p>A description of each parameter follows:</p></ol>
905
906<h5>wand</h5>
907<ol><p>the magick wand.</p></ol>
908
909<h5>channel</h5>
910<ol><p>the channel(s).</p></ol>
911
912<h5>target</h5>
913<ol><p>Change this target color to the fill color within the image.</p></ol>
914
915<h5>fill</h5>
916<ol><p>the fill pixel wand.</p></ol>
917
918<h5>fuzz</h5>
919<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>
920
921 </div>
922<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
923_8c.html" target="source" name="MagickPaintFloodfillImage">MagickPaintFloodfillImage</a></h2>
924<div class="doc-section">
925
926<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>
927
928<p>The format of the MagickPaintFloodfillImage method is:</p>
929
930<pre class="code">
931 MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
932 const ChannelType channel,const PixelWand *fill,const double fuzz,
cristybb503372010-05-27 20:51:26 +0000933 const PixelWand *bordercolor,const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000934</pre>
935
936<p>A description of each parameter follows:</p></ol>
937
938<h5>wand</h5>
939<ol><p>the magick wand.</p></ol>
940
941<h5>channel</h5>
942<ol><p>the channel(s).</p></ol>
943
944<h5>fill</h5>
945<ol><p>the floodfill color pixel wand.</p></ol>
946
947<h5>fuzz</h5>
948<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>
949
950<h5>bordercolor</h5>
951<ol><p>the border color pixel wand.</p></ol>
952
953<h5>x,y</h5>
954<ol><p>the starting location of the operation.</p></ol>
955
956 </div>
957<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
958_8c.html" target="source" name="MagickPaintOpaqueImage">MagickPaintOpaqueImage</a></h2>
959<div class="doc-section">
960
961<p>MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
962
963<p>The format of the MagickPaintOpaqueImage method is:</p>
964
965<pre class="code">
966 MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
967 const PixelWand *target,const PixelWand *fill,const double fuzz)
968 MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
969 const ChannelType channel,const PixelWand *target,
970 const PixelWand *fill,const double fuzz)
971</pre>
972
973<p>A description of each parameter follows:</p></ol>
974
975<h5>wand</h5>
976<ol><p>the magick wand.</p></ol>
977
978<h5>channel</h5>
979<ol><p>the channel(s).</p></ol>
980
981<h5>target</h5>
982<ol><p>Change this target color to the fill color within the image.</p></ol>
983
984<h5>fill</h5>
985<ol><p>the fill pixel wand.</p></ol>
986
987<h5>fuzz</h5>
988<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>
989
990 </div>
991<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
992_8c.html" target="source" name="MagickPaintTransparentImage">MagickPaintTransparentImage</a></h2>
993<div class="doc-section">
994
995<p>MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
996
997<p>The format of the MagickPaintTransparentImage method is:</p>
998
999<pre class="code">
1000 MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
1001 const PixelWand *target,const double alpha,const double fuzz)
1002</pre>
1003
1004<p>A description of each parameter follows:</p></ol>
1005
1006<h5>wand</h5>
1007<ol><p>the magick wand.</p></ol>
1008
1009<h5>target</h5>
1010<ol><p>Change this target color to specified opacity value within the image.</p></ol>
1011
1012<h5>alpha</h5>
1013<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
1014
1015<h5>fuzz</h5>
1016<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>
1017
1018 </div>
1019<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy0291e2d2010-04-04 17:50:18 +00001020_8c.html" target="source" name="MagickRecolorImage">MagickRecolorImage</a></h2>
1021<div class="doc-section">
1022
1023<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>
1024
1025<p>The format of the MagickRecolorImage method is:</p>
1026
1027<pre class="code">
1028 MagickBooleanType MagickRecolorImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +00001029 const size_t order,const double *color_matrix)
cristy0291e2d2010-04-04 17:50:18 +00001030</pre>
1031
1032<p>A description of each parameter follows:</p></ol>
1033
1034<h5>wand</h5>
1035<ol><p>the magick wand.</p></ol>
1036
1037<h5>order</h5>
1038<ol><p>the number of columns and rows in the color matrix.</p></ol>
1039
1040<h5>color_matrix</h5>
1041<ol><p>An array of doubles representing the color matrix.</p></ol>
1042
1043 </div>
1044<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy3ed852e2009-09-05 21:47:34 +00001045_8c.html" target="source" name="MagickSetImageAttribute">MagickSetImageAttribute</a></h2>
1046<div class="doc-section">
1047
1048<p>MagickSetImageAttribute() associates a property with an image.</p></ol>
1049
1050<p>The format of the MagickSetImageAttribute method is:</p>
1051
1052<pre class="code">
1053 MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
1054 const char *property,const char *value)
1055</pre>
1056
1057<p>A description of each parameter follows:</p></ol>
1058
1059<h5>wand</h5>
1060<ol><p>the magick wand.</p></ol>
1061
1062<h5>property</h5>
1063<ol><p>the property.</p></ol>
1064
1065<h5>value</h5>
1066<ol><p>the value.</p></ol>
1067
1068 </div>
1069<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1070_8c.html" target="source" name="MagickSetImageIndex">MagickSetImageIndex</a></h2>
1071<div class="doc-section">
1072
1073<p>MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.</p></ol>
1074
1075<p>The format of the MagickSetImageIndex method is:</p>
1076
1077<pre class="code">
cristybb503372010-05-27 20:51:26 +00001078 MagickBooleanType MagickSetImageIndex(MagickWand *wand,const ssize_t index)
cristy3ed852e2009-09-05 21:47:34 +00001079</pre>
1080
1081<p>A description of each parameter follows:</p></ol>
1082
1083<h5>wand</h5>
1084<ol><p>the magick wand.</p></ol>
1085
1086<h5>index</h5>
1087<ol><p>the scene number.</p></ol>
1088
1089 </div>
1090<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1091_8c.html" target="source" name="MagickTransparentImage">MagickTransparentImage</a></h2>
1092<div class="doc-section">
1093
1094<p>MagickTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
1095
1096<p>The format of the MagickTransparentImage method is:</p>
1097
1098<pre class="code">
1099 MagickBooleanType MagickTransparentImage(MagickWand *wand,
1100 const PixelWand *target,const double alpha,const double fuzz)
1101</pre>
1102
1103<p>A description of each parameter follows:</p></ol>
1104
1105<h5>wand</h5>
1106<ol><p>the magick wand.</p></ol>
1107
1108<h5>target</h5>
1109<ol><p>Change this target color to specified opacity value within the image.</p></ol>
1110
1111<h5>alpha</h5>
1112<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
1113
1114<h5>fuzz</h5>
1115<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>
1116
1117 </div>
1118<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1119_8c.html" target="source" name="MagickRegionOfInterestImage">MagickRegionOfInterestImage</a></h2>
1120<div class="doc-section">
1121
1122<p>MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.</p></ol>
1123
1124<p>The format of the MagickRegionOfInterestImage method is:</p>
1125
1126<pre class="code">
1127 MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +00001128 const size_t width,const size_t height,const ssize_t x,
1129 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +00001130</pre>
1131
1132<p>A description of each parameter follows:</p></ol>
1133
1134<h5>wand</h5>
1135<ol><p>the magick wand.</p></ol>
1136
1137<h5>width</h5>
1138<ol><p>the region width.</p></ol>
1139
1140<h5>height</h5>
1141<ol><p>the region height.</p></ol>
1142
1143<h5>x</h5>
1144<ol><p>the region x offset.</p></ol>
1145
1146<h5>y</h5>
1147<ol><p>the region y offset.</p></ol>
1148
1149 </div>
1150<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1151_8c.html" target="source" name="MagickSetImagePixels">MagickSetImagePixels</a></h2>
1152<div class="doc-section">
1153
cristybb503372010-05-27 20:51:26 +00001154<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 +00001155
1156<p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
1157
1158<pre class="text">
1159 MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
1160</pre>
1161
1162<p>The format of the MagickSetImagePixels method is:</p>
1163
1164<pre class="code">
1165 MagickBooleanType MagickSetImagePixels(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +00001166 const ssize_t x,const ssize_t y,const size_t columns,
1167 const size_t rows,const char *map,const StorageType storage,
cristy3ed852e2009-09-05 21:47:34 +00001168 const void *pixels)
1169</pre>
1170
1171<p>A description of each parameter follows:</p></ol>
1172
1173<h5>wand</h5>
1174<ol><p>the magick wand.</p></ol>
1175
1176<h5>x, y, columns, rows</h5>
1177<ol><p>These values define the perimeter of a region of pixels you want to define.</p></ol>
1178
1179<h5>map</h5>
1180<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>
1181
1182<h5>storage</h5>
1183<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>
1184
1185<h5>pixels</h5>
1186<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>
1187
1188 </div>
1189<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1190_8c.html" target="source" name="MagickWriteImageBlob">MagickWriteImageBlob</a></h2>
1191<div class="doc-section">
1192
1193<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>
1194
1195<p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p></ol>
1196
1197<p>The format of the MagickWriteImageBlob method is:</p>
1198
1199<pre class="code">
1200 unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
1201</pre>
1202
1203<p>A description of each parameter follows:</p></ol>
1204
1205<h5>wand</h5>
1206<ol><p>the magick wand.</p></ol>
1207
1208<h5>length</h5>
1209<ol><p>the length of the blob.</p></ol>
1210
1211 </div>
1212<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristyc3ebda22010-06-27 17:11:57 +00001213_8c.html" target="source" name="NewPixelView">NewPixelView</a></h2>
1214<div class="doc-section">
1215
1216<p>NewPixelView() returns a pixel view required for all other methods in the Pixel View API.</p></ol>
1217
1218<p>The format of the NewPixelView method is:</p>
1219
1220<pre class="code">
1221 PixelView *NewPixelView(MagickWand *wand)
1222</pre>
1223
1224<p>A description of each parameter follows:</p></ol>
1225
1226<h5>wand</h5>
1227<ol><p>the wand.</p></ol>
1228
1229 </div>
1230<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1231_8c.html" target="source" name="NewPixelViewRegion">NewPixelViewRegion</a></h2>
1232<div class="doc-section">
1233
1234<p>NewPixelViewRegion() returns a pixel view required for all other methods in the Pixel View API.</p></ol>
1235
1236<p>The format of the NewPixelViewRegion method is:</p>
1237
1238<pre class="code">
1239 PixelView *NewPixelViewRegion(MagickWand *wand,const ssize_t x,
1240 const ssize_t y,const size_t width,const size_t height)
1241</pre>
1242
1243<p>A description of each parameter follows:</p></ol>
1244
1245<h5>wand</h5>
1246<ol><p>the magick wand.</p></ol>
1247
1248<h5>x,y,columns,rows</h5>
1249<ol><p>These values define the perimeter of a region of pixel_wands view.</p></ol>
1250
1251 </div>
1252<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy3ed852e2009-09-05 21:47:34 +00001253_8c.html" target="source" name="PixelGetNextRow">PixelGetNextRow</a></h2>
1254<div class="doc-section">
1255
1256<p>PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
1257
1258<p>The format of the PixelGetNextRow method is:</p>
1259
1260<pre class="code">
1261 PixelWand **PixelGetNextRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +00001262 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +00001263</pre>
1264
1265<p>A description of each parameter follows:</p></ol>
1266
1267<h5>iterator</h5>
1268<ol><p>the pixel iterator.</p></ol>
1269
1270<h5>number_wands</h5>
1271<ol><p>the number of pixel wands.</p></ol>
1272
1273 </div>
1274<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1275_8c.html" target="source" name="PixelIteratorGetException">PixelIteratorGetException</a></h2>
1276<div class="doc-section">
1277
1278<p>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
1279
1280<p>The format of the PixelIteratorGetException method is:</p>
1281
1282<pre class="code">
1283 char *PixelIteratorGetException(const Pixeliterator *iterator,
1284 ExceptionType *severity)
1285</pre>
1286
1287<p>A description of each parameter follows:</p></ol>
1288
1289<h5>iterator</h5>
1290<ol><p>the pixel iterator.</p></ol>
1291
1292<h5>severity</h5>
1293<ol><p>the severity of the error is returned here.</p></ol>
1294
1295 </div>
cristyc3ebda22010-06-27 17:11:57 +00001296<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1297_8c.html" target="source" name="SetPixelViewIterator">SetPixelViewIterator</a></h2>
1298<div class="doc-section">
1299
1300<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>
1301
1302<p>Use this pragma:</p>
1303
1304<pre class="text">
1305 #pragma omp critical
1306</pre>
1307
1308<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>
1309
1310<p>The format of the SetPixelViewIterator method is:</p>
1311
1312<pre class="code">
1313 MagickBooleanType SetPixelViewIterator(PixelView *destination,
1314 SetPixelViewMethod set,void *context)
1315</pre>
1316
1317<p>A description of each parameter follows:</p></ol>
1318
1319<h5>destination</h5>
1320<ol><p>the pixel view.</p></ol>
1321
1322<h5>set</h5>
1323<ol><p>the set callback method.</p></ol>
1324
1325<h5>context</h5>
1326<ol><p>the user defined context.</p></ol>
1327
1328 </div>
1329<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1330_8c.html" target="source" name="TransferPixelViewIterator">TransferPixelViewIterator</a></h2>
1331<div class="doc-section">
1332
1333<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>
1334
1335<p>Use this pragma:</p>
1336
1337<pre class="text">
1338 #pragma omp critical
1339</pre>
1340
1341<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>
1342
1343<p>The format of the TransferPixelViewIterator method is:</p>
1344
1345<pre class="code">
1346 MagickBooleanType TransferPixelViewIterator(PixelView *source,
1347 PixelView *destination,TransferPixelViewMethod transfer,void *context)
1348</pre>
1349
1350<p>A description of each parameter follows:</p></ol>
1351
1352<h5>source</h5>
1353<ol><p>the source pixel view.</p></ol>
1354
1355<h5>destination</h5>
1356<ol><p>the destination pixel view.</p></ol>
1357
1358<h5>transfer</h5>
1359<ol><p>the transfer callback method.</p></ol>
1360
1361<h5>context</h5>
1362<ol><p>the user defined context.</p></ol>
1363
1364 </div>
1365<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1366_8c.html" target="source" name="UpdatePixelViewIterator">UpdatePixelViewIterator</a></h2>
1367<div class="doc-section">
1368
1369<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>
1370
1371<p>Use this pragma:</p>
1372
1373<pre class="text">
1374 #pragma omp critical
1375</pre>
1376
1377<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>
1378
1379<p>The format of the UpdatePixelViewIterator method is:</p>
1380
1381<pre class="code">
1382 MagickBooleanType UpdatePixelViewIterator(PixelView *source,
1383 UpdatePixelViewMethod update,void *context)
1384</pre>
1385
1386<p>A description of each parameter follows:</p></ol>
1387
1388<h5>source</h5>
1389<ol><p>the source pixel view.</p></ol>
1390
1391<h5>update</h5>
1392<ol><p>the update callback method.</p></ol>
1393
1394<h5>context</h5>
1395<ol><p>the user defined context.</p></ol>
1396
1397 </div>
cristy3eaa0ef2010-03-06 20:35:26 +00001398
1399</div>
1400
1401<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00001402 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00001403 <span id="linkbar-center">
1404 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00001405 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00001406 </span>
1407 <span id="linkbar-east">&nbsp;</span>
1408 </div>
1409 <div class="footer">
cristy4103d562010-12-10 01:38:54 +00001410 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00001411 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
1412 </div>
1413 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00001414 <script type="text/javascript">
1415 var _gaq = _gaq || [];
1416 _gaq.push(['_setAccount', 'UA-17690367-1']);
1417 _gaq.push(['_trackPageview']);
1418
1419 (function() {
1420 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
1421 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
1422 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
1423 })();
1424 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00001425</body>
1426</html>