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