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