blob: ea4c0412065245a55c586ba0b334b0b5bcf64b28 [file] [log] [blame]
cristy06f63f22012-10-31 00:50:07 +00001<!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"/>
cristy8ee7f242013-06-20 16:08:44 +000010 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"/>
cristyffb69ed2010-12-25 00:06:48 +000011 <title>ImageMagick: MagickWand, C API for ImageMagick: Deprecated Methods</title>
cristy751980d2012-06-03 23:18:35 +000012 <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"/>
cristy8ee7f242013-06-20 16:08:44 +000016 <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition, resize, rotate, shear, distort or transform images automagically."/>
cristy751980d2012-06-03 23:18:35 +000017 <meta name="application-url" content="http://www.imagemagick.org"/>
18 <meta name="generator" content="PHP"/>
cristy8ee7f242013-06-20 16:08:44 +000019 <meta name="keywords" content="magickwc, api, for, imagemagick:, deprecated, methods, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
cristy751980d2012-06-03 23:18:35 +000020 <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"/>
cristy72da67d2013-02-24 21:40:48 +000026 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
cristy751980d2012-06-03 23:18:35 +000027 <meta name="distribution" content="Global"/>
cristy72da67d2013-02-24 21:40:48 +000028 <link rel="icon" href="../../images/wand.png"/>
29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
cristy06f63f22012-10-31 00:50:07 +000030 <link rel="canonical" href="http://www.imagemagick.org" />
31 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy8ee7f242013-06-20 16:08:44 +000032
33 <!-- Add jQuery library -->
34 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
35
36 <!-- Add mousewheel plugin (this is optional) -->
37 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
38
39 <!-- Add fancyBox -->
40 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen" />
41 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
42
43 <!-- Optionally add helpers - button, thumbnail and/or media -->
44 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen" />
45 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
46 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
47
48 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen" />
49 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
50
cristy72da67d2013-02-24 21:40:48 +000051 <script type="text/javascript">
cristy8ee7f242013-06-20 16:08:44 +000052 $(document).ready(function() {
53 $(".fancybox").fancybox();
54 });
cristy72da67d2013-02-24 21:40:48 +000055 </script>
cristy8ee7f242013-06-20 16:08:44 +000056
57 <!-- ImageMagick style -->
58 <style type="text/css" media="all">
59 @import url("../../www/magick.css");
60 </style>
cristy06f63f22012-10-31 00:50:07 +000061</head>
62
63<body id="www-imagemagick-org">
cristy8ee7f242013-06-20 16:08:44 +000064
65<script>
66 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
67 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
68 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
69 })(window,document,'offline-script','//127.0.0.1/analytics.js','ga');
70
71 ga('create', 'UA-40133312-1', 'imagemagick.org');
72 ga('send', 'pageview');
73</script>
74
cristy06f63f22012-10-31 00:50:07 +000075<div class="titlebar">
76<div style="margin: 17px auto; float: left;">
77 <script type="text/javascript">
78 <!--
79 google_ad_client = "pub-3129977114552745";
80 google_ad_slot = "5439289906";
81 google_ad_width = 728;
82 google_ad_height = 90;
83 //-->
84 </script>
85 <script type="text/javascript"
cristy8ee7f242013-06-20 16:08:44 +000086 src="http://127.0.0.1/pagead/show_ads.js">
cristy06f63f22012-10-31 00:50:07 +000087 </script>
88</div>
cristy8ee7f242013-06-20 16:08:44 +000089<a href="http://www.imagemagick.org/discourse-server/">
cristy72da67d2013-02-24 21:40:48 +000090 <img src="../../images/logo.jpg"
cristy06f63f22012-10-31 00:50:07 +000091 alt="ImageMagick Logo"
92 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy8ee7f242013-06-20 16:08:44 +000093<a href="../../index.html">
cristy72da67d2013-02-24 21:40:48 +000094 <img src="../../images/sprite.jpg"
cristy06f63f22012-10-31 00:50:07 +000095 alt="ImageMagick Sprite"
96 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
97</div>
98
99<div class="westbar">
100
cristy3ed852e2009-09-05 21:47:34 +0000101<div class="menu">
cristy8ee7f242013-06-20 16:08:44 +0000102 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
cristy3ed852e2009-09-05 21:47:34 +0000104<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000105 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
cristybb503372010-05-27 20:51:26 +0000106</div>
107<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000108 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
cristybb503372010-05-27 20:51:26 +0000109</div>
110<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000111 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
cristybb503372010-05-27 20:51:26 +0000112</div>
113<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000114 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000115</div>
116<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000117 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
cristybb503372010-05-27 20:51:26 +0000118</div>
cristy06f63f22012-10-31 00:50:07 +0000119<div class="sep"></div>
cristybb503372010-05-27 20:51:26 +0000120<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000121 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000122</div>
123<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000124 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000125</div>
126<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000127 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000128</div>
129<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000131</div>
132<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000133 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000134</div>
135<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000136 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000137</div>
138<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000139 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000140</div>
141<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000142 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000143</div>
144<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000145 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000146</div>
cristy06f63f22012-10-31 00:50:07 +0000147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000148<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000149 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000150</div>
151<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000152 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000153</div>
154<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000155 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000156 </div>
157<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000158 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000159</div>
cristybb503372010-05-27 20:51:26 +0000160<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000161 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
cristybb503372010-05-27 20:51:26 +0000162</div>
cristy3ed852e2009-09-05 21:47:34 +0000163<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000164 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000165</div>
cristy06f63f22012-10-31 00:50:07 +0000166<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000167<div class="menu">
cristy3dfa2192013-02-24 22:46:05 +0000168 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000169</div>
cristy06f63f22012-10-31 00:50:07 +0000170<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000171<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000172 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000173</div>
174<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000175 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000176</div>
cristy06f63f22012-10-31 00:50:07 +0000177<div class="sep"></div>
cristy8ee7f242013-06-20 16:08:44 +0000178<div class="menu">
179 <a title="Support ImageMagick Development" href="../../www/support.html">Support ImageMagick Development</a>
cristy3ed852e2009-09-05 21:47:34 +0000180</div>
cristy06f63f22012-10-31 00:50:07 +0000181</div>
182
183<div class="eastbar">
cristy06f63f22012-10-31 00:50:07 +0000184 <script type="text/javascript">
cristy8ee7f242013-06-20 16:08:44 +0000185 /* <![CDATA[ */
cristy06f63f22012-10-31 00:50:07 +0000186 (function() {
cristy8ee7f242013-06-20 16:08:44 +0000187 var po = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
188 po.type = 'text/javascript';
189 po.async = true;
190 po.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
191 var script = document.getElementsByTagName('offline-script')[0];
192 script.parentNode.insertBefore(po, script);
cristy06f63f22012-10-31 00:50:07 +0000193 })();
cristy8ee7f242013-06-20 16:08:44 +0000194 /* ]]> */
cristy06f63f22012-10-31 00:50:07 +0000195 </script>
cristy8ee7f242013-06-20 16:08:44 +0000196 <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://www.imagemagick.org/"></a></div>
197 <noscript>
198 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
199 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0" /></a>
200 </noscript>
201 <div class="g-plusone" id="gplusone"></div>
202 <script type="text/javascript">
203 /* <![CDATA[ */
204 window.___gcfg = {
205 lang: 'en-US'
206 };
207
208 (function() {
209 var po = document.createElement('offline-script');
210 po.type = 'text/javascript';
211 po.async = true;
212 po.src = 'https://127.0.0.1/js/plusone.js';
213 var script = document.getElementsByTagName('offline-script')[0];
214 script.parentNode.insertBefore(po, script);
215 })();
216 var gplusone = document.getElementById("gplusone");
217 gplusone.setAttribute("data-size","medium");
218 gplusone.setAttribute("data-count","true");
219 /* ]]> */
220 </script>
cristy06f63f22012-10-31 00:50:07 +0000221</div>
222
223<div class="main">
224
cristy20398432011-08-11 01:31:50 +0000225<h1>Module deprecate Methods</h1>
cristyd8833bf2013-02-24 22:14:53 +0000226<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>
cristy6f77f692011-02-15 15:31:39 +0000227
cristy20398432011-08-11 01:31:50 +0000228<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickAverageImages">MagickAverageImages</a></h2>
229<div class="doc-section">
230
231<p>MagickAverageImages() average a set of images.</p>
232
233<p>The format of the MagickAverageImages method is:</p>
234
235<pre class="code">
236 MagickWand *MagickAverageImages(MagickWand *wand)
237</pre>
238
239<p>A description of each parameter follows:</p>
240
241<h5>wand</h5>
242<p>the magick wand.</p>
243
244 </div>
245<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="ClonePixelView">ClonePixelView</a></h2>
246<div class="doc-section">
247
248<p>ClonePixelView() makes a copy of the specified pixel view.</p>
249
250<p>The format of the ClonePixelView method is:</p>
251
252<pre class="code">
253 PixelView *ClonePixelView(const PixelView *pixel_view)
254</pre>
255
256<p>A description of each parameter follows:</p>
257
258<h5>pixel_view</h5>
259<p>the pixel view.</p>
260
261 </div>
262<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DestroyPixelView">DestroyPixelView</a></h2>
263<div class="doc-section">
264
265<p>DestroyPixelView() deallocates memory associated with a pixel view.</p>
266
267<p>The format of the DestroyPixelView method is:</p>
268
269<pre class="code">
270 PixelView *DestroyPixelView(PixelView *pixel_view,
271 const size_t number_wands,const size_t number_threads)
272</pre>
273
274<p>A description of each parameter follows:</p>
275
276<h5>pixel_view</h5>
277<p>the pixel view.</p>
278
279<h5>number_wand</h5>
280<p>the number of pixel wands.</p>
281
282<h5>number_threads</h5>
283<p>number of threads.</p>
284
285 </div>
286<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DuplexTransferPixelViewIterator">DuplexTransferPixelViewIterator</a></h2>
287<div class="doc-section">
288
289<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>
290
291<p>Use this pragma:</p>
292
293<pre class="text">
294 #pragma omp critical
295</pre>
296
297<p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p>
298
299<p>The format of the DuplexTransferPixelViewIterator method is:</p>
300
301<pre class="code">
302 MagickBooleanType DuplexTransferPixelViewIterator(PixelView *source,
303 PixelView *duplex,PixelView *destination,
304 DuplexTransferPixelViewMethod transfer,void *context)
305</pre>
306
307<p>A description of each parameter follows:</p>
308
309<h5>source</h5>
310<p>the source pixel view.</p>
311
312<h5>duplex</h5>
313<p>the duplex pixel view.</p>
314
315<h5>destination</h5>
316<p>the destination pixel view.</p>
317
318<h5>transfer</h5>
319<p>the transfer callback method.</p>
320
321<h5>context</h5>
322<p>the user defined context.</p>
323
324 </div>
325<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewException">GetPixelViewException</a></h2>
326<div class="doc-section">
327
328<p>GetPixelViewException() returns the severity, reason, and description of any error that occurs when utilizing a pixel view.</p>
329
330<p>The format of the GetPixelViewException method is:</p>
331
332<pre class="code">
333 char *GetPixelViewException(const PixelWand *pixel_view,
334 ExceptionType *severity)
335</pre>
336
337<p>A description of each parameter follows:</p>
338
339<h5>pixel_view</h5>
340<p>the pixel pixel_view.</p>
341
342<h5>severity</h5>
343<p>the severity of the error is returned here.</p>
344
345 </div>
346<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewHeight">GetPixelViewHeight</a></h2>
347<div class="doc-section">
348
349<p>GetPixelViewHeight() returns the pixel view height.</p>
350
351<p>The format of the GetPixelViewHeight method is:</p>
352
353<pre class="code">
354 size_t GetPixelViewHeight(const PixelView *pixel_view)
355</pre>
356
357<p>A description of each parameter follows:</p>
358
359<h5>pixel_view</h5>
360<p>the pixel view.</p>
361
362 </div>
363<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewIterator">GetPixelViewIterator</a></h2>
364<div class="doc-section">
365
366<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>
367
368<p>Use this pragma:</p>
369
370<pre class="text">
371 #pragma omp critical
372</pre>
373
374<p>to define a section of code in your callback get method that must be executed by a single thread at a time.</p>
375
376<p>The format of the GetPixelViewIterator method is:</p>
377
378<pre class="code">
379 MagickBooleanType GetPixelViewIterator(PixelView *source,
380 GetPixelViewMethod get,void *context)
381</pre>
382
383<p>A description of each parameter follows:</p>
384
385<h5>source</h5>
386<p>the source pixel view.</p>
387
388<h5>get</h5>
389<p>the get callback method.</p>
390
391<h5>context</h5>
392<p>the user defined context.</p>
393
394 </div>
395<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewPixels">GetPixelViewPixels</a></h2>
396<div class="doc-section">
397
398<p>GetPixelViewPixels() returns the pixel view pixel_wands.</p>
399
400<p>The format of the GetPixelViewPixels method is:</p>
401
402<pre class="code">
403 PixelWand *GetPixelViewPixels(const PixelView *pixel_view)
404</pre>
405
406<p>A description of each parameter follows:</p>
407
408<h5>pixel_view</h5>
409<p>the pixel view.</p>
410
411 </div>
412<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewWand">GetPixelViewWand</a></h2>
413<div class="doc-section">
414
415<p>GetPixelViewWand() returns the magick wand associated with the pixel view.</p>
416
417<p>The format of the GetPixelViewWand method is:</p>
418
419<pre class="code">
420 MagickWand *GetPixelViewWand(const PixelView *pixel_view)
421</pre>
422
423<p>A description of each parameter follows:</p>
424
425<h5>pixel_view</h5>
426<p>the pixel view.</p>
427
428 </div>
429<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewWidth">GetPixelViewWidth</a></h2>
430<div class="doc-section">
431
432<p>GetPixelViewWidth() returns the pixel view width.</p>
433
434<p>The format of the GetPixelViewWidth method is:</p>
435
436<pre class="code">
437 size_t GetPixelViewWidth(const PixelView *pixel_view)
438</pre>
439
440<p>A description of each parameter follows:</p>
441
442<h5>pixel_view</h5>
443<p>the pixel view.</p>
444
445 </div>
446<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewX">GetPixelViewX</a></h2>
447<div class="doc-section">
448
449<p>GetPixelViewX() returns the pixel view x offset.</p>
450
451<p>The format of the GetPixelViewX method is:</p>
452
453<pre class="code">
454 ssize_t GetPixelViewX(const PixelView *pixel_view)
455</pre>
456
457<p>A description of each parameter follows:</p>
458
459<h5>pixel_view</h5>
460<p>the pixel view.</p>
461
462 </div>
463<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewY">GetPixelViewY</a></h2>
464<div class="doc-section">
465
466<p>GetPixelViewY() returns the pixel view y offset.</p>
467
468<p>The format of the GetPixelViewY method is:</p>
469
470<pre class="code">
471 ssize_t GetPixelViewY(const PixelView *pixel_view)
472</pre>
473
474<p>A description of each parameter follows:</p>
475
476<h5>pixel_view</h5>
477<p>the pixel view.</p>
478
479 </div>
480<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="IsPixelView">IsPixelView</a></h2>
481<div class="doc-section">
482
483<p>IsPixelView() returns MagickTrue if the the parameter is verified as a pixel view container.</p>
484
485<p>The format of the IsPixelView method is:</p>
486
487<pre class="code">
488 MagickBooleanType IsPixelView(const PixelView *pixel_view)
489</pre>
490
491<p>A description of each parameter follows:</p>
492
493<h5>pixel_view</h5>
494<p>the pixel view.</p>
495
496 </div>
497<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickClipPathImage">MagickClipPathImage</a></h2>
498<div class="doc-section">
499
500<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>
501
502<p>The format of the MagickClipPathImage method is:</p>
503
504<pre class="code">
505 MagickBooleanType MagickClipPathImage(MagickWand *wand,
506 const char *pathname,const MagickBooleanType inside)
507</pre>
508
509<p>A description of each parameter follows:</p>
510
511<h5>wand</h5>
512<p>the magick wand.</p>
513
514<h5>pathname</h5>
515<p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p>
516
517<h5>inside</h5>
518<p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p>
519
520 </div>
521<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawGetFillAlpha">DrawGetFillAlpha</a></h2>
522<div class="doc-section">
523
524<p>DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture. Fully opaque is 1.0.</p>
525
526<p>The format of the DrawGetFillAlpha method is:</p>
527
528<pre class="code">
529 double DrawGetFillAlpha(const DrawingWand *wand)
530</pre>
531
532<p>A description of each parameter follows:</p>
533
534<h5>wand</h5>
535<p>the drawing wand.</p>
536
537 </div>
538<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawGetStrokeAlpha">DrawGetStrokeAlpha</a></h2>
539<div class="doc-section">
540
541<p>DrawGetStrokeAlpha() returns the alpha of stroked object outlines.</p>
542
543<p>The format of the DrawGetStrokeAlpha method is:</p>
544
545<pre class="code">
546 double DrawGetStrokeAlpha(const DrawingWand *wand)
547</pre>
548
549<p>A description of each parameter follows:</p>
550
551<h5>wand</h5>
552<p>the drawing wand. </p>
553 </div>
554<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawPeekGraphicWand">DrawPeekGraphicWand</a></h2>
555<div class="doc-section">
556
557<p>DrawPeekGraphicWand() returns the current drawing wand.</p>
558
559<p>The format of the PeekDrawingWand method is:</p>
560
561<pre class="code">
562 DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
563</pre>
564
565<p>A description of each parameter follows:</p>
566
567<h5>wand</h5>
568<p>the drawing wand.</p>
569
570 </div>
571<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawPopGraphicContext">DrawPopGraphicContext</a></h2>
572<div class="doc-section">
573
574<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>
575
576<p>The format of the DrawPopGraphicContext method is:</p>
577
578<pre class="code">
579 MagickBooleanType DrawPopGraphicContext(DrawingWand *wand)
580</pre>
581
582<p>A description of each parameter follows:</p>
583
584<h5>wand</h5>
585<p>the drawing wand.</p>
586
587 </div>
588<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawPushGraphicContext">DrawPushGraphicContext</a></h2>
589<div class="doc-section">
590
591<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>
592
593<p>The format of the DrawPushGraphicContext method is:</p>
594
595<pre class="code">
596 MagickBooleanType DrawPushGraphicContext(DrawingWand *wand)
597</pre>
598
599<p>A description of each parameter follows:</p>
600
601<h5>wand</h5>
602<p>the drawing wand.</p>
603
604 </div>
605<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawSetFillAlpha">DrawSetFillAlpha</a></h2>
606<div class="doc-section">
607
608<p>DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture. Fully opaque is 1.0.</p>
609
610<p>The format of the DrawSetFillAlpha method is:</p>
611
612<pre class="code">
613 void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
614</pre>
615
616<p>A description of each parameter follows:</p>
617
618<h5>wand</h5>
619<p>the drawing wand.</p>
620
621<h5>fill_alpha</h5>
622<p>fill alpha</p>
623
624 </div>
625<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawSetStrokeAlpha">DrawSetStrokeAlpha</a></h2>
626<div class="doc-section">
627
628<p>DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.</p>
629
630<p>The format of the DrawSetStrokeAlpha method is:</p>
631
632<pre class="code">
633 void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
634</pre>
635
636<p>A description of each parameter follows:</p>
637
638<h5>wand</h5>
639<p>the drawing wand.</p>
640
641<h5>stroke_alpha</h5>
642<p>stroke alpha. The value 1.0 is opaque.</p>
643
644 </div>
645<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickColorFloodfillImage">MagickColorFloodfillImage</a></h2>
646<div class="doc-section">
647
648<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>
649
650<p>The format of the MagickColorFloodfillImage method is:</p>
651
652<pre class="code">
653 MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
654 const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
655 const ssize_t x,const ssize_t y)
656</pre>
657
658<p>A description of each parameter follows:</p>
659
660<h5>wand</h5>
661<p>the magick wand.</p>
662
663<h5>fill</h5>
664<p>the floodfill color pixel wand.</p>
665
666<h5>fuzz</h5>
667<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>
668
669<h5>bordercolor</h5>
670<p>the border color pixel wand.</p>
671
672<h5>x,y</h5>
673<p>the starting location of the operation.</p>
674
675 </div>
676<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickDescribeImage">MagickDescribeImage</a></h2>
677<div class="doc-section">
678
679<p>MagickDescribeImage() identifies an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p>
680
681<p>The format of the MagickDescribeImage method is:</p>
682
683<pre class="code">
684 const char *MagickDescribeImage(MagickWand *wand)
685</pre>
686
687<p>A description of each parameter follows:</p>
688
689<h5>wand</h5>
690<p>the magick wand.</p>
691
692 </div>
693<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickFlattenImages">MagickFlattenImages</a></h2>
694<div class="doc-section">
695
696<p>MagickFlattenImages() merges a sequence of images. This useful for combining Photoshop layers into a single image.</p>
697
698<p>The format of the MagickFlattenImages method is:</p>
699
700<pre class="code">
701 MagickWand *MagickFlattenImages(MagickWand *wand)
702</pre>
703
704<p>A description of each parameter follows:</p>
705
706<h5>wand</h5>
707<p>the magick wand.</p>
708
709 </div>
710<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickGetImageAttribute">MagickGetImageAttribute</a></h2>
711<div class="doc-section">
712
713<p>MagickGetImageAttribute() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p>
714
715<p>The format of the MagickGetImageAttribute method is:</p>
716
717<pre class="code">
718 char *MagickGetImageAttribute(MagickWand *wand,const char *property)
719</pre>
720
721<p>A description of each parameter follows:</p>
722
723<h5>wand</h5>
724<p>the magick wand.</p>
725
726<h5>property</h5>
727<p>the property.</p>
728
729 </div>
730<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickGetImageMatte">MagickGetImageMatte</a></h2>
731<div class="doc-section">
732
733<p>MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.</p>
734
735<p>The format of the MagickGetImageMatte method is:</p>
736
737<pre class="code">
738 size_t MagickGetImageMatte(MagickWand *wand)
739</pre>
740
741<p>A description of each parameter follows:</p>
742
743<h5>wand</h5>
744<p>the magick wand.</p>
745
746 </div>
747<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickGetImagePixels">MagickGetImagePixels</a></h2>
748<div class="doc-section">
749
750<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>
751
752<p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
753
754<pre class="text">
755 MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
756</pre>
757
758<p>The format of the MagickGetImagePixels method is:</p>
759
760<pre class="code">
761 MagickBooleanType MagickGetImagePixels(MagickWand *wand,
762 const ssize_t x,const ssize_t y,const size_t columns,
763 const size_t rows,const char *map,const StorageType storage,
764 void *pixels)
765</pre>
766
767<p>A description of each parameter follows:</p>
768
769<h5>wand</h5>
770<p>the magick wand.</p>
771
772<h5>x, y, columns, rows</h5>
773<p>These values define the perimeter of a region of pixels you want to extract.</p>
774
775<h5>map</h5>
776<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>
777
778<h5>storage</h5>
779<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>
780
781<h5>pixels</h5>
782<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>
783
784 </div>
785<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickGetImageSize">MagickGetImageSize</a></h2>
786<div class="doc-section">
787
788<p>MagickGetImageSize() returns the image length in bytes.</p>
789
790<p>The format of the MagickGetImageSize method is:</p>
791
792<pre class="code">
793 MagickBooleanType MagickGetImageSize(MagickWand *wand,
794 MagickSizeType *length)
795</pre>
796
797<p>A description of each parameter follows:</p>
798
799<h5>wand</h5>
800<p>the magick wand.</p>
801
802<h5>length</h5>
803<p>the image length in bytes.</p>
804
805 </div>
806<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMapImage">MagickMapImage</a></h2>
807<div class="doc-section">
808
809<p>MagickMapImage() replaces the colors of an image with the closest color from a reference image.</p>
810
811<p>The format of the MagickMapImage method is:</p>
812
813<pre class="code">
814 MagickBooleanType MagickMapImage(MagickWand *wand,
815 const MagickWand *map_wand,const MagickBooleanType dither)
816</pre>
817
818<p>A description of each parameter follows:</p>
819
820<h5>wand</h5>
821<p>the magick wand.</p>
822
823<h5>map</h5>
824<p>the map wand.</p>
825
826<h5>dither</h5>
827<p>Set this integer value to something other than zero to dither the mapped image.</p>
828
829 </div>
830<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMatteFloodfillImage">MagickMatteFloodfillImage</a></h2>
831<div class="doc-section">
832
833<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>
834
835<p>The format of the MagickMatteFloodfillImage method is:</p>
836
837<pre class="code">
838 MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
839 const double alpha,const double fuzz,const PixelWand *bordercolor,
840 const ssize_t x,const ssize_t y)
841</pre>
842
843<p>A description of each parameter follows:</p>
844
845<h5>wand</h5>
846<p>the magick wand.</p>
847
848<h5>alpha</h5>
849<p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p>
850
851<h5>fuzz</h5>
852<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>
853
854<h5>bordercolor</h5>
855<p>the border color pixel wand.</p>
856
857<h5>x,y</h5>
858<p>the starting location of the operation.</p>
859
860 </div>
861<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMedianFilterImage">MagickMedianFilterImage</a></h2>
862<div class="doc-section">
863
864<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>
865
866<p>The format of the MagickMedianFilterImage method is:</p>
867
868<pre class="code">
869 MagickBooleanType MagickMedianFilterImage(MagickWand *wand,
870 const double radius)
871</pre>
872
873<p>A description of each parameter follows:</p>
874
875<h5>wand</h5>
876<p>the magick wand.</p>
877
878<h5>radius</h5>
879<p>the radius of the pixel neighborhood.</p>
880
881 </div>
882<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMinimumImages">MagickMinimumImages</a></h2>
883<div class="doc-section">
884
885<p>MagickMinimumImages() returns the minimum intensity of an image sequence.</p>
886
887<p>The format of the MagickMinimumImages method is:</p>
888
889<pre class="code">
890 MagickWand *MagickMinimumImages(MagickWand *wand)
891</pre>
892
893<p>A description of each parameter follows:</p>
894
895<h5>wand</h5>
896<p>the magick wand.</p>
897
898 </div>
899<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickModeImage">MagickModeImage</a></h2>
900<div class="doc-section">
901
902<p>MagickModeImage() makes each pixel the 'predominant color' of the neighborhood of the specified radius.</p>
903
904<p>The format of the MagickModeImage method is:</p>
905
906<pre class="code">
907 MagickBooleanType MagickModeImage(MagickWand *wand,
908 const double radius)
909</pre>
910
911<p>A description of each parameter follows:</p>
912
913<h5>wand</h5>
914<p>the magick wand.</p>
915
916<h5>radius</h5>
917<p>the radius of the pixel neighborhood.</p>
918
919 </div>
920<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMosaicImages">MagickMosaicImages</a></h2>
921<div class="doc-section">
922
923<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>
924
925<p>The format of the MagickMosaicImages method is:</p>
926
927<pre class="code">
928 MagickWand *MagickMosaicImages(MagickWand *wand)
929</pre>
930
931<p>A description of each parameter follows:</p>
932
933<h5>wand</h5>
934<p>the magick wand.</p>
935
936 </div>
937<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickOpaqueImage">MagickOpaqueImage</a></h2>
938<div class="doc-section">
939
940<p>MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.</p>
941
942<p>The format of the MagickOpaqueImage method is:</p>
943
944<pre class="code">
945 MagickBooleanType MagickOpaqueImage(MagickWand *wand,
946 const PixelWand *target,const PixelWand *fill,const double fuzz)
947</pre>
948
949<p>A description of each parameter follows:</p>
950
951<h5>wand</h5>
952<p>the magick wand.</p>
953
954<h5>channel</h5>
955<p>the channel(s).</p>
956
957<h5>target</h5>
958<p>Change this target color to the fill color within the image.</p>
959
960<h5>fill</h5>
961<p>the fill pixel wand.</p>
962
963<h5>fuzz</h5>
964<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>
965
966 </div>
967<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickPaintFloodfillImage">MagickPaintFloodfillImage</a></h2>
968<div class="doc-section">
969
970<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>
971
972<p>The format of the MagickPaintFloodfillImage method is:</p>
973
974<pre class="code">
975 MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
976 const ChannelType channel,const PixelWand *fill,const double fuzz,
977 const PixelWand *bordercolor,const ssize_t x,const ssize_t y)
978</pre>
979
980<p>A description of each parameter follows:</p>
981
982<h5>wand</h5>
983<p>the magick wand.</p>
984
985<h5>channel</h5>
986<p>the channel(s).</p>
987
988<h5>fill</h5>
989<p>the floodfill color pixel wand.</p>
990
991<h5>fuzz</h5>
992<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>
993
994<h5>bordercolor</h5>
995<p>the border color pixel wand.</p>
996
997<h5>x,y</h5>
998<p>the starting location of the operation.</p>
999
1000 </div>
1001<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickPaintOpaqueImage">MagickPaintOpaqueImage</a></h2>
1002<div class="doc-section">
1003
1004<p>MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p>
1005
1006<p>The format of the MagickPaintOpaqueImage method is:</p>
1007
1008<pre class="code">
1009 MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
1010 const PixelWand *target,const PixelWand *fill,const double fuzz)
1011 MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
1012 const ChannelType channel,const PixelWand *target,
1013 const PixelWand *fill,const double fuzz)
1014</pre>
1015
1016<p>A description of each parameter follows:</p>
1017
1018<h5>wand</h5>
1019<p>the magick wand.</p>
1020
1021<h5>channel</h5>
1022<p>the channel(s).</p>
1023
1024<h5>target</h5>
1025<p>Change this target color to the fill color within the image.</p>
1026
1027<h5>fill</h5>
1028<p>the fill pixel wand.</p>
1029
1030<h5>fuzz</h5>
1031<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>
1032
1033 </div>
1034<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickPaintTransparentImage">MagickPaintTransparentImage</a></h2>
1035<div class="doc-section">
1036
1037<p>MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.</p>
1038
1039<p>The format of the MagickPaintTransparentImage method is:</p>
1040
1041<pre class="code">
1042 MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
1043 const PixelWand *target,const double alpha,const double fuzz)
1044</pre>
1045
1046<p>A description of each parameter follows:</p>
1047
1048<h5>wand</h5>
1049<p>the magick wand.</p>
1050
1051<h5>target</h5>
1052<p>Change this target color to specified opacity value within the image.</p>
1053
1054<h5>alpha</h5>
1055<p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p>
1056
1057<h5>fuzz</h5>
1058<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>
1059
1060 </div>
1061<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickRecolorImage">MagickRecolorImage</a></h2>
1062<div class="doc-section">
1063
1064<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>
1065
1066<p>The format of the MagickRecolorImage method is:</p>
1067
1068<pre class="code">
1069 MagickBooleanType MagickRecolorImage(MagickWand *wand,
1070 const size_t order,const double *color_matrix)
1071</pre>
1072
1073<p>A description of each parameter follows:</p>
1074
1075<h5>wand</h5>
1076<p>the magick wand.</p>
1077
1078<h5>order</h5>
1079<p>the number of columns and rows in the color matrix.</p>
1080
1081<h5>color_matrix</h5>
1082<p>An array of doubles representing the color matrix.</p>
1083
1084 </div>
1085<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickReduceNoiseImage">MagickReduceNoiseImage</a></h2>
1086<div class="doc-section">
1087
1088<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>
1089
1090<p>The format of the MagickReduceNoiseImage method is:</p>
1091
1092<pre class="code">
1093 MagickBooleanType MagickReduceNoiseImage(MagickWand *wand,
1094 const double radius)
1095</pre>
1096
1097<p>A description of each parameter follows:</p>
1098
1099<h5>wand</h5>
1100<p>the magick wand.</p>
1101
1102<h5>radius</h5>
1103<p>the radius of the pixel neighborhood.</p>
1104
1105 </div>
1106<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMaximumImages">MagickMaximumImages</a></h2>
1107<div class="doc-section">
1108
1109<p>MagickMaximumImages() returns the maximum intensity of an image sequence.</p>
1110
1111<p>The format of the MagickMaximumImages method is:</p>
1112
1113<pre class="code">
1114 MagickWand *MagickMaximumImages(MagickWand *wand)
1115</pre>
1116
1117<p>A description of each parameter follows:</p>
1118
1119<h5>wand</h5>
1120<p>the magick wand.</p>
1121
1122 </div>
1123<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickSetImageAttribute">MagickSetImageAttribute</a></h2>
1124<div class="doc-section">
1125
1126<p>MagickSetImageAttribute() associates a property with an image.</p>
1127
1128<p>The format of the MagickSetImageAttribute method is:</p>
1129
1130<pre class="code">
1131 MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
1132 const char *property,const char *value)
1133</pre>
1134
1135<p>A description of each parameter follows:</p>
1136
1137<h5>wand</h5>
1138<p>the magick wand.</p>
1139
1140<h5>property</h5>
1141<p>the property.</p>
1142
1143<h5>value</h5>
1144<p>the value.</p>
1145
1146 </div>
1147<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickSetImageIndex">MagickSetImageIndex</a></h2>
1148<div class="doc-section">
1149
1150<p>MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.</p>
1151
1152<p>The format of the MagickSetImageIndex method is:</p>
1153
1154<pre class="code">
1155 MagickBooleanType MagickSetImageIndex(MagickWand *wand,
1156 const ssize_t index)
1157</pre>
1158
1159<p>A description of each parameter follows:</p>
1160
1161<h5>wand</h5>
1162<p>the magick wand.</p>
1163
1164<h5>index</h5>
1165<p>the scene number.</p>
1166
1167 </div>
1168<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickTransparentImage">MagickTransparentImage</a></h2>
1169<div class="doc-section">
1170
1171<p>MagickTransparentImage() changes any pixel that matches color with the color defined by fill.</p>
1172
1173<p>The format of the MagickTransparentImage method is:</p>
1174
1175<pre class="code">
1176 MagickBooleanType MagickTransparentImage(MagickWand *wand,
1177 const PixelWand *target,const double alpha,const double fuzz)
1178</pre>
1179
1180<p>A description of each parameter follows:</p>
1181
1182<h5>wand</h5>
1183<p>the magick wand.</p>
1184
1185<h5>target</h5>
1186<p>Change this target color to specified opacity value within the image.</p>
1187
1188<h5>alpha</h5>
1189<p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p>
1190
1191<h5>fuzz</h5>
1192<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>
1193
1194 </div>
1195<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickRegionOfInterestImage">MagickRegionOfInterestImage</a></h2>
1196<div class="doc-section">
1197
1198<p>MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.</p>
1199
1200<p>The format of the MagickRegionOfInterestImage method is:</p>
1201
1202<pre class="code">
1203 MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
1204 const size_t width,const size_t height,const ssize_t x,
1205 const ssize_t y)
1206</pre>
1207
1208<p>A description of each parameter follows:</p>
1209
1210<h5>wand</h5>
1211<p>the magick wand.</p>
1212
1213<h5>width</h5>
1214<p>the region width.</p>
1215
1216<h5>height</h5>
1217<p>the region height.</p>
1218
1219<h5>x</h5>
1220<p>the region x offset.</p>
1221
1222<h5>y</h5>
1223<p>the region y offset.</p>
1224
1225 </div>
1226<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickSetImagePixels">MagickSetImagePixels</a></h2>
1227<div class="doc-section">
1228
1229<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>
1230
1231<p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
1232
1233<pre class="text">
1234 MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
1235</pre>
1236
1237<p>The format of the MagickSetImagePixels method is:</p>
1238
1239<pre class="code">
1240 MagickBooleanType MagickSetImagePixels(MagickWand *wand,
1241 const ssize_t x,const ssize_t y,const size_t columns,
1242 const size_t rows,const char *map,const StorageType storage,
1243 const void *pixels)
1244</pre>
1245
1246<p>A description of each parameter follows:</p>
1247
1248<h5>wand</h5>
1249<p>the magick wand.</p>
1250
1251<h5>x, y, columns, rows</h5>
1252<p>These values define the perimeter of a region of pixels you want to define.</p>
1253
1254<h5>map</h5>
1255<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>
1256
1257<h5>storage</h5>
1258<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>
1259
1260<h5>pixels</h5>
1261<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>
1262
1263 </div>
1264<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickWriteImageBlob">MagickWriteImageBlob</a></h2>
1265<div class="doc-section">
1266
1267<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>
1268
1269<p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p>
1270
1271<p>The format of the MagickWriteImageBlob method is:</p>
1272
1273<pre class="code">
1274 unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
1275</pre>
1276
1277<p>A description of each parameter follows:</p>
1278
1279<h5>wand</h5>
1280<p>the magick wand.</p>
1281
1282<h5>length</h5>
1283<p>the length of the blob.</p>
1284
1285 </div>
1286<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="NewPixelView">NewPixelView</a></h2>
1287<div class="doc-section">
1288
1289<p>NewPixelView() returns a pixel view required for all other methods in the Pixel View API.</p>
1290
1291<p>The format of the NewPixelView method is:</p>
1292
1293<pre class="code">
1294 PixelView *NewPixelView(MagickWand *wand)
1295</pre>
1296
1297<p>A description of each parameter follows:</p>
1298
1299<h5>wand</h5>
1300<p>the wand.</p>
1301
1302 </div>
1303<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="NewPixelViewRegion">NewPixelViewRegion</a></h2>
1304<div class="doc-section">
1305
1306<p>NewPixelViewRegion() returns a pixel view required for all other methods in the Pixel View API.</p>
1307
1308<p>The format of the NewPixelViewRegion method is:</p>
1309
1310<pre class="code">
1311 PixelView *NewPixelViewRegion(MagickWand *wand,const ssize_t x,
1312 const ssize_t y,const size_t width,const size_t height)
1313</pre>
1314
1315<p>A description of each parameter follows:</p>
1316
1317<h5>wand</h5>
1318<p>the magick wand.</p>
1319
1320<h5>x,y,columns,rows</h5>
1321<p>These values define the perimeter of a region of pixel_wands view.</p>
1322
1323 </div>
1324<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="PixelGetNextRow">PixelGetNextRow</a></h2>
1325<div class="doc-section">
1326
1327<p>PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.</p>
1328
1329<p>The format of the PixelGetNextRow method is:</p>
1330
1331<pre class="code">
1332 PixelWand **PixelGetNextRow(PixelIterator *iterator,
1333 size_t *number_wands)
1334</pre>
1335
1336<p>A description of each parameter follows:</p>
1337
1338<h5>iterator</h5>
1339<p>the pixel iterator.</p>
1340
1341<h5>number_wands</h5>
1342<p>the number of pixel wands.</p>
1343
1344 </div>
1345<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="PixelIteratorGetException">PixelIteratorGetException</a></h2>
1346<div class="doc-section">
1347
1348<p>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
1349
1350<p>The format of the PixelIteratorGetException method is:</p>
1351
1352<pre class="code">
1353 char *PixelIteratorGetException(const Pixeliterator *iterator,
1354 ExceptionType *severity)
1355</pre>
1356
1357<p>A description of each parameter follows:</p>
1358
1359<h5>iterator</h5>
1360<p>the pixel iterator.</p>
1361
1362<h5>severity</h5>
1363<p>the severity of the error is returned here.</p>
1364
1365 </div>
1366<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="SetPixelViewIterator">SetPixelViewIterator</a></h2>
1367<div class="doc-section">
1368
1369<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>
1370
1371<p>Use this pragma:</p>
1372
1373<pre class="text">
1374 #pragma omp critical
1375</pre>
1376
1377<p>to define a section of code in your callback set method that must be executed by a single thread at a time.</p>
1378
1379<p>The format of the SetPixelViewIterator method is:</p>
1380
1381<pre class="code">
1382 MagickBooleanType SetPixelViewIterator(PixelView *destination,
1383 SetPixelViewMethod set,void *context)
1384</pre>
1385
1386<p>A description of each parameter follows:</p>
1387
1388<h5>destination</h5>
1389<p>the pixel view.</p>
1390
1391<h5>set</h5>
1392<p>the set callback method.</p>
1393
1394<h5>context</h5>
1395<p>the user defined context.</p>
1396
1397 </div>
1398<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="TransferPixelViewIterator">TransferPixelViewIterator</a></h2>
1399<div class="doc-section">
1400
1401<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>
1402
1403<p>Use this pragma:</p>
1404
1405<pre class="text">
1406 #pragma omp critical
1407</pre>
1408
1409<p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p>
1410
1411<p>The format of the TransferPixelViewIterator method is:</p>
1412
1413<pre class="code">
1414 MagickBooleanType TransferPixelViewIterator(PixelView *source,
1415 PixelView *destination,TransferPixelViewMethod transfer,void *context)
1416</pre>
1417
1418<p>A description of each parameter follows:</p>
1419
1420<h5>source</h5>
1421<p>the source pixel view.</p>
1422
1423<h5>destination</h5>
1424<p>the destination pixel view.</p>
1425
1426<h5>transfer</h5>
1427<p>the transfer callback method.</p>
1428
1429<h5>context</h5>
1430<p>the user defined context.</p>
1431
1432 </div>
1433<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="UpdatePixelViewIterator">UpdatePixelViewIterator</a></h2>
1434<div class="doc-section">
1435
1436<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>
1437
1438<p>Use this pragma:</p>
1439
1440<pre class="text">
1441 #pragma omp critical
1442</pre>
1443
1444<p>to define a section of code in your callback update method that must be executed by a single thread at a time.</p>
1445
1446<p>The format of the UpdatePixelViewIterator method is:</p>
1447
1448<pre class="code">
1449 MagickBooleanType UpdatePixelViewIterator(PixelView *source,
1450 UpdatePixelViewMethod update,void *context)
1451</pre>
1452
1453<p>A description of each parameter follows:</p>
1454
1455<h5>source</h5>
1456<p>the source pixel view.</p>
1457
1458<h5>update</h5>
1459<p>the update callback method.</p>
1460
1461<h5>context</h5>
1462<p>the user defined context.</p>
1463
1464 </div>
cristy06f63f22012-10-31 00:50:07 +00001465
1466</div>
1467
1468<div id="linkbar">
1469 <span id="linkbar-west">&nbsp;</span>
cristy8ee7f242013-06-20 16:08:44 +00001470
cristy06f63f22012-10-31 00:50:07 +00001471 <span id="linkbar-center">
cristy8ee7f242013-06-20 16:08:44 +00001472 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
1473 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> &bull;
1474 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
cristy06f63f22012-10-31 00:50:07 +00001475 </span>
1476 <span id="linkbar-east">&nbsp;</span>
1477 </div>
1478 <div class="footer">
cristy8ee7f242013-06-20 16:08:44 +00001479 <span id="footer-west">&copy; 1999-2013 ImageMagick Studio LLC</span>
cristyd8833bf2013-02-24 22:14:53 +00001480 <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
cristy06f63f22012-10-31 00:50:07 +00001481 </div>
1482 <div style="clear: both; margin: 0; width: 100%; "></div>
cristy06f63f22012-10-31 00:50:07 +00001483</body>
1484</html>