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 name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  11   <title>ImageMagick: MagickWand, C API for ImageMagick: Deprecated Methods</title>
  12   <meta http-equiv="Content-Language" content="en-US"/>
  13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  15   <meta name="Generator" content="PHP"/>
  16   <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"/>
  17   <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."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20090501000200 -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 133 </div>
 134 <div  class="sponsor">
 135    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <p class="navigation-index">[<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="#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>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 157 _8c.html" target="source" name="MagickClipPathImage">MagickClipPathImage</a></h2>
 158 <div class="doc-section">
 159
 160 <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>
 161
 162 <p>The format of the MagickClipPathImage method is:</p>
 163
 164 <pre class="code">
 165   MagickBooleanType MagickClipPathImage(MagickWand *wand,
 166     const char *pathname,const MagickBooleanType inside)
 167 </pre>
 168
 169 <p>A description of each parameter follows:</p></ol>
 170
 171 <h5>wand</h5>
 172 <ol><p>the magick wand.</p></ol>
 173
 174 <h5>pathname</h5>
 175 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
 176
 177 <h5>inside</h5>
 178 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
 179
 180  </div>
 181 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 182 _8c.html" target="source" name="DrawGetFillAlpha">DrawGetFillAlpha</a></h2>
 183 <div class="doc-section">
 184
 185 <p>DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture.  Fully opaque is 1.0.</p></ol>
 186
 187 <p>The format of the DrawGetFillAlpha method is:</p>
 188
 189 <pre class="code">
 190   double DrawGetFillAlpha(const DrawingWand *wand)
 191 </pre>
 192
 193 <p>A description of each parameter follows:</p></ol>
 194
 195 <h5>wand</h5>
 196 <ol><p>the drawing wand.</p></ol>
 197
 198  </div>
 199 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 200 _8c.html" target="source" name="DrawGetStrokeAlpha">DrawGetStrokeAlpha</a></h2>
 201 <div class="doc-section">
 202
 203 <p>DrawGetStrokeAlpha() returns the alpha of stroked object outlines.</p></ol>
 204
 205 <p>The format of the DrawGetStrokeAlpha method is:</p>
 206
 207 <pre class="code">
 208   double DrawGetStrokeAlpha(const DrawingWand *wand)
 209 </pre>
 210
 211 <p>A description of each parameter follows:</p></ol>
 212
 213 <h5>wand</h5>
 214 <ol><p>the drawing wand. </p>
 215  </div>
 216 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 217 _8c.html" target="source" name="DrawPeekGraphicWand">DrawPeekGraphicWand</a></h2>
 218 <div class="doc-section">
 219
 220 <p>DrawPeekGraphicWand() returns the current drawing wand.</p></ol>
 221
 222 <p>The format of the PeekDrawingWand method is:</p>
 223
 224 <pre class="code">
 225   DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
 226 </pre>
 227
 228 <p>A description of each parameter follows:</p></ol>
 229
 230 <h5>wand</h5>
 231 <ol><p>the drawing wand.</p></ol>
 232
 233  </div>
 234 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 235 _8c.html" target="source" name="DrawPopGraphicContext">DrawPopGraphicContext</a></h2>
 236 <div class="doc-section">
 237
 238 <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>
 239
 240 <p>The format of the DrawPopGraphicContext method is:</p>
 241
 242 <pre class="code">
 243   MagickBooleanType DrawPopGraphicContext(DrawingWand *wand)
 244 </pre>
 245
 246 <p>A description of each parameter follows:</p></ol>
 247
 248 <h5>wand</h5>
 249 <ol><p>the drawing wand.</p></ol>
 250
 251  </div>
 252 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 253 _8c.html" target="source" name="DrawPushGraphicContext">DrawPushGraphicContext</a></h2>
 254 <div class="doc-section">
 255
 256 <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>
 257
 258 <p>The format of the DrawPushGraphicContext method is:</p>
 259
 260 <pre class="code">
 261   MagickBooleanType DrawPushGraphicContext(DrawingWand *wand)
 262 </pre>
 263
 264 <p>A description of each parameter follows:</p></ol>
 265
 266 <h5>wand</h5>
 267 <ol><p>the drawing wand.</p></ol>
 268
 269  </div>
 270 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 271 _8c.html" target="source" name="DrawSetFillAlpha">DrawSetFillAlpha</a></h2>
 272 <div class="doc-section">
 273
 274 <p>DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture.  Fully opaque is 1.0.</p></ol>
 275
 276 <p>The format of the DrawSetFillAlpha method is:</p>
 277
 278 <pre class="code">
 279   void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
 280 </pre>
 281
 282 <p>A description of each parameter follows:</p></ol>
 283
 284 <h5>wand</h5>
 285 <ol><p>the drawing wand.</p></ol>
 286
 287 <h5>fill_alpha</h5>
 288 <ol><p>fill alpha</p></ol>
 289
 290  </div>
 291 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 292 _8c.html" target="source" name="DrawSetStrokeAlpha">DrawSetStrokeAlpha</a></h2>
 293 <div class="doc-section">
 294
 295 <p>DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.</p></ol>
 296
 297 <p>The format of the DrawSetStrokeAlpha method is:</p>
 298
 299 <pre class="code">
 300   void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
 301 </pre>
 302
 303 <p>A description of each parameter follows:</p></ol>
 304
 305 <h5>wand</h5>
 306 <ol><p>the drawing wand.</p></ol>
 307
 308 <h5>stroke_alpha</h5>
 309 <ol><p>stroke alpha.  The value 1.0 is opaque.</p></ol>
 310
 311  </div>
 312 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 313 _8c.html" target="source" name="MagickColorFloodfillImage">MagickColorFloodfillImage</a></h2>
 314 <div class="doc-section">
 315
 316 <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>
 317
 318 <p>The format of the MagickColorFloodfillImage method is:</p>
 319
 320 <pre class="code">
 321   MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
 322     const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
 323     const long x,const long y)
 324 </pre>
 325
 326 <p>A description of each parameter follows:</p></ol>
 327
 328 <h5>wand</h5>
 329 <ol><p>the magick wand.</p></ol>
 330
 331 <h5>fill</h5>
 332 <ol><p>the floodfill color pixel wand.</p></ol>
 333
 334 <h5>fuzz</h5>
 335 <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>
 336
 337 <h5>bordercolor</h5>
 338 <ol><p>the border color pixel wand.</p></ol>
 339
 340 <h5>x,y</h5>
 341 <ol><p>the starting location of the operation.</p></ol>
 342
 343  </div>
 344 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 345 _8c.html" target="source" name="MagickDescribeImage">MagickDescribeImage</a></h2>
 346 <div class="doc-section">
 347
 348 <p>MagickDescribeImage() identifies an image by printing its attributes to the file.  Attributes include the image width, height, size, and others.</p></ol>
 349
 350 <p>The format of the MagickDescribeImage method is:</p>
 351
 352 <pre class="code">
 353   const char *MagickDescribeImage(MagickWand *wand)
 354 </pre>
 355
 356 <p>A description of each parameter follows:</p></ol>
 357
 358 <h5>wand</h5>
 359 <ol><p>the magick wand.</p></ol>
 360
 361  </div>
 362 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 363 _8c.html" target="source" name="MagickFlattenImages">MagickFlattenImages</a></h2>
 364 <div class="doc-section">
 365
 366 <p>MagickFlattenImages() merges a sequence of images.  This useful for combining Photoshop layers into a single image.</p></ol>
 367
 368 <p>The format of the MagickFlattenImages method is:</p>
 369
 370 <pre class="code">
 371   MagickWand *MagickFlattenImages(MagickWand *wand)
 372 </pre>
 373
 374 <p>A description of each parameter follows:</p></ol>
 375
 376 <h5>wand</h5>
 377 <ol><p>the magick wand.</p></ol>
 378
 379  </div>
 380 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 381 _8c.html" target="source" name="MagickGetImageAttribute">MagickGetImageAttribute</a></h2>
 382 <div class="doc-section">
 383
 384 <p>MagickGetImageAttribute() returns a value associated with the specified property.  Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
 385
 386 <p>The format of the MagickGetImageAttribute method is:</p>
 387
 388 <pre class="code">
 389   char *MagickGetImageAttribute(MagickWand *wand,const char *property)
 390 </pre>
 391
 392 <p>A description of each parameter follows:</p></ol>
 393
 394 <h5>wand</h5>
 395 <ol><p>the magick wand.</p></ol>
 396
 397 <h5>property</h5>
 398 <ol><p>the property.</p></ol>
 399
 400  </div>
 401 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 402 _8c.html" target="source" name="MagickGetImageMatte">MagickGetImageMatte</a></h2>
 403 <div class="doc-section">
 404
 405 <p>MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.</p></ol>
 406
 407 <p>The format of the MagickGetImageMatte method is:</p>
 408
 409 <pre class="code">
 410   unsigned long MagickGetImageMatte(MagickWand *wand)
 411 </pre>
 412
 413 <p>A description of each parameter follows:</p></ol>
 414
 415 <h5>wand</h5>
 416 <ol><p>the magick wand.</p></ol>
 417
 418  </div>
 419 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 420 _8c.html" target="source" name="MagickGetImagePixels">MagickGetImagePixels</a></h2>
 421 <div class="doc-section">
 422
 423 <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>
 424
 425 <p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
 426
 427 <pre class="text">
 428   MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
 429 </pre>
 430
 431 <p>The format of the MagickGetImagePixels method is:</p>
 432
 433 <pre class="code">
 434   MagickBooleanType MagickGetImagePixels(MagickWand *wand,
 435     const long x,const long y,const unsigned long columns,
 436     const unsigned long rows,const char *map,const StorageType storage,
 437     void *pixels)
 438 </pre>
 439
 440 <p>A description of each parameter follows:</p></ol>
 441
 442 <h5>wand</h5>
 443 <ol><p>the magick wand.</p></ol>
 444
 445 <h5>x, y, columns, rows</h5>
 446 <ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
 447
 448 <h5>map</h5>
 449 <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>
 450
 451 <h5>storage</h5>
 452 <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>
 453
 454 <h5>pixels</h5>
 455 <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>
 456
 457  </div>
 458 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 459 _8c.html" target="source" name="MagickGetImageSize">MagickGetImageSize</a></h2>
 460 <div class="doc-section">
 461
 462 <p>MagickGetImageSize() returns the image length in bytes.</p></ol>
 463
 464 <p>The format of the MagickGetImageSize method is:</p>
 465
 466 <pre class="code">
 467   MagickBooleanType MagickGetImageSize(MagickWand *wand,
 468     MagickSizeType *length)
 469 </pre>
 470
 471 <p>A description of each parameter follows:</p></ol>
 472
 473 <h5>wand</h5>
 474 <ol><p>the magick wand.</p></ol>
 475
 476 <h5>length</h5>
 477 <ol><p>the image length in bytes.</p></ol>
 478
 479  </div>
 480 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 481 _8c.html" target="source" name="MagickMapImage">MagickMapImage</a></h2>
 482 <div class="doc-section">
 483
 484 <p>MagickMapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
 485
 486 <p>The format of the MagickMapImage method is:</p>
 487
 488 <pre class="code">
 489   MagickBooleanType MagickMapImage(MagickWand *wand,
 490     const MagickWand *map_wand,const MagickBooleanType dither)
 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>map</h5>
 499 <ol><p>the map wand.</p></ol>
 500
 501 <h5>dither</h5>
 502 <ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
 503
 504  </div>
 505 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 506 _8c.html" target="source" name="MagickMatteFloodfillImage">MagickMatteFloodfillImage</a></h2>
 507 <div class="doc-section">
 508
 509 <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>
 510
 511 <p>The format of the MagickMatteFloodfillImage method is:</p>
 512
 513 <pre class="code">
 514   MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
 515     const double alpha,const double fuzz,const PixelWand *bordercolor,
 516     const long x,const long y)
 517 </pre>
 518
 519 <p>A description of each parameter follows:</p></ol>
 520
 521 <h5>wand</h5>
 522 <ol><p>the magick wand.</p></ol>
 523
 524 <h5>alpha</h5>
 525 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
 526
 527 <h5>fuzz</h5>
 528 <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>
 529
 530 <h5>bordercolor</h5>
 531 <ol><p>the border color pixel wand.</p></ol>
 532
 533 <h5>x,y</h5>
 534 <ol><p>the starting location of the operation.</p></ol>
 535
 536  </div>
 537 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 538 _8c.html" target="source" name="MagickMosaicImages">MagickMosaicImages</a></h2>
 539 <div class="doc-section">
 540
 541 <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>
 542
 543 <p>The format of the MagickMosaicImages method is:</p>
 544
 545 <pre class="code">
 546   MagickWand *MagickMosaicImages(MagickWand *wand)
 547 </pre>
 548
 549 <p>A description of each parameter follows:</p></ol>
 550
 551 <h5>wand</h5>
 552 <ol><p>the magick wand.</p></ol>
 553
 554  </div>
 555 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 556 _8c.html" target="source" name="MagickOpaqueImage">MagickOpaqueImage</a></h2>
 557 <div class="doc-section">
 558
 559 <p>MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 560
 561 <p>The format of the MagickOpaqueImage method is:</p>
 562
 563 <pre class="code">
 564   MagickBooleanType MagickOpaqueImage(MagickWand *wand,
 565     const PixelWand *target,const PixelWand *fill,const double fuzz)
 566 </pre>
 567
 568 <p>A description of each parameter follows:</p></ol>
 569
 570 <h5>wand</h5>
 571 <ol><p>the magick wand.</p></ol>
 572
 573 <h5>channel</h5>
 574 <ol><p>the channel(s).</p></ol>
 575
 576 <h5>target</h5>
 577 <ol><p>Change this target color to the fill color within the image.</p></ol>
 578
 579 <h5>fill</h5>
 580 <ol><p>the fill pixel wand.</p></ol>
 581
 582 <h5>fuzz</h5>
 583 <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>
 584
 585  </div>
 586 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 587 _8c.html" target="source" name="MagickPaintFloodfillImage">MagickPaintFloodfillImage</a></h2>
 588 <div class="doc-section">
 589
 590 <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>
 591
 592 <p>The format of the MagickPaintFloodfillImage method is:</p>
 593
 594 <pre class="code">
 595   MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
 596     const ChannelType channel,const PixelWand *fill,const double fuzz,
 597     const PixelWand *bordercolor,const long x,const long y)
 598 </pre>
 599
 600 <p>A description of each parameter follows:</p></ol>
 601
 602 <h5>wand</h5>
 603 <ol><p>the magick wand.</p></ol>
 604
 605 <h5>channel</h5>
 606 <ol><p>the channel(s).</p></ol>
 607
 608 <h5>fill</h5>
 609 <ol><p>the floodfill color pixel wand.</p></ol>
 610
 611 <h5>fuzz</h5>
 612 <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>
 613
 614 <h5>bordercolor</h5>
 615 <ol><p>the border color pixel wand.</p></ol>
 616
 617 <h5>x,y</h5>
 618 <ol><p>the starting location of the operation.</p></ol>
 619
 620  </div>
 621 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 622 _8c.html" target="source" name="MagickPaintOpaqueImage">MagickPaintOpaqueImage</a></h2>
 623 <div class="doc-section">
 624
 625 <p>MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 626
 627 <p>The format of the MagickPaintOpaqueImage method is:</p>
 628
 629 <pre class="code">
 630   MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
 631     const PixelWand *target,const PixelWand *fill,const double fuzz)
 632   MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
 633     const ChannelType channel,const PixelWand *target,
 634     const PixelWand *fill,const double fuzz)
 635 </pre>
 636
 637 <p>A description of each parameter follows:</p></ol>
 638
 639 <h5>wand</h5>
 640 <ol><p>the magick wand.</p></ol>
 641
 642 <h5>channel</h5>
 643 <ol><p>the channel(s).</p></ol>
 644
 645 <h5>target</h5>
 646 <ol><p>Change this target color to the fill color within the image.</p></ol>
 647
 648 <h5>fill</h5>
 649 <ol><p>the fill pixel wand.</p></ol>
 650
 651 <h5>fuzz</h5>
 652 <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>
 653
 654  </div>
 655 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 656 _8c.html" target="source" name="MagickPaintTransparentImage">MagickPaintTransparentImage</a></h2>
 657 <div class="doc-section">
 658
 659 <p>MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 660
 661 <p>The format of the MagickPaintTransparentImage method is:</p>
 662
 663 <pre class="code">
 664   MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
 665     const PixelWand *target,const double alpha,const double fuzz)
 666 </pre>
 667
 668 <p>A description of each parameter follows:</p></ol>
 669
 670 <h5>wand</h5>
 671 <ol><p>the magick wand.</p></ol>
 672
 673 <h5>target</h5>
 674 <ol><p>Change this target color to specified opacity value within the image.</p></ol>
 675
 676 <h5>alpha</h5>
 677 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
 678
 679 <h5>fuzz</h5>
 680 <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>
 681
 682  </div>
 683 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 684 _8c.html" target="source" name="MagickSetImageAttribute">MagickSetImageAttribute</a></h2>
 685 <div class="doc-section">
 686
 687 <p>MagickSetImageAttribute() associates a property with an image.</p></ol>
 688
 689 <p>The format of the MagickSetImageAttribute method is:</p>
 690
 691 <pre class="code">
 692   MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
 693     const char *property,const char *value)
 694 </pre>
 695
 696 <p>A description of each parameter follows:</p></ol>
 697
 698 <h5>wand</h5>
 699 <ol><p>the magick wand.</p></ol>
 700
 701 <h5>property</h5>
 702 <ol><p>the property.</p></ol>
 703
 704 <h5>value</h5>
 705 <ol><p>the value.</p></ol>
 706
 707  </div>
 708 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 709 _8c.html" target="source" name="MagickSetImageIndex">MagickSetImageIndex</a></h2>
 710 <div class="doc-section">
 711
 712 <p>MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.</p></ol>
 713
 714 <p>The format of the MagickSetImageIndex method is:</p>
 715
 716 <pre class="code">
 717   MagickBooleanType MagickSetImageIndex(MagickWand *wand,const long index)
 718 </pre>
 719
 720 <p>A description of each parameter follows:</p></ol>
 721
 722 <h5>wand</h5>
 723 <ol><p>the magick wand.</p></ol>
 724
 725 <h5>index</h5>
 726 <ol><p>the scene number.</p></ol>
 727
 728  </div>
 729 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 730 _8c.html" target="source" name="MagickTransparentImage">MagickTransparentImage</a></h2>
 731 <div class="doc-section">
 732
 733 <p>MagickTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 734
 735 <p>The format of the MagickTransparentImage method is:</p>
 736
 737 <pre class="code">
 738   MagickBooleanType MagickTransparentImage(MagickWand *wand,
 739     const PixelWand *target,const double alpha,const double fuzz)
 740 </pre>
 741
 742 <p>A description of each parameter follows:</p></ol>
 743
 744 <h5>wand</h5>
 745 <ol><p>the magick wand.</p></ol>
 746
 747 <h5>target</h5>
 748 <ol><p>Change this target color to specified opacity value within the image.</p></ol>
 749
 750 <h5>alpha</h5>
 751 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
 752
 753 <h5>fuzz</h5>
 754 <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>
 755
 756  </div>
 757 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 758 _8c.html" target="source" name="MagickRegionOfInterestImage">MagickRegionOfInterestImage</a></h2>
 759 <div class="doc-section">
 760
 761 <p>MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.</p></ol>
 762
 763 <p>The format of the MagickRegionOfInterestImage method is:</p>
 764
 765 <pre class="code">
 766   MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
 767     const unsigned long width,const unsigned long height,const long x,
 768     const long y)
 769 </pre>
 770
 771 <p>A description of each parameter follows:</p></ol>
 772
 773 <h5>wand</h5>
 774 <ol><p>the magick wand.</p></ol>
 775
 776 <h5>width</h5>
 777 <ol><p>the region width.</p></ol>
 778
 779 <h5>height</h5>
 780 <ol><p>the region height.</p></ol>
 781
 782 <h5>x</h5>
 783 <ol><p>the region x offset.</p></ol>
 784
 785 <h5>y</h5>
 786 <ol><p>the region y offset.</p></ol>
 787
 788  </div>
 789 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 790 _8c.html" target="source" name="MagickSetImagePixels">MagickSetImagePixels</a></h2>
 791 <div class="doc-section">
 792
 793 <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>
 794
 795 <p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
 796
 797 <pre class="text">
 798   MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
 799 </pre>
 800
 801 <p>The format of the MagickSetImagePixels method is:</p>
 802
 803 <pre class="code">
 804   MagickBooleanType MagickSetImagePixels(MagickWand *wand,
 805     const long x,const long y,const unsigned long columns,
 806     const unsigned long rows,const char *map,const StorageType storage,
 807     const void *pixels)
 808 </pre>
 809
 810 <p>A description of each parameter follows:</p></ol>
 811
 812 <h5>wand</h5>
 813 <ol><p>the magick wand.</p></ol>
 814
 815 <h5>x, y, columns, rows</h5>
 816 <ol><p>These values define the perimeter of a region of pixels you want to define.</p></ol>
 817
 818 <h5>map</h5>
 819 <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>
 820
 821 <h5>storage</h5>
 822 <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>
 823
 824 <h5>pixels</h5>
 825 <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>
 826
 827  </div>
 828 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 829 _8c.html" target="source" name="MagickWriteImageBlob">MagickWriteImageBlob</a></h2>
 830 <div class="doc-section">
 831
 832 <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>
 833
 834 <p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p></ol>
 835
 836 <p>The format of the MagickWriteImageBlob method is:</p>
 837
 838 <pre class="code">
 839   unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
 840 </pre>
 841
 842 <p>A description of each parameter follows:</p></ol>
 843
 844 <h5>wand</h5>
 845 <ol><p>the magick wand.</p></ol>
 846
 847 <h5>length</h5>
 848 <ol><p>the length of the blob.</p></ol>
 849
 850  </div>
 851 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 852 _8c.html" target="source" name="PixelGetNextRow">PixelGetNextRow</a></h2>
 853 <div class="doc-section">
 854
 855 <p>PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
 856
 857 <p>The format of the PixelGetNextRow method is:</p>
 858
 859 <pre class="code">
 860   PixelWand **PixelGetNextRow(PixelIterator *iterator,
 861     unsigned long *number_wands)
 862 </pre>
 863
 864 <p>A description of each parameter follows:</p></ol>
 865
 866 <h5>iterator</h5>
 867 <ol><p>the pixel iterator.</p></ol>
 868
 869 <h5>number_wands</h5>
 870 <ol><p>the number of pixel wands.</p></ol>
 871
 872  </div>
 873 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 874 _8c.html" target="source" name="PixelIteratorGetException">PixelIteratorGetException</a></h2>
 875 <div class="doc-section">
 876
 877 <p>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
 878
 879 <p>The format of the PixelIteratorGetException method is:</p>
 880
 881 <pre class="code">
 882   char *PixelIteratorGetException(const Pixeliterator *iterator,
 883     ExceptionType *severity)
 884 </pre>
 885
 886 <p>A description of each parameter follows:</p></ol>
 887
 888 <h5>iterator</h5>
 889 <ol><p>the pixel iterator.</p></ol>
 890
 891 <h5>severity</h5>
 892 <ol><p>the severity of the error is returned here.</p></ol>
 893
 894  </div>
 895 \r
 896 </div>\r
 897 \r
 898 <div id="linkbar">\r
 899  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 900     <span id="linkbar-center">\r
 901       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 902       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 903     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 904     </span>\r
 905     <span id="linkbar-east">&nbsp;</span>\r
 906   </div>\r
 907   <div class="footer">\r
 908     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 909     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 910   </div>\r
 911   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 912 </body>\r
 913 </html>\r