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