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">
\r
5 <meta http-equiv="Content-Type" value="application/xhtml+xml" />
\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="screen,projection"><!--
\r
9 @import url("../../www/magick.css");
\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"/>
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
45 <div class="eastbar">
\r
48 <a href="../../index.html">About ImageMagick</a>
50 <div class="sep"></div>
\r
52 <a href="../../www/command-line-tools.html">Command-line Tools</a>
55 <a href="../../www/command-line-processing.html">Processing</a>
58 <a href="../../www/command-line-options.html">Options</a>
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
64 <a href="../../www/api.html">Program Interfaces</a>
67 <a href="../../www/magick-wand.html">MagickWand</a>
70 <a href="../../www/magick-core.html">MagickCore</a>
73 <a href="../../www/perl-magick.html">PerlMagick</a>
76 <a href="../../Magick++/">Magick++</a>
79 <a href="../../www/architecture.html">Architecture</a>
81 <div class="sep"></div>
\r
83 <a href="../../www/install-source.html">Install from Source</a>
86 <a href="../../www/install-source.html#unix">Unix</a>
89 <a href="../../www/install-source.html#windows">Windows</a>
92 <a href="../../www/binary-releases.html">Binary Releases</a>
95 <a href="../../www/binary-releases.html#unix">Unix</a>
98 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
101 <a href="../../www/binary-releases.html#windows">Windows</a>
104 <a href="../../www/resources.html">Resources</a>
106 <div class="sep"></div>
\r
108 <a href="../../www/download.html">Download</a>
110 <div class="sep"></div>
\r
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
114 <div class="sep"></div>
\r
116 <a href="../../www/sitemap.html">Site Map</a>
119 <a href="../../www/links.html">Links</a>
121 <div class="sep"></div>
\r
123 <a href="../../www/sponsors.html">Sponsors:</a>
125 <div class="sponsbox">
126 <div class="sponsor">
127 <a href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
129 <div class="sponsor">
130 <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
132 <div class="sponsor">
133 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
135 <div class="sponsor">
136 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
138 <div class="sponsor">
139 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
141 <div class="sponsor">
142 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
144 <div class="sponsor">
145 <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
147 <div class="sponsor">
148 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
158 <p class="navigation-index">[<a href="#MagickAverageImages">MagickAverageImages</a> • <a href="#MagickClipPathImage">MagickClipPathImage</a> • <a href="#DrawGetFillAlpha">DrawGetFillAlpha</a> • <a href="#DrawGetStrokeAlpha">DrawGetStrokeAlpha</a> • <a href="#DrawPeekGraphicWand">DrawPeekGraphicWand</a> • <a href="#DrawPopGraphicContext">DrawPopGraphicContext</a> • <a href="#DrawPushGraphicContext">DrawPushGraphicContext</a> • <a href="#DrawSetFillAlpha">DrawSetFillAlpha</a> • <a href="#DrawSetStrokeAlpha">DrawSetStrokeAlpha</a> • <a href="#MagickColorFloodfillImage">MagickColorFloodfillImage</a> • <a href="#MagickDescribeImage">MagickDescribeImage</a> • <a href="#MagickFlattenImages">MagickFlattenImages</a> • <a href="#MagickGetImageAttribute">MagickGetImageAttribute</a> • <a href="#MagickGetImageMatte">MagickGetImageMatte</a> • <a href="#MagickGetImagePixels">MagickGetImagePixels</a> • <a href="#MagickGetImageSize">MagickGetImageSize</a> • <a href="#MagickMapImage">MagickMapImage</a> • <a href="#MagickMatteFloodfillImage">MagickMatteFloodfillImage</a> • <a href="#MagickMaximumImages">MagickMaximumImages</a> • <a href="#MagickMinimumImages">MagickMinimumImages</a> • <a href="#MagickMosaicImages">MagickMosaicImages</a> • <a href="#MagickOpaqueImage">MagickOpaqueImage</a> • <a href="#MagickPaintFloodfillImage">MagickPaintFloodfillImage</a> • <a href="#MagickPaintOpaqueImage">MagickPaintOpaqueImage</a> • <a href="#MagickPaintTransparentImage">MagickPaintTransparentImage</a> • <a href="#MagickSetImageAttribute">MagickSetImageAttribute</a> • <a href="#MagickSetImageIndex">MagickSetImageIndex</a> • <a href="#MagickTransparentImage">MagickTransparentImage</a> • <a href="#MagickRegionOfInterestImage">MagickRegionOfInterestImage</a> • <a href="#MagickSetImagePixels">MagickSetImagePixels</a> • <a href="#MagickWriteImageBlob">MagickWriteImageBlob</a> • <a href="#PixelGetNextRow">PixelGetNextRow</a> • <a href="#PixelIteratorGetException">PixelIteratorGetException</a>]</p>
160 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
161 _8c.html" target="source" name="MagickAverageImages">MagickAverageImages</a></h2>
162 <div class="doc-section">
164 <p>MagickAverageImages() average a set of images.</p></ol>
166 <p>The format of the MagickAverageImages method is:</p>
169 MagickWand *MagickAverageImages(MagickWand *wand)
172 <p>A description of each parameter follows:</p></ol>
175 <ol><p>the magick wand.</p></ol>
178 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
179 _8c.html" target="source" name="MagickClipPathImage">MagickClipPathImage</a></h2>
180 <div class="doc-section">
182 <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>
184 <p>The format of the MagickClipPathImage method is:</p>
187 MagickBooleanType MagickClipPathImage(MagickWand *wand,
188 const char *pathname,const MagickBooleanType inside)
191 <p>A description of each parameter follows:</p></ol>
194 <ol><p>the magick wand.</p></ol>
197 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
200 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
203 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
204 _8c.html" target="source" name="DrawGetFillAlpha">DrawGetFillAlpha</a></h2>
205 <div class="doc-section">
207 <p>DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture. Fully opaque is 1.0.</p></ol>
209 <p>The format of the DrawGetFillAlpha method is:</p>
212 double DrawGetFillAlpha(const DrawingWand *wand)
215 <p>A description of each parameter follows:</p></ol>
218 <ol><p>the drawing wand.</p></ol>
221 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
222 _8c.html" target="source" name="DrawGetStrokeAlpha">DrawGetStrokeAlpha</a></h2>
223 <div class="doc-section">
225 <p>DrawGetStrokeAlpha() returns the alpha of stroked object outlines.</p></ol>
227 <p>The format of the DrawGetStrokeAlpha method is:</p>
230 double DrawGetStrokeAlpha(const DrawingWand *wand)
233 <p>A description of each parameter follows:</p></ol>
236 <ol><p>the drawing wand. </p>
238 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
239 _8c.html" target="source" name="DrawPeekGraphicWand">DrawPeekGraphicWand</a></h2>
240 <div class="doc-section">
242 <p>DrawPeekGraphicWand() returns the current drawing wand.</p></ol>
244 <p>The format of the PeekDrawingWand method is:</p>
247 DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
250 <p>A description of each parameter follows:</p></ol>
253 <ol><p>the drawing wand.</p></ol>
256 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
257 _8c.html" target="source" name="DrawPopGraphicContext">DrawPopGraphicContext</a></h2>
258 <div class="doc-section">
260 <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>
262 <p>The format of the DrawPopGraphicContext method is:</p>
265 MagickBooleanType DrawPopGraphicContext(DrawingWand *wand)
268 <p>A description of each parameter follows:</p></ol>
271 <ol><p>the drawing wand.</p></ol>
274 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
275 _8c.html" target="source" name="DrawPushGraphicContext">DrawPushGraphicContext</a></h2>
276 <div class="doc-section">
278 <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>
280 <p>The format of the DrawPushGraphicContext method is:</p>
283 MagickBooleanType DrawPushGraphicContext(DrawingWand *wand)
286 <p>A description of each parameter follows:</p></ol>
289 <ol><p>the drawing wand.</p></ol>
292 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
293 _8c.html" target="source" name="DrawSetFillAlpha">DrawSetFillAlpha</a></h2>
294 <div class="doc-section">
296 <p>DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture. Fully opaque is 1.0.</p></ol>
298 <p>The format of the DrawSetFillAlpha method is:</p>
301 void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
304 <p>A description of each parameter follows:</p></ol>
307 <ol><p>the drawing wand.</p></ol>
310 <ol><p>fill alpha</p></ol>
313 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
314 _8c.html" target="source" name="DrawSetStrokeAlpha">DrawSetStrokeAlpha</a></h2>
315 <div class="doc-section">
317 <p>DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.</p></ol>
319 <p>The format of the DrawSetStrokeAlpha method is:</p>
322 void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
325 <p>A description of each parameter follows:</p></ol>
328 <ol><p>the drawing wand.</p></ol>
330 <h5>stroke_alpha</h5>
331 <ol><p>stroke alpha. The value 1.0 is opaque.</p></ol>
334 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
335 _8c.html" target="source" name="MagickColorFloodfillImage">MagickColorFloodfillImage</a></h2>
336 <div class="doc-section">
338 <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>
340 <p>The format of the MagickColorFloodfillImage method is:</p>
343 MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
344 const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
345 const long x,const long y)
348 <p>A description of each parameter follows:</p></ol>
351 <ol><p>the magick wand.</p></ol>
354 <ol><p>the floodfill color pixel wand.</p></ol>
357 <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>
360 <ol><p>the border color pixel wand.</p></ol>
363 <ol><p>the starting location of the operation.</p></ol>
366 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
367 _8c.html" target="source" name="MagickDescribeImage">MagickDescribeImage</a></h2>
368 <div class="doc-section">
370 <p>MagickDescribeImage() identifies an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p></ol>
372 <p>The format of the MagickDescribeImage method is:</p>
375 const char *MagickDescribeImage(MagickWand *wand)
378 <p>A description of each parameter follows:</p></ol>
381 <ol><p>the magick wand.</p></ol>
384 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
385 _8c.html" target="source" name="MagickFlattenImages">MagickFlattenImages</a></h2>
386 <div class="doc-section">
388 <p>MagickFlattenImages() merges a sequence of images. This useful for combining Photoshop layers into a single image.</p></ol>
390 <p>The format of the MagickFlattenImages method is:</p>
393 MagickWand *MagickFlattenImages(MagickWand *wand)
396 <p>A description of each parameter follows:</p></ol>
399 <ol><p>the magick wand.</p></ol>
402 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
403 _8c.html" target="source" name="MagickGetImageAttribute">MagickGetImageAttribute</a></h2>
404 <div class="doc-section">
406 <p>MagickGetImageAttribute() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
408 <p>The format of the MagickGetImageAttribute method is:</p>
411 char *MagickGetImageAttribute(MagickWand *wand,const char *property)
414 <p>A description of each parameter follows:</p></ol>
417 <ol><p>the magick wand.</p></ol>
420 <ol><p>the property.</p></ol>
423 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
424 _8c.html" target="source" name="MagickGetImageMatte">MagickGetImageMatte</a></h2>
425 <div class="doc-section">
427 <p>MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.</p></ol>
429 <p>The format of the MagickGetImageMatte method is:</p>
432 unsigned long MagickGetImageMatte(MagickWand *wand)
435 <p>A description of each parameter follows:</p></ol>
438 <ol><p>the magick wand.</p></ol>
441 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
442 _8c.html" target="source" name="MagickGetImagePixels">MagickGetImagePixels</a></h2>
443 <div class="doc-section">
445 <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, long, float, or double in the order specified by map.</p></ol>
447 <p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
450 MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
453 <p>The format of the MagickGetImagePixels method is:</p>
456 MagickBooleanType MagickGetImagePixels(MagickWand *wand,
457 const long x,const long y,const unsigned long columns,
458 const unsigned long rows,const char *map,const StorageType storage,
462 <p>A description of each parameter follows:</p></ol>
465 <ol><p>the magick wand.</p></ol>
467 <h5>x, y, columns, rows</h5>
468 <ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
471 <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>
474 <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>
477 <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>
480 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
481 _8c.html" target="source" name="MagickGetImageSize">MagickGetImageSize</a></h2>
482 <div class="doc-section">
484 <p>MagickGetImageSize() returns the image length in bytes.</p></ol>
486 <p>The format of the MagickGetImageSize method is:</p>
489 MagickBooleanType MagickGetImageSize(MagickWand *wand,
490 MagickSizeType *length)
493 <p>A description of each parameter follows:</p></ol>
496 <ol><p>the magick wand.</p></ol>
499 <ol><p>the image length in bytes.</p></ol>
502 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
503 _8c.html" target="source" name="MagickMapImage">MagickMapImage</a></h2>
504 <div class="doc-section">
506 <p>MagickMapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
508 <p>The format of the MagickMapImage method is:</p>
511 MagickBooleanType MagickMapImage(MagickWand *wand,
512 const MagickWand *map_wand,const MagickBooleanType dither)
515 <p>A description of each parameter follows:</p></ol>
518 <ol><p>the magick wand.</p></ol>
521 <ol><p>the map wand.</p></ol>
524 <ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
527 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
528 _8c.html" target="source" name="MagickMatteFloodfillImage">MagickMatteFloodfillImage</a></h2>
529 <div class="doc-section">
531 <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>
533 <p>The format of the MagickMatteFloodfillImage method is:</p>
536 MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
537 const double alpha,const double fuzz,const PixelWand *bordercolor,
538 const long x,const long y)
541 <p>A description of each parameter follows:</p></ol>
544 <ol><p>the magick wand.</p></ol>
547 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
550 <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>
553 <ol><p>the border color pixel wand.</p></ol>
556 <ol><p>the starting location of the operation.</p></ol>
559 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
560 _8c.html" target="source" name="MagickMaximumImages">MagickMaximumImages</a></h2>
561 <div class="doc-section">
563 <p>MagickMaximumImages() returns the maximum intensity of an image sequence.</p></ol>
565 <p>The format of the MagickMaximumImages method is:</p>
568 MagickWand *MagickMaximumImages(MagickWand *wand)
571 <p>A description of each parameter follows:</p></ol>
574 <ol><p>the magick wand.</p></ol>
577 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
578 _8c.html" target="source" name="MagickMinimumImages">MagickMinimumImages</a></h2>
579 <div class="doc-section">
581 <p>MagickMinimumImages() returns the minimum intensity of an image sequence.</p></ol>
583 <p>The format of the MagickMinimumImages method is:</p>
586 MagickWand *MagickMinimumImages(MagickWand *wand)
589 <p>A description of each parameter follows:</p></ol>
592 <ol><p>the magick wand.</p></ol>
595 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
596 _8c.html" target="source" name="MagickMosaicImages">MagickMosaicImages</a></h2>
597 <div class="doc-section">
599 <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>
601 <p>The format of the MagickMosaicImages method is:</p>
604 MagickWand *MagickMosaicImages(MagickWand *wand)
607 <p>A description of each parameter follows:</p></ol>
610 <ol><p>the magick wand.</p></ol>
613 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
614 _8c.html" target="source" name="MagickOpaqueImage">MagickOpaqueImage</a></h2>
615 <div class="doc-section">
617 <p>MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
619 <p>The format of the MagickOpaqueImage method is:</p>
622 MagickBooleanType MagickOpaqueImage(MagickWand *wand,
623 const PixelWand *target,const PixelWand *fill,const double fuzz)
626 <p>A description of each parameter follows:</p></ol>
629 <ol><p>the magick wand.</p></ol>
632 <ol><p>the channel(s).</p></ol>
635 <ol><p>Change this target color to the fill color within the image.</p></ol>
638 <ol><p>the fill pixel wand.</p></ol>
641 <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>
644 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
645 _8c.html" target="source" name="MagickPaintFloodfillImage">MagickPaintFloodfillImage</a></h2>
646 <div class="doc-section">
648 <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>
650 <p>The format of the MagickPaintFloodfillImage method is:</p>
653 MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
654 const ChannelType channel,const PixelWand *fill,const double fuzz,
655 const PixelWand *bordercolor,const long x,const long y)
658 <p>A description of each parameter follows:</p></ol>
661 <ol><p>the magick wand.</p></ol>
664 <ol><p>the channel(s).</p></ol>
667 <ol><p>the floodfill color pixel wand.</p></ol>
670 <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>
673 <ol><p>the border color pixel wand.</p></ol>
676 <ol><p>the starting location of the operation.</p></ol>
679 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
680 _8c.html" target="source" name="MagickPaintOpaqueImage">MagickPaintOpaqueImage</a></h2>
681 <div class="doc-section">
683 <p>MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
685 <p>The format of the MagickPaintOpaqueImage method is:</p>
688 MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
689 const PixelWand *target,const PixelWand *fill,const double fuzz)
690 MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
691 const ChannelType channel,const PixelWand *target,
692 const PixelWand *fill,const double fuzz)
695 <p>A description of each parameter follows:</p></ol>
698 <ol><p>the magick wand.</p></ol>
701 <ol><p>the channel(s).</p></ol>
704 <ol><p>Change this target color to the fill color within the image.</p></ol>
707 <ol><p>the fill pixel wand.</p></ol>
710 <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>
713 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
714 _8c.html" target="source" name="MagickPaintTransparentImage">MagickPaintTransparentImage</a></h2>
715 <div class="doc-section">
717 <p>MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
719 <p>The format of the MagickPaintTransparentImage method is:</p>
722 MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
723 const PixelWand *target,const double alpha,const double fuzz)
726 <p>A description of each parameter follows:</p></ol>
729 <ol><p>the magick wand.</p></ol>
732 <ol><p>Change this target color to specified opacity value within the image.</p></ol>
735 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
738 <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>
741 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
742 _8c.html" target="source" name="MagickSetImageAttribute">MagickSetImageAttribute</a></h2>
743 <div class="doc-section">
745 <p>MagickSetImageAttribute() associates a property with an image.</p></ol>
747 <p>The format of the MagickSetImageAttribute method is:</p>
750 MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
751 const char *property,const char *value)
754 <p>A description of each parameter follows:</p></ol>
757 <ol><p>the magick wand.</p></ol>
760 <ol><p>the property.</p></ol>
763 <ol><p>the value.</p></ol>
766 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
767 _8c.html" target="source" name="MagickSetImageIndex">MagickSetImageIndex</a></h2>
768 <div class="doc-section">
770 <p>MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.</p></ol>
772 <p>The format of the MagickSetImageIndex method is:</p>
775 MagickBooleanType MagickSetImageIndex(MagickWand *wand,const long index)
778 <p>A description of each parameter follows:</p></ol>
781 <ol><p>the magick wand.</p></ol>
784 <ol><p>the scene number.</p></ol>
787 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
788 _8c.html" target="source" name="MagickTransparentImage">MagickTransparentImage</a></h2>
789 <div class="doc-section">
791 <p>MagickTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
793 <p>The format of the MagickTransparentImage method is:</p>
796 MagickBooleanType MagickTransparentImage(MagickWand *wand,
797 const PixelWand *target,const double alpha,const double fuzz)
800 <p>A description of each parameter follows:</p></ol>
803 <ol><p>the magick wand.</p></ol>
806 <ol><p>Change this target color to specified opacity value within the image.</p></ol>
809 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
812 <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>
815 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
816 _8c.html" target="source" name="MagickRegionOfInterestImage">MagickRegionOfInterestImage</a></h2>
817 <div class="doc-section">
819 <p>MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.</p></ol>
821 <p>The format of the MagickRegionOfInterestImage method is:</p>
824 MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
825 const unsigned long width,const unsigned long height,const long x,
829 <p>A description of each parameter follows:</p></ol>
832 <ol><p>the magick wand.</p></ol>
835 <ol><p>the region width.</p></ol>
838 <ol><p>the region height.</p></ol>
841 <ol><p>the region x offset.</p></ol>
844 <ol><p>the region y offset.</p></ol>
847 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
848 _8c.html" target="source" name="MagickSetImagePixels">MagickSetImagePixels</a></h2>
849 <div class="doc-section">
851 <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, long, float, or double in the order specified by map.</p></ol>
853 <p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
856 MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
859 <p>The format of the MagickSetImagePixels method is:</p>
862 MagickBooleanType MagickSetImagePixels(MagickWand *wand,
863 const long x,const long y,const unsigned long columns,
864 const unsigned long rows,const char *map,const StorageType storage,
868 <p>A description of each parameter follows:</p></ol>
871 <ol><p>the magick wand.</p></ol>
873 <h5>x, y, columns, rows</h5>
874 <ol><p>These values define the perimeter of a region of pixels you want to define.</p></ol>
877 <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>
880 <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>
883 <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>
886 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
887 _8c.html" target="source" name="MagickWriteImageBlob">MagickWriteImageBlob</a></h2>
888 <div class="doc-section">
890 <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>
892 <p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p></ol>
894 <p>The format of the MagickWriteImageBlob method is:</p>
897 unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
900 <p>A description of each parameter follows:</p></ol>
903 <ol><p>the magick wand.</p></ol>
906 <ol><p>the length of the blob.</p></ol>
909 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
910 _8c.html" target="source" name="PixelGetNextRow">PixelGetNextRow</a></h2>
911 <div class="doc-section">
913 <p>PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
915 <p>The format of the PixelGetNextRow method is:</p>
918 PixelWand **PixelGetNextRow(PixelIterator *iterator,
919 unsigned long *number_wands)
922 <p>A description of each parameter follows:</p></ol>
925 <ol><p>the pixel iterator.</p></ol>
927 <h5>number_wands</h5>
928 <ol><p>the number of pixel wands.</p></ol>
931 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
932 _8c.html" target="source" name="PixelIteratorGetException">PixelIteratorGetException</a></h2>
933 <div class="doc-section">
935 <p>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
937 <p>The format of the PixelIteratorGetException method is:</p>
940 char *PixelIteratorGetException(const Pixeliterator *iterator,
941 ExceptionType *severity)
944 <p>A description of each parameter follows:</p></ol>
947 <ol><p>the pixel iterator.</p></ol>
950 <ol><p>the severity of the error is returned here.</p></ol>
957 <!-- <span id="linkbar-west"> </span> -->
\r
958 <span id="linkbar-center">
\r
959 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
960 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
962 <span id="linkbar-east"> </span>
\r
964 <div class="footer">
\r
965 <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
\r
966 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
968 <div style="clear: both; margin: 0; width: 100%; "></div>
\r