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