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