]> granicus.if.org Git - imagemagick/blob - www/api/magick-deprecate.html
(no commit message)
[imagemagick] / www / api / magick-deprecate.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" 
2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html version="-//W3C//DTD XHTML 1.1//EN"
4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6       xsi:schemaLocation="http://www.w3.org/1999/xhtml
7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
8 <head>
9   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
10   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
11   <title>ImageMagick: MagickWand, C API for ImageMagick: Deprecated Methods</title>
12   <meta http-equiv="content-language" content="en-US"/>
13   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
14   <meta http-equiv="reply-to" content="magick-users@imagemagick.org"/>
15   <meta name="application-name" content="ImageMagick"/>
16   <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images automagically."/>
17   <meta name="application-url" content="http://www.imagemagick.org"/>
18   <meta name="generator" content="PHP"/>
19   <meta name="keywords" content="magickwc, api, for, imagemagick:, deprecated, methods, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
20   <meta name="rating" content="GENERAL"/>
21   <meta name="robots" content="INDEX, FOLLOW"/>
22   <meta name="generator" content="ImageMagick Studio LLC"/>
23   <meta name="author" content="ImageMagick Studio LLC"/>
24   <meta name="revisit-after" content="2 DAYS"/>
25   <meta name="resource-type" content="document"/>
26   <meta name="copyright" content="Copyright (c) 1999-2013 ImageMagick Studio LLC"/>
27   <meta name="distribution" content="Global"/>
28   <link rel="icon" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/wand.png"/>
29   <link rel="shortcut icon" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/wand.ico"  type="images/x-icon"/>
30   <link rel="canonical" href="http://www.imagemagick.org" />
31   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
32   <!-- Add jQuery library -->
33   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
34   
35   <!-- Optionaly include easing and/or mousewheel plugins -->
36   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
38   
39   <!-- Add fancyBox -->
40   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
42   
43   <!-- Optionaly include button and/or thumbnail helpers -->
44   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
45   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
46   
47   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
48   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
49   <script type="text/javascript">
50         $(document).ready(function() {
51                 $(".fancybox").fancybox();
52         });
53   </script>
54   <!-- ImageMagick style -->
55   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
56   <style type="text/css" media="all">
57     @import url("../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick.css");
58   </style>
59 </head>
60
61 <body id="www-imagemagick-org">
62 <div class="titlebar">
63 <div style="margin: 17px auto; float: left;">
64   <script type="text/javascript">
65   <!--
66     google_ad_client = "pub-3129977114552745";
67     google_ad_slot = "5439289906";
68     google_ad_width = 728;
69     google_ad_height = 90;
70   //-->
71   </script>
72   <script type="text/javascript"
73     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
74   </script>
75 </div>
76 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">
77   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/logo.jpg"
78   alt="ImageMagick Logo"
79   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
80 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">
81   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/sprite.jpg"
82   alt="ImageMagick Sprite"
83   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
84 </div>
85
86 <div class="westbar">
87
88 <div class="menu">
89   <a title="About ImageMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">About ImageMagick</a>
90 </div>
91 <div class="menu">
92   <a title="Binary Releases" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html">Binary Releases</a>
93 </div>
94 <div class="sub">
95     <a title="Binary Release: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#unix">Unix</a>
96 </div>
97 <div class="sub">
98     <a title="Binary Release: MacOS X" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#macosx">Mac OS X</a>
99 </div>
100 <div class="sub">
101     <a title="Binary Release: iOS" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#iOS">iOS</a>
102 </div>
103 <div class="sub">
104     <a title="Binary Release: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#windows">Windows</a>
105 </div>
106 <div class="sep"></div>
107 <div class="menu">
108   <a title="Command-line Tools" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-tools.html">Command-line Tools</a>
109 </div>
110 <div class="sub">
111     <a title="Command-line Tools: Processing" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-processing.html">Processing</a>
112 </div>
113 <div class="sub">
114     <a title="Command-line Tools: Options" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-options.html">Options</a>
115 </div>
116 <div class="sub">
117     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
118 </div>
119 <div class="menu">
120   <a title="Program Interfaces" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/api.html">Program Interfaces</a>
121 </div>
122 <div class="sub">
123     <a title="Program Interface: MagickWand" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-wand.html">MagickWand</a>
124 </div>
125 <div class="sub">
126     <a title="Program Interface: MagickCore" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-core.html">MagickCore</a>
127 </div>
128 <div class="sub">
129     <a title="Program Interface: PerlMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/perl-magick.html">PerlMagick</a>
130 </div>
131 <div class="sub">
132     <a title="Program Interface: Magick++" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick++.html">Magick++</a>
133 </div>
134 <div class="sep"></div>
135 <div  class="menu">
136    <a title="Install from Source" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html">Install from Source</a>
137 </div>
138 <div class="sub">
139     <a title="Install from Source: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#unix">Unix</a>
140 </div>
141 <div class="sub">
142     <a title="Install from Source: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#windows">Windows</a>
143  </div>
144 <div class="menu">
145   <a title="Resources" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/resources.html">Resources</a>
146 </div>
147 <div class="menu">
148   <a title="Architecture" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/architecture.html">Architecture</a>
149 </div>
150 <div class="menu">
151   <a title="Download" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/download.html">Download</a>
152 </div>
153 <div class="sep"></div>
154 <div class="menu">
155   <a title="Search" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/search.html">Search</a>
156 </div>
157 <div class="sep"></div>
158 <div class="menu">
159   <a title="Site Map" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sitemap.html">Site Map</a>
160 </div>
161 <div  class="sub">
162   <a title="Site Map: Links" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/links.html">Links</a>
163 </div>
164 <div class="sep"></div>
165 <div class="menu">
166   <a rel="follow" title="Sponsors" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sponsors.html">Sponsors:</a>
167
168   <a href="http://www.networkredux.com"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
169   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
170 <div class="sponsbox">
171 <div class="sponsor">
172   <a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
173 </div>
174 <div class="sponsor">
175   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
176 </div>
177 <div class="sponsor">
178   <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
179 </div>
180 <div class="sponsor">
181   <a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
182 </div>
183 <div class="sponsor">
184   <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
185 </div>
186 <div class="sponsor">
187   <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
188 </div>
189 <div class="sponsor">
190   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
191 </div>
192 <div class="sponsor">
193   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
194 </div>
195 <div class="sponsor">
196    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
197 </div>
198 <div class="sponsor">
199    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
200 </div>
201 <div class="sponsor">
202   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
203 </div>
204 <div class="sponsor">
205   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
206 </div>
207 <div class="sponsor">
208    <a rel="follow" title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
209 </div>
210 <div class="sponsor">
211    <a rel="follow" title="Sponsor: Web Hosting" href="http://www.hostucan.com">Web Hosting</a><!-- 2012120100150 racent marketing@webhosting...-->
212 </div>
213 </div>
214 </div>
215 </div>
216
217 <div class="eastbar">
218   <div class="g-plusone" id="gplusone"></div>
219   <script type="text/javascript">
220     window.___gcfg = {
221       lang: 'en-US'
222     };
223
224     (function() {
225       var po = document.createElement('script');
226       po.type = 'text/javascript'; po.async = true;
227       po.src = 'https://apis.google.com/js/plusone.js';
228       var script = document.getElementsByTagName('script')[0];
229       script.parentNode.insertBefore(po, script);
230     })();
231     var gplusone = document.getElementById("gplusone");
232     gplusone.setAttribute("data-size","medium");
233     gplusone.setAttribute("data-count","false");
234   </script>
235 </div>
236
237 <div class="main">
238
239 <h1>Module deprecate Methods</h1>
240 <p class="navigation-index">[<a href="magick-deprecate.html#MagickAverageImages">MagickAverageImages</a> &bull; <a href="magick-deprecate.html#ClonePixelView">ClonePixelView</a> &bull; <a href="magick-deprecate.html#DestroyPixelView">DestroyPixelView</a> &bull; <a href="magick-deprecate.html#DuplexTransferPixelViewIterator">DuplexTransferPixelViewIterator</a> &bull; <a href="magick-deprecate.html#GetPixelViewException">GetPixelViewException</a> &bull; <a href="magick-deprecate.html#GetPixelViewHeight">GetPixelViewHeight</a> &bull; <a href="magick-deprecate.html#GetPixelViewIterator">GetPixelViewIterator</a> &bull; <a href="magick-deprecate.html#GetPixelViewPixels">GetPixelViewPixels</a> &bull; <a href="magick-deprecate.html#GetPixelViewWand">GetPixelViewWand</a> &bull; <a href="magick-deprecate.html#GetPixelViewWidth">GetPixelViewWidth</a> &bull; <a href="magick-deprecate.html#GetPixelViewX">GetPixelViewX</a> &bull; <a href="magick-deprecate.html#GetPixelViewY">GetPixelViewY</a> &bull; <a href="magick-deprecate.html#IsPixelView">IsPixelView</a> &bull; <a href="magick-deprecate.html#MagickClipPathImage">MagickClipPathImage</a> &bull; <a href="magick-deprecate.html#DrawGetFillAlpha">DrawGetFillAlpha</a> &bull; <a href="magick-deprecate.html#DrawGetStrokeAlpha">DrawGetStrokeAlpha</a> &bull; <a href="magick-deprecate.html#DrawPeekGraphicWand">DrawPeekGraphicWand</a> &bull; <a href="magick-deprecate.html#DrawPopGraphicContext">DrawPopGraphicContext</a> &bull; <a href="magick-deprecate.html#DrawPushGraphicContext">DrawPushGraphicContext</a> &bull; <a href="magick-deprecate.html#DrawSetFillAlpha">DrawSetFillAlpha</a> &bull; <a href="magick-deprecate.html#DrawSetStrokeAlpha">DrawSetStrokeAlpha</a> &bull; <a href="magick-deprecate.html#MagickColorFloodfillImage">MagickColorFloodfillImage</a> &bull; <a href="magick-deprecate.html#MagickDescribeImage">MagickDescribeImage</a> &bull; <a href="magick-deprecate.html#MagickFlattenImages">MagickFlattenImages</a> &bull; <a href="magick-deprecate.html#MagickGetImageAttribute">MagickGetImageAttribute</a> &bull; <a href="magick-deprecate.html#MagickGetImageMatte">MagickGetImageMatte</a> &bull; <a href="magick-deprecate.html#MagickGetImagePixels">MagickGetImagePixels</a> &bull; <a href="magick-deprecate.html#MagickGetImageSize">MagickGetImageSize</a> &bull; <a href="magick-deprecate.html#MagickMapImage">MagickMapImage</a> &bull; <a href="magick-deprecate.html#MagickMatteFloodfillImage">MagickMatteFloodfillImage</a> &bull; <a href="magick-deprecate.html#MagickMedianFilterImage">MagickMedianFilterImage</a> &bull; <a href="magick-deprecate.html#MagickMinimumImages">MagickMinimumImages</a> &bull; <a href="magick-deprecate.html#MagickModeImage">MagickModeImage</a> &bull; <a href="magick-deprecate.html#MagickMosaicImages">MagickMosaicImages</a> &bull; <a href="magick-deprecate.html#MagickOpaqueImage">MagickOpaqueImage</a> &bull; <a href="magick-deprecate.html#MagickPaintFloodfillImage">MagickPaintFloodfillImage</a> &bull; <a href="magick-deprecate.html#MagickPaintOpaqueImage">MagickPaintOpaqueImage</a> &bull; <a href="magick-deprecate.html#MagickPaintTransparentImage">MagickPaintTransparentImage</a> &bull; <a href="magick-deprecate.html#MagickRecolorImage">MagickRecolorImage</a> &bull; <a href="magick-deprecate.html#MagickReduceNoiseImage">MagickReduceNoiseImage</a> &bull; <a href="magick-deprecate.html#MagickMaximumImages">MagickMaximumImages</a> &bull; <a href="magick-deprecate.html#MagickSetImageAttribute">MagickSetImageAttribute</a> &bull; <a href="magick-deprecate.html#MagickSetImageIndex">MagickSetImageIndex</a> &bull; <a href="magick-deprecate.html#MagickTransparentImage">MagickTransparentImage</a> &bull; <a href="magick-deprecate.html#MagickRegionOfInterestImage">MagickRegionOfInterestImage</a> &bull; <a href="magick-deprecate.html#MagickSetImagePixels">MagickSetImagePixels</a> &bull; <a href="magick-deprecate.html#MagickWriteImageBlob">MagickWriteImageBlob</a> &bull; <a href="magick-deprecate.html#NewPixelView">NewPixelView</a> &bull; <a href="magick-deprecate.html#NewPixelViewRegion">NewPixelViewRegion</a> &bull; <a href="magick-deprecate.html#PixelGetNextRow">PixelGetNextRow</a> &bull; <a href="magick-deprecate.html#PixelIteratorGetException">PixelIteratorGetException</a> &bull; <a href="magick-deprecate.html#SetPixelViewIterator">SetPixelViewIterator</a> &bull; <a href="magick-deprecate.html#TransferPixelViewIterator">TransferPixelViewIterator</a> &bull; <a href="magick-deprecate.html#UpdatePixelViewIterator">UpdatePixelViewIterator</a>]</p>
241
242 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickAverageImages">MagickAverageImages</a></h2>
243 <div class="doc-section">
244
245 <p>MagickAverageImages() average a set of images.</p>
246
247 <p>The format of the MagickAverageImages method is:</p>
248
249 <pre class="code">
250   MagickWand *MagickAverageImages(MagickWand *wand)
251 </pre>
252
253 <p>A description of each parameter follows:</p>
254
255 <h5>wand</h5>
256 <p>the magick wand.</p>
257
258  </div>
259 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="ClonePixelView">ClonePixelView</a></h2>
260 <div class="doc-section">
261
262 <p>ClonePixelView() makes a copy of the specified pixel view.</p>
263
264 <p>The format of the ClonePixelView method is:</p>
265
266 <pre class="code">
267   PixelView *ClonePixelView(const PixelView *pixel_view)
268 </pre>
269
270 <p>A description of each parameter follows:</p>
271
272 <h5>pixel_view</h5>
273 <p>the pixel view.</p>
274
275  </div>
276 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DestroyPixelView">DestroyPixelView</a></h2>
277 <div class="doc-section">
278
279 <p>DestroyPixelView() deallocates memory associated with a pixel view.</p>
280
281 <p>The format of the DestroyPixelView method is:</p>
282
283 <pre class="code">
284   PixelView *DestroyPixelView(PixelView *pixel_view,
285     const size_t number_wands,const size_t number_threads)
286 </pre>
287
288 <p>A description of each parameter follows:</p>
289
290 <h5>pixel_view</h5>
291 <p>the pixel view.</p>
292
293 <h5>number_wand</h5>
294 <p>the number of pixel wands.</p>
295
296 <h5>number_threads</h5>
297 <p>number of threads.</p>
298
299  </div>
300 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DuplexTransferPixelViewIterator">DuplexTransferPixelViewIterator</a></h2>
301 <div class="doc-section">
302
303 <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>
304
305 <p>Use this pragma:</p>
306
307 <pre class="text">
308       #pragma omp critical
309 </pre>
310
311 <p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p>
312
313 <p>The format of the DuplexTransferPixelViewIterator method is:</p>
314
315 <pre class="code">
316   MagickBooleanType DuplexTransferPixelViewIterator(PixelView *source,
317     PixelView *duplex,PixelView *destination,
318     DuplexTransferPixelViewMethod transfer,void *context)
319 </pre>
320
321 <p>A description of each parameter follows:</p>
322
323 <h5>source</h5>
324 <p>the source pixel view.</p>
325
326 <h5>duplex</h5>
327 <p>the duplex pixel view.</p>
328
329 <h5>destination</h5>
330 <p>the destination pixel view.</p>
331
332 <h5>transfer</h5>
333 <p>the transfer callback method.</p>
334
335 <h5>context</h5>
336 <p>the user defined context.</p>
337
338  </div>
339 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewException">GetPixelViewException</a></h2>
340 <div class="doc-section">
341
342 <p>GetPixelViewException() returns the severity, reason, and description of any error that occurs when utilizing a pixel view.</p>
343
344 <p>The format of the GetPixelViewException method is:</p>
345
346 <pre class="code">
347   char *GetPixelViewException(const PixelWand *pixel_view,
348     ExceptionType *severity)
349 </pre>
350
351 <p>A description of each parameter follows:</p>
352
353 <h5>pixel_view</h5>
354 <p>the pixel pixel_view.</p>
355
356 <h5>severity</h5>
357 <p>the severity of the error is returned here.</p>
358
359  </div>
360 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewHeight">GetPixelViewHeight</a></h2>
361 <div class="doc-section">
362
363 <p>GetPixelViewHeight() returns the pixel view height.</p>
364
365 <p>The format of the GetPixelViewHeight method is:</p>
366
367 <pre class="code">
368   size_t GetPixelViewHeight(const PixelView *pixel_view)
369 </pre>
370
371 <p>A description of each parameter follows:</p>
372
373 <h5>pixel_view</h5>
374 <p>the pixel view.</p>
375
376  </div>
377 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewIterator">GetPixelViewIterator</a></h2>
378 <div class="doc-section">
379
380 <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>
381
382 <p>Use this pragma:</p>
383
384 <pre class="text">
385       #pragma omp critical
386 </pre>
387
388 <p>to define a section of code in your callback get method that must be executed by a single thread at a time.</p>
389
390 <p>The format of the GetPixelViewIterator method is:</p>
391
392 <pre class="code">
393   MagickBooleanType GetPixelViewIterator(PixelView *source,
394     GetPixelViewMethod get,void *context)
395 </pre>
396
397 <p>A description of each parameter follows:</p>
398
399 <h5>source</h5>
400 <p>the source pixel view.</p>
401
402 <h5>get</h5>
403 <p>the get callback method.</p>
404
405 <h5>context</h5>
406 <p>the user defined context.</p>
407
408  </div>
409 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewPixels">GetPixelViewPixels</a></h2>
410 <div class="doc-section">
411
412 <p>GetPixelViewPixels() returns the pixel view pixel_wands.</p>
413
414 <p>The format of the GetPixelViewPixels method is:</p>
415
416 <pre class="code">
417   PixelWand *GetPixelViewPixels(const PixelView *pixel_view)
418 </pre>
419
420 <p>A description of each parameter follows:</p>
421
422 <h5>pixel_view</h5>
423 <p>the pixel view.</p>
424
425  </div>
426 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewWand">GetPixelViewWand</a></h2>
427 <div class="doc-section">
428
429 <p>GetPixelViewWand() returns the magick wand associated with the pixel view.</p>
430
431 <p>The format of the GetPixelViewWand method is:</p>
432
433 <pre class="code">
434   MagickWand *GetPixelViewWand(const PixelView *pixel_view)
435 </pre>
436
437 <p>A description of each parameter follows:</p>
438
439 <h5>pixel_view</h5>
440 <p>the pixel view.</p>
441
442  </div>
443 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewWidth">GetPixelViewWidth</a></h2>
444 <div class="doc-section">
445
446 <p>GetPixelViewWidth() returns the pixel view width.</p>
447
448 <p>The format of the GetPixelViewWidth method is:</p>
449
450 <pre class="code">
451   size_t GetPixelViewWidth(const PixelView *pixel_view)
452 </pre>
453
454 <p>A description of each parameter follows:</p>
455
456 <h5>pixel_view</h5>
457 <p>the pixel view.</p>
458
459  </div>
460 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewX">GetPixelViewX</a></h2>
461 <div class="doc-section">
462
463 <p>GetPixelViewX() returns the pixel view x offset.</p>
464
465 <p>The format of the GetPixelViewX method is:</p>
466
467 <pre class="code">
468   ssize_t GetPixelViewX(const PixelView *pixel_view)
469 </pre>
470
471 <p>A description of each parameter follows:</p>
472
473 <h5>pixel_view</h5>
474 <p>the pixel view.</p>
475
476  </div>
477 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewY">GetPixelViewY</a></h2>
478 <div class="doc-section">
479
480 <p>GetPixelViewY() returns the pixel view y offset.</p>
481
482 <p>The format of the GetPixelViewY method is:</p>
483
484 <pre class="code">
485   ssize_t GetPixelViewY(const PixelView *pixel_view)
486 </pre>
487
488 <p>A description of each parameter follows:</p>
489
490 <h5>pixel_view</h5>
491 <p>the pixel view.</p>
492
493  </div>
494 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="IsPixelView">IsPixelView</a></h2>
495 <div class="doc-section">
496
497 <p>IsPixelView() returns MagickTrue if the the parameter is verified as a pixel view container.</p>
498
499 <p>The format of the IsPixelView method is:</p>
500
501 <pre class="code">
502   MagickBooleanType IsPixelView(const PixelView *pixel_view)
503 </pre>
504
505 <p>A description of each parameter follows:</p>
506
507 <h5>pixel_view</h5>
508 <p>the pixel view.</p>
509
510  </div>
511 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickClipPathImage">MagickClipPathImage</a></h2>
512 <div class="doc-section">
513
514 <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>
515
516 <p>The format of the MagickClipPathImage method is:</p>
517
518 <pre class="code">
519   MagickBooleanType MagickClipPathImage(MagickWand *wand,
520     const char *pathname,const MagickBooleanType inside)
521 </pre>
522
523 <p>A description of each parameter follows:</p>
524
525 <h5>wand</h5>
526 <p>the magick wand.</p>
527
528 <h5>pathname</h5>
529 <p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p>
530
531 <h5>inside</h5>
532 <p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p>
533
534  </div>
535 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawGetFillAlpha">DrawGetFillAlpha</a></h2>
536 <div class="doc-section">
537
538 <p>DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture.  Fully opaque is 1.0.</p>
539
540 <p>The format of the DrawGetFillAlpha method is:</p>
541
542 <pre class="code">
543   double DrawGetFillAlpha(const DrawingWand *wand)
544 </pre>
545
546 <p>A description of each parameter follows:</p>
547
548 <h5>wand</h5>
549 <p>the drawing wand.</p>
550
551  </div>
552 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawGetStrokeAlpha">DrawGetStrokeAlpha</a></h2>
553 <div class="doc-section">
554
555 <p>DrawGetStrokeAlpha() returns the alpha of stroked object outlines.</p>
556
557 <p>The format of the DrawGetStrokeAlpha method is:</p>
558
559 <pre class="code">
560   double DrawGetStrokeAlpha(const DrawingWand *wand)
561 </pre>
562
563 <p>A description of each parameter follows:</p>
564
565 <h5>wand</h5>
566 <p>the drawing wand. </p>
567  </div>
568 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawPeekGraphicWand">DrawPeekGraphicWand</a></h2>
569 <div class="doc-section">
570
571 <p>DrawPeekGraphicWand() returns the current drawing wand.</p>
572
573 <p>The format of the PeekDrawingWand method is:</p>
574
575 <pre class="code">
576   DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
577 </pre>
578
579 <p>A description of each parameter follows:</p>
580
581 <h5>wand</h5>
582 <p>the drawing wand.</p>
583
584  </div>
585 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawPopGraphicContext">DrawPopGraphicContext</a></h2>
586 <div class="doc-section">
587
588 <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>
589
590 <p>The format of the DrawPopGraphicContext method is:</p>
591
592 <pre class="code">
593   MagickBooleanType DrawPopGraphicContext(DrawingWand *wand)
594 </pre>
595
596 <p>A description of each parameter follows:</p>
597
598 <h5>wand</h5>
599 <p>the drawing wand.</p>
600
601  </div>
602 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawPushGraphicContext">DrawPushGraphicContext</a></h2>
603 <div class="doc-section">
604
605 <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>
606
607 <p>The format of the DrawPushGraphicContext method is:</p>
608
609 <pre class="code">
610   MagickBooleanType DrawPushGraphicContext(DrawingWand *wand)
611 </pre>
612
613 <p>A description of each parameter follows:</p>
614
615 <h5>wand</h5>
616 <p>the drawing wand.</p>
617
618  </div>
619 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawSetFillAlpha">DrawSetFillAlpha</a></h2>
620 <div class="doc-section">
621
622 <p>DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture.  Fully opaque is 1.0.</p>
623
624 <p>The format of the DrawSetFillAlpha method is:</p>
625
626 <pre class="code">
627   void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
628 </pre>
629
630 <p>A description of each parameter follows:</p>
631
632 <h5>wand</h5>
633 <p>the drawing wand.</p>
634
635 <h5>fill_alpha</h5>
636 <p>fill alpha</p>
637
638  </div>
639 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawSetStrokeAlpha">DrawSetStrokeAlpha</a></h2>
640 <div class="doc-section">
641
642 <p>DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.</p>
643
644 <p>The format of the DrawSetStrokeAlpha method is:</p>
645
646 <pre class="code">
647   void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
648 </pre>
649
650 <p>A description of each parameter follows:</p>
651
652 <h5>wand</h5>
653 <p>the drawing wand.</p>
654
655 <h5>stroke_alpha</h5>
656 <p>stroke alpha.  The value 1.0 is opaque.</p>
657
658  </div>
659 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickColorFloodfillImage">MagickColorFloodfillImage</a></h2>
660 <div class="doc-section">
661
662 <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>
663
664 <p>The format of the MagickColorFloodfillImage method is:</p>
665
666 <pre class="code">
667   MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
668     const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
669     const ssize_t x,const ssize_t y)
670 </pre>
671
672 <p>A description of each parameter follows:</p>
673
674 <h5>wand</h5>
675 <p>the magick wand.</p>
676
677 <h5>fill</h5>
678 <p>the floodfill color pixel wand.</p>
679
680 <h5>fuzz</h5>
681 <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>
682
683 <h5>bordercolor</h5>
684 <p>the border color pixel wand.</p>
685
686 <h5>x,y</h5>
687 <p>the starting location of the operation.</p>
688
689  </div>
690 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickDescribeImage">MagickDescribeImage</a></h2>
691 <div class="doc-section">
692
693 <p>MagickDescribeImage() identifies an image by printing its attributes to the file.  Attributes include the image width, height, size, and others.</p>
694
695 <p>The format of the MagickDescribeImage method is:</p>
696
697 <pre class="code">
698   const char *MagickDescribeImage(MagickWand *wand)
699 </pre>
700
701 <p>A description of each parameter follows:</p>
702
703 <h5>wand</h5>
704 <p>the magick wand.</p>
705
706  </div>
707 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickFlattenImages">MagickFlattenImages</a></h2>
708 <div class="doc-section">
709
710 <p>MagickFlattenImages() merges a sequence of images.  This useful for combining Photoshop layers into a single image.</p>
711
712 <p>The format of the MagickFlattenImages method is:</p>
713
714 <pre class="code">
715   MagickWand *MagickFlattenImages(MagickWand *wand)
716 </pre>
717
718 <p>A description of each parameter follows:</p>
719
720 <h5>wand</h5>
721 <p>the magick wand.</p>
722
723  </div>
724 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickGetImageAttribute">MagickGetImageAttribute</a></h2>
725 <div class="doc-section">
726
727 <p>MagickGetImageAttribute() returns a value associated with the specified property.  Use MagickRelinquishMemory() to free the value when you are finished with it.</p>
728
729 <p>The format of the MagickGetImageAttribute method is:</p>
730
731 <pre class="code">
732   char *MagickGetImageAttribute(MagickWand *wand,const char *property)
733 </pre>
734
735 <p>A description of each parameter follows:</p>
736
737 <h5>wand</h5>
738 <p>the magick wand.</p>
739
740 <h5>property</h5>
741 <p>the property.</p>
742
743  </div>
744 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickGetImageMatte">MagickGetImageMatte</a></h2>
745 <div class="doc-section">
746
747 <p>MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.</p>
748
749 <p>The format of the MagickGetImageMatte method is:</p>
750
751 <pre class="code">
752   size_t MagickGetImageMatte(MagickWand *wand)
753 </pre>
754
755 <p>A description of each parameter follows:</p>
756
757 <h5>wand</h5>
758 <p>the magick wand.</p>
759
760  </div>
761 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickGetImagePixels">MagickGetImagePixels</a></h2>
762 <div class="doc-section">
763
764 <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>
765
766 <p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
767
768 <pre class="text">
769   MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
770 </pre>
771
772 <p>The format of the MagickGetImagePixels method is:</p>
773
774 <pre class="code">
775   MagickBooleanType MagickGetImagePixels(MagickWand *wand,
776     const ssize_t x,const ssize_t y,const size_t columns,
777     const size_t rows,const char *map,const StorageType storage,
778     void *pixels)
779 </pre>
780
781 <p>A description of each parameter follows:</p>
782
783 <h5>wand</h5>
784 <p>the magick wand.</p>
785
786 <h5>x, y, columns, rows</h5>
787 <p>These values define the perimeter of a region of pixels you want to extract.</p>
788
789 <h5>map</h5>
790 <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>
791
792 <h5>storage</h5>
793 <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>
794
795 <h5>pixels</h5>
796 <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>
797
798  </div>
799 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickGetImageSize">MagickGetImageSize</a></h2>
800 <div class="doc-section">
801
802 <p>MagickGetImageSize() returns the image length in bytes.</p>
803
804 <p>The format of the MagickGetImageSize method is:</p>
805
806 <pre class="code">
807   MagickBooleanType MagickGetImageSize(MagickWand *wand,
808     MagickSizeType *length)
809 </pre>
810
811 <p>A description of each parameter follows:</p>
812
813 <h5>wand</h5>
814 <p>the magick wand.</p>
815
816 <h5>length</h5>
817 <p>the image length in bytes.</p>
818
819  </div>
820 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMapImage">MagickMapImage</a></h2>
821 <div class="doc-section">
822
823 <p>MagickMapImage() replaces the colors of an image with the closest color from a reference image.</p>
824
825 <p>The format of the MagickMapImage method is:</p>
826
827 <pre class="code">
828   MagickBooleanType MagickMapImage(MagickWand *wand,
829     const MagickWand *map_wand,const MagickBooleanType dither)
830 </pre>
831
832 <p>A description of each parameter follows:</p>
833
834 <h5>wand</h5>
835 <p>the magick wand.</p>
836
837 <h5>map</h5>
838 <p>the map wand.</p>
839
840 <h5>dither</h5>
841 <p>Set this integer value to something other than zero to dither the mapped image.</p>
842
843  </div>
844 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMatteFloodfillImage">MagickMatteFloodfillImage</a></h2>
845 <div class="doc-section">
846
847 <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>
848
849 <p>The format of the MagickMatteFloodfillImage method is:</p>
850
851 <pre class="code">
852   MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
853     const double alpha,const double fuzz,const PixelWand *bordercolor,
854     const ssize_t x,const ssize_t y)
855 </pre>
856
857 <p>A description of each parameter follows:</p>
858
859 <h5>wand</h5>
860 <p>the magick wand.</p>
861
862 <h5>alpha</h5>
863 <p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p>
864
865 <h5>fuzz</h5>
866 <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>
867
868 <h5>bordercolor</h5>
869 <p>the border color pixel wand.</p>
870
871 <h5>x,y</h5>
872 <p>the starting location of the operation.</p>
873
874  </div>
875 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMedianFilterImage">MagickMedianFilterImage</a></h2>
876 <div class="doc-section">
877
878 <p>MagickMedianFilterImage() applies a digital filter that improves the quality of a noisy image.  Each pixel is replaced by the median in a set of neighboring pixels as defined by radius.</p>
879
880 <p>The format of the MagickMedianFilterImage method is:</p>
881
882 <pre class="code">
883   MagickBooleanType MagickMedianFilterImage(MagickWand *wand,
884     const double radius)
885 </pre>
886
887 <p>A description of each parameter follows:</p>
888
889 <h5>wand</h5>
890 <p>the magick wand.</p>
891
892 <h5>radius</h5>
893 <p>the radius of the pixel neighborhood.</p>
894
895  </div>
896 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMinimumImages">MagickMinimumImages</a></h2>
897 <div class="doc-section">
898
899 <p>MagickMinimumImages() returns the minimum intensity of an image sequence.</p>
900
901 <p>The format of the MagickMinimumImages method is:</p>
902
903 <pre class="code">
904   MagickWand *MagickMinimumImages(MagickWand *wand)
905 </pre>
906
907 <p>A description of each parameter follows:</p>
908
909 <h5>wand</h5>
910 <p>the magick wand.</p>
911
912  </div>
913 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickModeImage">MagickModeImage</a></h2>
914 <div class="doc-section">
915
916 <p>MagickModeImage() makes each pixel the 'predominant color' of the neighborhood of the specified radius.</p>
917
918 <p>The format of the MagickModeImage method is:</p>
919
920 <pre class="code">
921   MagickBooleanType MagickModeImage(MagickWand *wand,
922     const double radius)
923 </pre>
924
925 <p>A description of each parameter follows:</p>
926
927 <h5>wand</h5>
928 <p>the magick wand.</p>
929
930 <h5>radius</h5>
931 <p>the radius of the pixel neighborhood.</p>
932
933  </div>
934 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMosaicImages">MagickMosaicImages</a></h2>
935 <div class="doc-section">
936
937 <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>
938
939 <p>The format of the MagickMosaicImages method is:</p>
940
941 <pre class="code">
942   MagickWand *MagickMosaicImages(MagickWand *wand)
943 </pre>
944
945 <p>A description of each parameter follows:</p>
946
947 <h5>wand</h5>
948 <p>the magick wand.</p>
949
950  </div>
951 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickOpaqueImage">MagickOpaqueImage</a></h2>
952 <div class="doc-section">
953
954 <p>MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.</p>
955
956 <p>The format of the MagickOpaqueImage method is:</p>
957
958 <pre class="code">
959   MagickBooleanType MagickOpaqueImage(MagickWand *wand,
960     const PixelWand *target,const PixelWand *fill,const double fuzz)
961 </pre>
962
963 <p>A description of each parameter follows:</p>
964
965 <h5>wand</h5>
966 <p>the magick wand.</p>
967
968 <h5>channel</h5>
969 <p>the channel(s).</p>
970
971 <h5>target</h5>
972 <p>Change this target color to the fill color within the image.</p>
973
974 <h5>fill</h5>
975 <p>the fill pixel wand.</p>
976
977 <h5>fuzz</h5>
978 <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>
979
980  </div>
981 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickPaintFloodfillImage">MagickPaintFloodfillImage</a></h2>
982 <div class="doc-section">
983
984 <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>
985
986 <p>The format of the MagickPaintFloodfillImage method is:</p>
987
988 <pre class="code">
989   MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
990     const ChannelType channel,const PixelWand *fill,const double fuzz,
991     const PixelWand *bordercolor,const ssize_t x,const ssize_t y)
992 </pre>
993
994 <p>A description of each parameter follows:</p>
995
996 <h5>wand</h5>
997 <p>the magick wand.</p>
998
999 <h5>channel</h5>
1000 <p>the channel(s).</p>
1001
1002 <h5>fill</h5>
1003 <p>the floodfill color pixel wand.</p>
1004
1005 <h5>fuzz</h5>
1006 <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>
1007
1008 <h5>bordercolor</h5>
1009 <p>the border color pixel wand.</p>
1010
1011 <h5>x,y</h5>
1012 <p>the starting location of the operation.</p>
1013
1014  </div>
1015 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickPaintOpaqueImage">MagickPaintOpaqueImage</a></h2>
1016 <div class="doc-section">
1017
1018 <p>MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p>
1019
1020 <p>The format of the MagickPaintOpaqueImage method is:</p>
1021
1022 <pre class="code">
1023   MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
1024     const PixelWand *target,const PixelWand *fill,const double fuzz)
1025   MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
1026     const ChannelType channel,const PixelWand *target,
1027     const PixelWand *fill,const double fuzz)
1028 </pre>
1029
1030 <p>A description of each parameter follows:</p>
1031
1032 <h5>wand</h5>
1033 <p>the magick wand.</p>
1034
1035 <h5>channel</h5>
1036 <p>the channel(s).</p>
1037
1038 <h5>target</h5>
1039 <p>Change this target color to the fill color within the image.</p>
1040
1041 <h5>fill</h5>
1042 <p>the fill pixel wand.</p>
1043
1044 <h5>fuzz</h5>
1045 <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>
1046
1047  </div>
1048 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickPaintTransparentImage">MagickPaintTransparentImage</a></h2>
1049 <div class="doc-section">
1050
1051 <p>MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.</p>
1052
1053 <p>The format of the MagickPaintTransparentImage method is:</p>
1054
1055 <pre class="code">
1056   MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
1057     const PixelWand *target,const double alpha,const double fuzz)
1058 </pre>
1059
1060 <p>A description of each parameter follows:</p>
1061
1062 <h5>wand</h5>
1063 <p>the magick wand.</p>
1064
1065 <h5>target</h5>
1066 <p>Change this target color to specified opacity value within the image.</p>
1067
1068 <h5>alpha</h5>
1069 <p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p>
1070
1071 <h5>fuzz</h5>
1072 <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>
1073
1074  </div>
1075 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickRecolorImage">MagickRecolorImage</a></h2>
1076 <div class="doc-section">
1077
1078 <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>
1079
1080 <p>The format of the MagickRecolorImage method is:</p>
1081
1082 <pre class="code">
1083   MagickBooleanType MagickRecolorImage(MagickWand *wand,
1084     const size_t order,const double *color_matrix)
1085 </pre>
1086
1087 <p>A description of each parameter follows:</p>
1088
1089 <h5>wand</h5>
1090 <p>the magick wand.</p>
1091
1092 <h5>order</h5>
1093 <p>the number of columns and rows in the color matrix.</p>
1094
1095 <h5>color_matrix</h5>
1096 <p>An array of doubles representing the color matrix.</p>
1097
1098  </div>
1099 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickReduceNoiseImage">MagickReduceNoiseImage</a></h2>
1100 <div class="doc-section">
1101
1102 <p>MagickReduceNoiseImage() smooths the contours of an image while still preserving edge information.  The algorithm works by replacing each pixel with its neighbor closest in value.  A neighbor is defined by radius.  Use a radius of 0 and ReduceNoise() selects a suitable radius for you.</p>
1103
1104 <p>The format of the MagickReduceNoiseImage method is:</p>
1105
1106 <pre class="code">
1107   MagickBooleanType MagickReduceNoiseImage(MagickWand *wand,
1108     const double radius)
1109 </pre>
1110
1111 <p>A description of each parameter follows:</p>
1112
1113 <h5>wand</h5>
1114 <p>the magick wand.</p>
1115
1116 <h5>radius</h5>
1117 <p>the radius of the pixel neighborhood.</p>
1118
1119  </div>
1120 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMaximumImages">MagickMaximumImages</a></h2>
1121 <div class="doc-section">
1122
1123 <p>MagickMaximumImages() returns the maximum intensity of an image sequence.</p>
1124
1125 <p>The format of the MagickMaximumImages method is:</p>
1126
1127 <pre class="code">
1128   MagickWand *MagickMaximumImages(MagickWand *wand)
1129 </pre>
1130
1131 <p>A description of each parameter follows:</p>
1132
1133 <h5>wand</h5>
1134 <p>the magick wand.</p>
1135
1136  </div>
1137 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickSetImageAttribute">MagickSetImageAttribute</a></h2>
1138 <div class="doc-section">
1139
1140 <p>MagickSetImageAttribute() associates a property with an image.</p>
1141
1142 <p>The format of the MagickSetImageAttribute method is:</p>
1143
1144 <pre class="code">
1145   MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
1146     const char *property,const char *value)
1147 </pre>
1148
1149 <p>A description of each parameter follows:</p>
1150
1151 <h5>wand</h5>
1152 <p>the magick wand.</p>
1153
1154 <h5>property</h5>
1155 <p>the property.</p>
1156
1157 <h5>value</h5>
1158 <p>the value.</p>
1159
1160  </div>
1161 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickSetImageIndex">MagickSetImageIndex</a></h2>
1162 <div class="doc-section">
1163
1164 <p>MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.</p>
1165
1166 <p>The format of the MagickSetImageIndex method is:</p>
1167
1168 <pre class="code">
1169   MagickBooleanType MagickSetImageIndex(MagickWand *wand,
1170     const ssize_t index)
1171 </pre>
1172
1173 <p>A description of each parameter follows:</p>
1174
1175 <h5>wand</h5>
1176 <p>the magick wand.</p>
1177
1178 <h5>index</h5>
1179 <p>the scene number.</p>
1180
1181  </div>
1182 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickTransparentImage">MagickTransparentImage</a></h2>
1183 <div class="doc-section">
1184
1185 <p>MagickTransparentImage() changes any pixel that matches color with the color defined by fill.</p>
1186
1187 <p>The format of the MagickTransparentImage method is:</p>
1188
1189 <pre class="code">
1190   MagickBooleanType MagickTransparentImage(MagickWand *wand,
1191     const PixelWand *target,const double alpha,const double fuzz)
1192 </pre>
1193
1194 <p>A description of each parameter follows:</p>
1195
1196 <h5>wand</h5>
1197 <p>the magick wand.</p>
1198
1199 <h5>target</h5>
1200 <p>Change this target color to specified opacity value within the image.</p>
1201
1202 <h5>alpha</h5>
1203 <p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p>
1204
1205 <h5>fuzz</h5>
1206 <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>
1207
1208  </div>
1209 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickRegionOfInterestImage">MagickRegionOfInterestImage</a></h2>
1210 <div class="doc-section">
1211
1212 <p>MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.</p>
1213
1214 <p>The format of the MagickRegionOfInterestImage method is:</p>
1215
1216 <pre class="code">
1217   MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
1218     const size_t width,const size_t height,const ssize_t x,
1219     const ssize_t y)
1220 </pre>
1221
1222 <p>A description of each parameter follows:</p>
1223
1224 <h5>wand</h5>
1225 <p>the magick wand.</p>
1226
1227 <h5>width</h5>
1228 <p>the region width.</p>
1229
1230 <h5>height</h5>
1231 <p>the region height.</p>
1232
1233 <h5>x</h5>
1234 <p>the region x offset.</p>
1235
1236 <h5>y</h5>
1237 <p>the region y offset.</p>
1238
1239  </div>
1240 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickSetImagePixels">MagickSetImagePixels</a></h2>
1241 <div class="doc-section">
1242
1243 <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>
1244
1245 <p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
1246
1247 <pre class="text">
1248   MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
1249 </pre>
1250
1251 <p>The format of the MagickSetImagePixels method is:</p>
1252
1253 <pre class="code">
1254   MagickBooleanType MagickSetImagePixels(MagickWand *wand,
1255     const ssize_t x,const ssize_t y,const size_t columns,
1256     const size_t rows,const char *map,const StorageType storage,
1257     const void *pixels)
1258 </pre>
1259
1260 <p>A description of each parameter follows:</p>
1261
1262 <h5>wand</h5>
1263 <p>the magick wand.</p>
1264
1265 <h5>x, y, columns, rows</h5>
1266 <p>These values define the perimeter of a region of pixels you want to define.</p>
1267
1268 <h5>map</h5>
1269 <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>
1270
1271 <h5>storage</h5>
1272 <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>
1273
1274 <h5>pixels</h5>
1275 <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>
1276
1277  </div>
1278 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickWriteImageBlob">MagickWriteImageBlob</a></h2>
1279 <div class="doc-section">
1280
1281 <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>
1282
1283 <p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p>
1284
1285 <p>The format of the MagickWriteImageBlob method is:</p>
1286
1287 <pre class="code">
1288   unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
1289 </pre>
1290
1291 <p>A description of each parameter follows:</p>
1292
1293 <h5>wand</h5>
1294 <p>the magick wand.</p>
1295
1296 <h5>length</h5>
1297 <p>the length of the blob.</p>
1298
1299  </div>
1300 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="NewPixelView">NewPixelView</a></h2>
1301 <div class="doc-section">
1302
1303 <p>NewPixelView() returns a pixel view required for all other methods in the Pixel View API.</p>
1304
1305 <p>The format of the NewPixelView method is:</p>
1306
1307 <pre class="code">
1308   PixelView *NewPixelView(MagickWand *wand)
1309 </pre>
1310
1311 <p>A description of each parameter follows:</p>
1312
1313 <h5>wand</h5>
1314 <p>the wand.</p>
1315
1316  </div>
1317 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="NewPixelViewRegion">NewPixelViewRegion</a></h2>
1318 <div class="doc-section">
1319
1320 <p>NewPixelViewRegion() returns a pixel view required for all other methods in the Pixel View API.</p>
1321
1322 <p>The format of the NewPixelViewRegion method is:</p>
1323
1324 <pre class="code">
1325   PixelView *NewPixelViewRegion(MagickWand *wand,const ssize_t x,
1326     const ssize_t y,const size_t width,const size_t height)
1327 </pre>
1328
1329 <p>A description of each parameter follows:</p>
1330
1331 <h5>wand</h5>
1332 <p>the magick wand.</p>
1333
1334 <h5>x,y,columns,rows</h5>
1335 <p>These values define the perimeter of a region of pixel_wands view.</p>
1336
1337  </div>
1338 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="PixelGetNextRow">PixelGetNextRow</a></h2>
1339 <div class="doc-section">
1340
1341 <p>PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.</p>
1342
1343 <p>The format of the PixelGetNextRow method is:</p>
1344
1345 <pre class="code">
1346   PixelWand **PixelGetNextRow(PixelIterator *iterator,
1347     size_t *number_wands)
1348 </pre>
1349
1350 <p>A description of each parameter follows:</p>
1351
1352 <h5>iterator</h5>
1353 <p>the pixel iterator.</p>
1354
1355 <h5>number_wands</h5>
1356 <p>the number of pixel wands.</p>
1357
1358  </div>
1359 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="PixelIteratorGetException">PixelIteratorGetException</a></h2>
1360 <div class="doc-section">
1361
1362 <p>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
1363
1364 <p>The format of the PixelIteratorGetException method is:</p>
1365
1366 <pre class="code">
1367   char *PixelIteratorGetException(const Pixeliterator *iterator,
1368     ExceptionType *severity)
1369 </pre>
1370
1371 <p>A description of each parameter follows:</p>
1372
1373 <h5>iterator</h5>
1374 <p>the pixel iterator.</p>
1375
1376 <h5>severity</h5>
1377 <p>the severity of the error is returned here.</p>
1378
1379  </div>
1380 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="SetPixelViewIterator">SetPixelViewIterator</a></h2>
1381 <div class="doc-section">
1382
1383 <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>
1384
1385 <p>Use this pragma:</p>
1386
1387 <pre class="text">
1388       #pragma omp critical
1389 </pre>
1390
1391 <p>to define a section of code in your callback set method that must be executed by a single thread at a time.</p>
1392
1393 <p>The format of the SetPixelViewIterator method is:</p>
1394
1395 <pre class="code">
1396   MagickBooleanType SetPixelViewIterator(PixelView *destination,
1397     SetPixelViewMethod set,void *context)
1398 </pre>
1399
1400 <p>A description of each parameter follows:</p>
1401
1402 <h5>destination</h5>
1403 <p>the pixel view.</p>
1404
1405 <h5>set</h5>
1406 <p>the set callback method.</p>
1407
1408 <h5>context</h5>
1409 <p>the user defined context.</p>
1410
1411  </div>
1412 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="TransferPixelViewIterator">TransferPixelViewIterator</a></h2>
1413 <div class="doc-section">
1414
1415 <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>
1416
1417 <p>Use this pragma:</p>
1418
1419 <pre class="text">
1420       #pragma omp critical
1421 </pre>
1422
1423 <p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p>
1424
1425 <p>The format of the TransferPixelViewIterator method is:</p>
1426
1427 <pre class="code">
1428   MagickBooleanType TransferPixelViewIterator(PixelView *source,
1429     PixelView *destination,TransferPixelViewMethod transfer,void *context)
1430 </pre>
1431
1432 <p>A description of each parameter follows:</p>
1433
1434 <h5>source</h5>
1435 <p>the source pixel view.</p>
1436
1437 <h5>destination</h5>
1438 <p>the destination pixel view.</p>
1439
1440 <h5>transfer</h5>
1441 <p>the transfer callback method.</p>
1442
1443 <h5>context</h5>
1444 <p>the user defined context.</p>
1445
1446  </div>
1447 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="UpdatePixelViewIterator">UpdatePixelViewIterator</a></h2>
1448 <div class="doc-section">
1449
1450 <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>
1451
1452 <p>Use this pragma:</p>
1453
1454 <pre class="text">
1455       #pragma omp critical
1456 </pre>
1457
1458 <p>to define a section of code in your callback update method that must be executed by a single thread at a time.</p>
1459
1460 <p>The format of the UpdatePixelViewIterator method is:</p>
1461
1462 <pre class="code">
1463   MagickBooleanType UpdatePixelViewIterator(PixelView *source,
1464     UpdatePixelViewMethod update,void *context)
1465 </pre>
1466
1467 <p>A description of each parameter follows:</p>
1468
1469 <h5>source</h5>
1470 <p>the source pixel view.</p>
1471
1472 <h5>update</h5>
1473 <p>the update callback method.</p>
1474
1475 <h5>context</h5>
1476 <p>the user defined context.</p>
1477
1478  </div>
1479
1480 </div>
1481
1482 <div id="linkbar">
1483     <span id="linkbar-west">&nbsp;</span>
1484     <span id="linkbar-center">
1485       <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">Discourse Server</a> &bull;
1486       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
1487     </span>
1488     <span id="linkbar-east">&nbsp;</span>
1489   </div>
1490   <div class="footer">
1491     <span id="footer-west">&copy; 1999-2013 ImageMagick Studio LLC</span>
1492     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
1493   </div>
1494   <div style="clear: both; margin: 0; width: 100%; "></div>
1495   <script type="text/javascript">
1496     var _gaq = _gaq || [];
1497     _gaq.push(['_setAccount', 'UA-17690367-1']);
1498     _gaq.push(['_trackPageview']);
1499
1500     (function() {
1501       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
1502       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
1503       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
1504     })();
1505   </script>
1506 </body>
1507 </html>