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