granicus.if.org Git - imagemagick/blob - 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">\r
   4 <head>\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
  10   --></style>\r
  11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  12   <title>ImageMagick: MagickWand, C API for ImageMagick: Deprecated Methods</title>
  13   <meta http-equiv="Content-Language" content="en-US"/>
  14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="Generator" content="PHP"/>
  17   <meta name="Keywords" content="magickwc, api, for, imagemagick:, deprecated, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  18   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
  19   <meta name="Rating" content="GENERAL"/>
  20   <meta name="Robots" content="INDEX, FOLLOW"/>
  21   <meta name="Generator" content="ImageMagick Studio LLC"/>
  22   <meta name="Author" content="ImageMagick Studio LLC"/>
  23   <meta name="Revisit-after" content="2 DAYS"/>
  24   <meta name="Resource-type" content="document"/>
  25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  26   <meta name="Distribution" content="Global"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../../index.html">\r
  32   <img src="../../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../../index.html">\r
  41   <img src="../../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="eastbar">\r
  46 \r
  47 <div class="menu">
  48   <a href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
 128 </div>
 129 <div  class="sponsor">
 130   <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 134 </div>
 135 <div  class="sponsor">
 136   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 140 </div>
 141 <div  class="sponsor">
 142   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 143 </div>
 144 <div  class="sponsor">
 145    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 146 </div>
 147 <div  class="sponsor">
 148    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 149 </div>
 150 </div>
 151 </div>
 152 \r
 153 \r
 154 </div>\r
 155 \r
 156 <div class="main">\r
 157 \r
 158 <p class="navigation-index">[<a href="#MagickAverageImages">MagickAverageImages</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="#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="#PixelGetNextRow">PixelGetNextRow</a> &bull; <a href="#PixelIteratorGetException">PixelIteratorGetException</a>]</p>
 159
 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">
 163
 164 <p>MagickAverageImages() average a set of images.</p></ol>
 165
 166 <p>The format of the MagickAverageImages method is:</p>
 167
 168 <pre class="code">
 169   MagickWand *MagickAverageImages(MagickWand *wand)
 170 </pre>
 171
 172 <p>A description of each parameter follows:</p></ol>
 173
 174 <h5>wand</h5>
 175 <ol><p>the magick wand.</p></ol>
 176
 177  </div>
 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">
 181
 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>
 183
 184 <p>The format of the MagickClipPathImage method is:</p>
 185
 186 <pre class="code">
 187   MagickBooleanType MagickClipPathImage(MagickWand *wand,
 188     const char *pathname,const MagickBooleanType inside)
 189 </pre>
 190
 191 <p>A description of each parameter follows:</p></ol>
 192
 193 <h5>wand</h5>
 194 <ol><p>the magick wand.</p></ol>
 195
 196 <h5>pathname</h5>
 197 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
 198
 199 <h5>inside</h5>
 200 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
 201
 202  </div>
 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">
 206
 207 <p>DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture.  Fully opaque is 1.0.</p></ol>
 208
 209 <p>The format of the DrawGetFillAlpha method is:</p>
 210
 211 <pre class="code">
 212   double DrawGetFillAlpha(const DrawingWand *wand)
 213 </pre>
 214
 215 <p>A description of each parameter follows:</p></ol>
 216
 217 <h5>wand</h5>
 218 <ol><p>the drawing wand.</p></ol>
 219
 220  </div>
 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">
 224
 225 <p>DrawGetStrokeAlpha() returns the alpha of stroked object outlines.</p></ol>
 226
 227 <p>The format of the DrawGetStrokeAlpha method is:</p>
 228
 229 <pre class="code">
 230   double DrawGetStrokeAlpha(const DrawingWand *wand)
 231 </pre>
 232
 233 <p>A description of each parameter follows:</p></ol>
 234
 235 <h5>wand</h5>
 236 <ol><p>the drawing wand. </p>
 237  </div>
 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">
 241
 242 <p>DrawPeekGraphicWand() returns the current drawing wand.</p></ol>
 243
 244 <p>The format of the PeekDrawingWand method is:</p>
 245
 246 <pre class="code">
 247   DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
 248 </pre>
 249
 250 <p>A description of each parameter follows:</p></ol>
 251
 252 <h5>wand</h5>
 253 <ol><p>the drawing wand.</p></ol>
 254
 255  </div>
 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">
 259
 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>
 261
 262 <p>The format of the DrawPopGraphicContext method is:</p>
 263
 264 <pre class="code">
 265   MagickBooleanType DrawPopGraphicContext(DrawingWand *wand)
 266 </pre>
 267
 268 <p>A description of each parameter follows:</p></ol>
 269
 270 <h5>wand</h5>
 271 <ol><p>the drawing wand.</p></ol>
 272
 273  </div>
 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">
 277
 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>
 279
 280 <p>The format of the DrawPushGraphicContext method is:</p>
 281
 282 <pre class="code">
 283   MagickBooleanType DrawPushGraphicContext(DrawingWand *wand)
 284 </pre>
 285
 286 <p>A description of each parameter follows:</p></ol>
 287
 288 <h5>wand</h5>
 289 <ol><p>the drawing wand.</p></ol>
 290
 291  </div>
 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">
 295
 296 <p>DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture.  Fully opaque is 1.0.</p></ol>
 297
 298 <p>The format of the DrawSetFillAlpha method is:</p>
 299
 300 <pre class="code">
 301   void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
 302 </pre>
 303
 304 <p>A description of each parameter follows:</p></ol>
 305
 306 <h5>wand</h5>
 307 <ol><p>the drawing wand.</p></ol>
 308
 309 <h5>fill_alpha</h5>
 310 <ol><p>fill alpha</p></ol>
 311
 312  </div>
 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">
 316
 317 <p>DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.</p></ol>
 318
 319 <p>The format of the DrawSetStrokeAlpha method is:</p>
 320
 321 <pre class="code">
 322   void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
 323 </pre>
 324
 325 <p>A description of each parameter follows:</p></ol>
 326
 327 <h5>wand</h5>
 328 <ol><p>the drawing wand.</p></ol>
 329
 330 <h5>stroke_alpha</h5>
 331 <ol><p>stroke alpha.  The value 1.0 is opaque.</p></ol>
 332
 333  </div>
 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">
 337
 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>
 339
 340 <p>The format of the MagickColorFloodfillImage method is:</p>
 341
 342 <pre class="code">
 343   MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
 344     const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
 345     const long x,const long y)
 346 </pre>
 347
 348 <p>A description of each parameter follows:</p></ol>
 349
 350 <h5>wand</h5>
 351 <ol><p>the magick wand.</p></ol>
 352
 353 <h5>fill</h5>
 354 <ol><p>the floodfill color pixel wand.</p></ol>
 355
 356 <h5>fuzz</h5>
 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>
 358
 359 <h5>bordercolor</h5>
 360 <ol><p>the border color pixel wand.</p></ol>
 361
 362 <h5>x,y</h5>
 363 <ol><p>the starting location of the operation.</p></ol>
 364
 365  </div>
 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">
 369
 370 <p>MagickDescribeImage() identifies an image by printing its attributes to the file.  Attributes include the image width, height, size, and others.</p></ol>
 371
 372 <p>The format of the MagickDescribeImage method is:</p>
 373
 374 <pre class="code">
 375   const char *MagickDescribeImage(MagickWand *wand)
 376 </pre>
 377
 378 <p>A description of each parameter follows:</p></ol>
 379
 380 <h5>wand</h5>
 381 <ol><p>the magick wand.</p></ol>
 382
 383  </div>
 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">
 387
 388 <p>MagickFlattenImages() merges a sequence of images.  This useful for combining Photoshop layers into a single image.</p></ol>
 389
 390 <p>The format of the MagickFlattenImages method is:</p>
 391
 392 <pre class="code">
 393   MagickWand *MagickFlattenImages(MagickWand *wand)
 394 </pre>
 395
 396 <p>A description of each parameter follows:</p></ol>
 397
 398 <h5>wand</h5>
 399 <ol><p>the magick wand.</p></ol>
 400
 401  </div>
 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">
 405
 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>
 407
 408 <p>The format of the MagickGetImageAttribute method is:</p>
 409
 410 <pre class="code">
 411   char *MagickGetImageAttribute(MagickWand *wand,const char *property)
 412 </pre>
 413
 414 <p>A description of each parameter follows:</p></ol>
 415
 416 <h5>wand</h5>
 417 <ol><p>the magick wand.</p></ol>
 418
 419 <h5>property</h5>
 420 <ol><p>the property.</p></ol>
 421
 422  </div>
 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">
 426
 427 <p>MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.</p></ol>
 428
 429 <p>The format of the MagickGetImageMatte method is:</p>
 430
 431 <pre class="code">
 432   unsigned long MagickGetImageMatte(MagickWand *wand)
 433 </pre>
 434
 435 <p>A description of each parameter follows:</p></ol>
 436
 437 <h5>wand</h5>
 438 <ol><p>the magick wand.</p></ol>
 439
 440  </div>
 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">
 444
 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>
 446
 447 <p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
 448
 449 <pre class="text">
 450   MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
 451 </pre>
 452
 453 <p>The format of the MagickGetImagePixels method is:</p>
 454
 455 <pre class="code">
 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,
 459     void *pixels)
 460 </pre>
 461
 462 <p>A description of each parameter follows:</p></ol>
 463
 464 <h5>wand</h5>
 465 <ol><p>the magick wand.</p></ol>
 466
 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>
 469
 470 <h5>map</h5>
 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>
 472
 473 <h5>storage</h5>
 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>
 475
 476 <h5>pixels</h5>
 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>
 478
 479  </div>
 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">
 483
 484 <p>MagickGetImageSize() returns the image length in bytes.</p></ol>
 485
 486 <p>The format of the MagickGetImageSize method is:</p>
 487
 488 <pre class="code">
 489   MagickBooleanType MagickGetImageSize(MagickWand *wand,
 490     MagickSizeType *length)
 491 </pre>
 492
 493 <p>A description of each parameter follows:</p></ol>
 494
 495 <h5>wand</h5>
 496 <ol><p>the magick wand.</p></ol>
 497
 498 <h5>length</h5>
 499 <ol><p>the image length in bytes.</p></ol>
 500
 501  </div>
 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">
 505
 506 <p>MagickMapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
 507
 508 <p>The format of the MagickMapImage method is:</p>
 509
 510 <pre class="code">
 511   MagickBooleanType MagickMapImage(MagickWand *wand,
 512     const MagickWand *map_wand,const MagickBooleanType dither)
 513 </pre>
 514
 515 <p>A description of each parameter follows:</p></ol>
 516
 517 <h5>wand</h5>
 518 <ol><p>the magick wand.</p></ol>
 519
 520 <h5>map</h5>
 521 <ol><p>the map wand.</p></ol>
 522
 523 <h5>dither</h5>
 524 <ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
 525
 526  </div>
 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">
 530
 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>
 532
 533 <p>The format of the MagickMatteFloodfillImage method is:</p>
 534
 535 <pre class="code">
 536   MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
 537     const double alpha,const double fuzz,const PixelWand *bordercolor,
 538     const long x,const long y)
 539 </pre>
 540
 541 <p>A description of each parameter follows:</p></ol>
 542
 543 <h5>wand</h5>
 544 <ol><p>the magick wand.</p></ol>
 545
 546 <h5>alpha</h5>
 547 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
 548
 549 <h5>fuzz</h5>
 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>
 551
 552 <h5>bordercolor</h5>
 553 <ol><p>the border color pixel wand.</p></ol>
 554
 555 <h5>x,y</h5>
 556 <ol><p>the starting location of the operation.</p></ol>
 557
 558  </div>
 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">
 562
 563 <p>MagickMaximumImages() returns the maximum intensity of an image sequence.</p></ol>
 564
 565 <p>The format of the MagickMaximumImages method is:</p>
 566
 567 <pre class="code">
 568   MagickWand *MagickMaximumImages(MagickWand *wand)
 569 </pre>
 570
 571 <p>A description of each parameter follows:</p></ol>
 572
 573 <h5>wand</h5>
 574 <ol><p>the magick wand.</p></ol>
 575
 576  </div>
 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">
 580
 581 <p>MagickMinimumImages() returns the minimum intensity of an image sequence.</p></ol>
 582
 583 <p>The format of the MagickMinimumImages method is:</p>
 584
 585 <pre class="code">
 586   MagickWand *MagickMinimumImages(MagickWand *wand)
 587 </pre>
 588
 589 <p>A description of each parameter follows:</p></ol>
 590
 591 <h5>wand</h5>
 592 <ol><p>the magick wand.</p></ol>
 593
 594  </div>
 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">
 598
 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>
 600
 601 <p>The format of the MagickMosaicImages method is:</p>
 602
 603 <pre class="code">
 604   MagickWand *MagickMosaicImages(MagickWand *wand)
 605 </pre>
 606
 607 <p>A description of each parameter follows:</p></ol>
 608
 609 <h5>wand</h5>
 610 <ol><p>the magick wand.</p></ol>
 611
 612  </div>
 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">
 616
 617 <p>MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 618
 619 <p>The format of the MagickOpaqueImage method is:</p>
 620
 621 <pre class="code">
 622   MagickBooleanType MagickOpaqueImage(MagickWand *wand,
 623     const PixelWand *target,const PixelWand *fill,const double fuzz)
 624 </pre>
 625
 626 <p>A description of each parameter follows:</p></ol>
 627
 628 <h5>wand</h5>
 629 <ol><p>the magick wand.</p></ol>
 630
 631 <h5>channel</h5>
 632 <ol><p>the channel(s).</p></ol>
 633
 634 <h5>target</h5>
 635 <ol><p>Change this target color to the fill color within the image.</p></ol>
 636
 637 <h5>fill</h5>
 638 <ol><p>the fill pixel wand.</p></ol>
 639
 640 <h5>fuzz</h5>
 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>
 642
 643  </div>
 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">
 647
 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>
 649
 650 <p>The format of the MagickPaintFloodfillImage method is:</p>
 651
 652 <pre class="code">
 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)
 656 </pre>
 657
 658 <p>A description of each parameter follows:</p></ol>
 659
 660 <h5>wand</h5>
 661 <ol><p>the magick wand.</p></ol>
 662
 663 <h5>channel</h5>
 664 <ol><p>the channel(s).</p></ol>
 665
 666 <h5>fill</h5>
 667 <ol><p>the floodfill color pixel wand.</p></ol>
 668
 669 <h5>fuzz</h5>
 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>
 671
 672 <h5>bordercolor</h5>
 673 <ol><p>the border color pixel wand.</p></ol>
 674
 675 <h5>x,y</h5>
 676 <ol><p>the starting location of the operation.</p></ol>
 677
 678  </div>
 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">
 682
 683 <p>MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 684
 685 <p>The format of the MagickPaintOpaqueImage method is:</p>
 686
 687 <pre class="code">
 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)
 693 </pre>
 694
 695 <p>A description of each parameter follows:</p></ol>
 696
 697 <h5>wand</h5>
 698 <ol><p>the magick wand.</p></ol>
 699
 700 <h5>channel</h5>
 701 <ol><p>the channel(s).</p></ol>
 702
 703 <h5>target</h5>
 704 <ol><p>Change this target color to the fill color within the image.</p></ol>
 705
 706 <h5>fill</h5>
 707 <ol><p>the fill pixel wand.</p></ol>
 708
 709 <h5>fuzz</h5>
 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>
 711
 712  </div>
 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">
 716
 717 <p>MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 718
 719 <p>The format of the MagickPaintTransparentImage method is:</p>
 720
 721 <pre class="code">
 722   MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
 723     const PixelWand *target,const double alpha,const double fuzz)
 724 </pre>
 725
 726 <p>A description of each parameter follows:</p></ol>
 727
 728 <h5>wand</h5>
 729 <ol><p>the magick wand.</p></ol>
 730
 731 <h5>target</h5>
 732 <ol><p>Change this target color to specified opacity value within the image.</p></ol>
 733
 734 <h5>alpha</h5>
 735 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
 736
 737 <h5>fuzz</h5>
 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>
 739
 740  </div>
 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">
 744
 745 <p>MagickSetImageAttribute() associates a property with an image.</p></ol>
 746
 747 <p>The format of the MagickSetImageAttribute method is:</p>
 748
 749 <pre class="code">
 750   MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
 751     const char *property,const char *value)
 752 </pre>
 753
 754 <p>A description of each parameter follows:</p></ol>
 755
 756 <h5>wand</h5>
 757 <ol><p>the magick wand.</p></ol>
 758
 759 <h5>property</h5>
 760 <ol><p>the property.</p></ol>
 761
 762 <h5>value</h5>
 763 <ol><p>the value.</p></ol>
 764
 765  </div>
 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">
 769
 770 <p>MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.</p></ol>
 771
 772 <p>The format of the MagickSetImageIndex method is:</p>
 773
 774 <pre class="code">
 775   MagickBooleanType MagickSetImageIndex(MagickWand *wand,const long index)
 776 </pre>
 777
 778 <p>A description of each parameter follows:</p></ol>
 779
 780 <h5>wand</h5>
 781 <ol><p>the magick wand.</p></ol>
 782
 783 <h5>index</h5>
 784 <ol><p>the scene number.</p></ol>
 785
 786  </div>
 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">
 790
 791 <p>MagickTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 792
 793 <p>The format of the MagickTransparentImage method is:</p>
 794
 795 <pre class="code">
 796   MagickBooleanType MagickTransparentImage(MagickWand *wand,
 797     const PixelWand *target,const double alpha,const double fuzz)
 798 </pre>
 799
 800 <p>A description of each parameter follows:</p></ol>
 801
 802 <h5>wand</h5>
 803 <ol><p>the magick wand.</p></ol>
 804
 805 <h5>target</h5>
 806 <ol><p>Change this target color to specified opacity value within the image.</p></ol>
 807
 808 <h5>alpha</h5>
 809 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
 810
 811 <h5>fuzz</h5>
 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>
 813
 814  </div>
 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">
 818
 819 <p>MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.</p></ol>
 820
 821 <p>The format of the MagickRegionOfInterestImage method is:</p>
 822
 823 <pre class="code">
 824   MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
 825     const unsigned long width,const unsigned long height,const long x,
 826     const long y)
 827 </pre>
 828
 829 <p>A description of each parameter follows:</p></ol>
 830
 831 <h5>wand</h5>
 832 <ol><p>the magick wand.</p></ol>
 833
 834 <h5>width</h5>
 835 <ol><p>the region width.</p></ol>
 836
 837 <h5>height</h5>
 838 <ol><p>the region height.</p></ol>
 839
 840 <h5>x</h5>
 841 <ol><p>the region x offset.</p></ol>
 842
 843 <h5>y</h5>
 844 <ol><p>the region y offset.</p></ol>
 845
 846  </div>
 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">
 850
 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>
 852
 853 <p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
 854
 855 <pre class="text">
 856   MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
 857 </pre>
 858
 859 <p>The format of the MagickSetImagePixels method is:</p>
 860
 861 <pre class="code">
 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,
 865     const void *pixels)
 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 <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>
 875
 876 <h5>map</h5>
 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>
 878
 879 <h5>storage</h5>
 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>
 881
 882 <h5>pixels</h5>
 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>
 884
 885  </div>
 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">
 889
 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>
 891
 892 <p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p></ol>
 893
 894 <p>The format of the MagickWriteImageBlob method is:</p>
 895
 896 <pre class="code">
 897   unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
 898 </pre>
 899
 900 <p>A description of each parameter follows:</p></ol>
 901
 902 <h5>wand</h5>
 903 <ol><p>the magick wand.</p></ol>
 904
 905 <h5>length</h5>
 906 <ol><p>the length of the blob.</p></ol>
 907
 908  </div>
 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">
 912
 913 <p>PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
 914
 915 <p>The format of the PixelGetNextRow method is:</p>
 916
 917 <pre class="code">
 918   PixelWand **PixelGetNextRow(PixelIterator *iterator,
 919     unsigned long *number_wands)
 920 </pre>
 921
 922 <p>A description of each parameter follows:</p></ol>
 923
 924 <h5>iterator</h5>
 925 <ol><p>the pixel iterator.</p></ol>
 926
 927 <h5>number_wands</h5>
 928 <ol><p>the number of pixel wands.</p></ol>
 929
 930  </div>
 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">
 934
 935 <p>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
 936
 937 <p>The format of the PixelIteratorGetException method is:</p>
 938
 939 <pre class="code">
 940   char *PixelIteratorGetException(const Pixeliterator *iterator,
 941     ExceptionType *severity)
 942 </pre>
 943
 944 <p>A description of each parameter follows:</p></ol>
 945
 946 <h5>iterator</h5>
 947 <ol><p>the pixel iterator.</p></ol>
 948
 949 <h5>severity</h5>
 950 <ol><p>the severity of the error is returned here.</p></ol>
 951
 952  </div>
 953 \r
 954 </div>\r
 955 \r
 956 <div id="linkbar">\r
 957  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 958     <span id="linkbar-center">\r
 959       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 960     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 961     </span>\r
 962     <span id="linkbar-east">&nbsp;</span>\r
 963   </div>\r
 964   <div class="footer">\r
 965     <span id="footer-west">&copy; 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
 967   </div>\r
 968   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 969 </body>\r
 970 </html>\r