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