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