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.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
 134 </div>
 135 <div  class="sponsor">
 136   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 137 </div>
 138 <div  class="sponsor">
 139   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 143 </div>
 144 <div  class="sponsor">
 145    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 146 </div>
 147 <div  class="sponsor">
 148   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 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="#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>
 159
 160 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 161 _8c.html" target="source" name="MagickClipPathImage">MagickClipPathImage</a></h2>
 162 <div class="doc-section">
 163
 164 <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>
 165
 166 <p>The format of the MagickClipPathImage method is:</p>
 167
 168 <pre class="code">
 169   MagickBooleanType MagickClipPathImage(MagickWand *wand,
 170     const char *pathname,const MagickBooleanType inside)
 171 </pre>
 172
 173 <p>A description of each parameter follows:</p></ol>
 174
 175 <h5>wand</h5>
 176 <ol><p>the magick wand.</p></ol>
 177
 178 <h5>pathname</h5>
 179 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
 180
 181 <h5>inside</h5>
 182 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
 183
 184  </div>
 185 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 186 _8c.html" target="source" name="DrawGetFillAlpha">DrawGetFillAlpha</a></h2>
 187 <div class="doc-section">
 188
 189 <p>DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture.  Fully opaque is 1.0.</p></ol>
 190
 191 <p>The format of the DrawGetFillAlpha method is:</p>
 192
 193 <pre class="code">
 194   double DrawGetFillAlpha(const DrawingWand *wand)
 195 </pre>
 196
 197 <p>A description of each parameter follows:</p></ol>
 198
 199 <h5>wand</h5>
 200 <ol><p>the drawing wand.</p></ol>
 201
 202  </div>
 203 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 204 _8c.html" target="source" name="DrawGetStrokeAlpha">DrawGetStrokeAlpha</a></h2>
 205 <div class="doc-section">
 206
 207 <p>DrawGetStrokeAlpha() returns the alpha of stroked object outlines.</p></ol>
 208
 209 <p>The format of the DrawGetStrokeAlpha method is:</p>
 210
 211 <pre class="code">
 212   double DrawGetStrokeAlpha(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>
 219  </div>
 220 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 221 _8c.html" target="source" name="DrawPeekGraphicWand">DrawPeekGraphicWand</a></h2>
 222 <div class="doc-section">
 223
 224 <p>DrawPeekGraphicWand() returns the current drawing wand.</p></ol>
 225
 226 <p>The format of the PeekDrawingWand method is:</p>
 227
 228 <pre class="code">
 229   DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
 230 </pre>
 231
 232 <p>A description of each parameter follows:</p></ol>
 233
 234 <h5>wand</h5>
 235 <ol><p>the drawing wand.</p></ol>
 236
 237  </div>
 238 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 239 _8c.html" target="source" name="DrawPopGraphicContext">DrawPopGraphicContext</a></h2>
 240 <div class="doc-section">
 241
 242 <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>
 243
 244 <p>The format of the DrawPopGraphicContext method is:</p>
 245
 246 <pre class="code">
 247   MagickBooleanType DrawPopGraphicContext(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="DrawPushGraphicContext">DrawPushGraphicContext</a></h2>
 258 <div class="doc-section">
 259
 260 <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>
 261
 262 <p>The format of the DrawPushGraphicContext method is:</p>
 263
 264 <pre class="code">
 265   MagickBooleanType DrawPushGraphicContext(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="DrawSetFillAlpha">DrawSetFillAlpha</a></h2>
 276 <div class="doc-section">
 277
 278 <p>DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture.  Fully opaque is 1.0.</p></ol>
 279
 280 <p>The format of the DrawSetFillAlpha method is:</p>
 281
 282 <pre class="code">
 283   void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
 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 <h5>fill_alpha</h5>
 292 <ol><p>fill alpha</p></ol>
 293
 294  </div>
 295 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 296 _8c.html" target="source" name="DrawSetStrokeAlpha">DrawSetStrokeAlpha</a></h2>
 297 <div class="doc-section">
 298
 299 <p>DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.</p></ol>
 300
 301 <p>The format of the DrawSetStrokeAlpha method is:</p>
 302
 303 <pre class="code">
 304   void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
 305 </pre>
 306
 307 <p>A description of each parameter follows:</p></ol>
 308
 309 <h5>wand</h5>
 310 <ol><p>the drawing wand.</p></ol>
 311
 312 <h5>stroke_alpha</h5>
 313 <ol><p>stroke alpha.  The value 1.0 is opaque.</p></ol>
 314
 315  </div>
 316 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 317 _8c.html" target="source" name="MagickColorFloodfillImage">MagickColorFloodfillImage</a></h2>
 318 <div class="doc-section">
 319
 320 <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>
 321
 322 <p>The format of the MagickColorFloodfillImage method is:</p>
 323
 324 <pre class="code">
 325   MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
 326     const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
 327     const long x,const long y)
 328 </pre>
 329
 330 <p>A description of each parameter follows:</p></ol>
 331
 332 <h5>wand</h5>
 333 <ol><p>the magick wand.</p></ol>
 334
 335 <h5>fill</h5>
 336 <ol><p>the floodfill color pixel wand.</p></ol>
 337
 338 <h5>fuzz</h5>
 339 <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>
 340
 341 <h5>bordercolor</h5>
 342 <ol><p>the border color pixel wand.</p></ol>
 343
 344 <h5>x,y</h5>
 345 <ol><p>the starting location of the operation.</p></ol>
 346
 347  </div>
 348 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 349 _8c.html" target="source" name="MagickDescribeImage">MagickDescribeImage</a></h2>
 350 <div class="doc-section">
 351
 352 <p>MagickDescribeImage() identifies an image by printing its attributes to the file.  Attributes include the image width, height, size, and others.</p></ol>
 353
 354 <p>The format of the MagickDescribeImage method is:</p>
 355
 356 <pre class="code">
 357   const char *MagickDescribeImage(MagickWand *wand)
 358 </pre>
 359
 360 <p>A description of each parameter follows:</p></ol>
 361
 362 <h5>wand</h5>
 363 <ol><p>the magick wand.</p></ol>
 364
 365  </div>
 366 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 367 _8c.html" target="source" name="MagickFlattenImages">MagickFlattenImages</a></h2>
 368 <div class="doc-section">
 369
 370 <p>MagickFlattenImages() merges a sequence of images.  This useful for combining Photoshop layers into a single image.</p></ol>
 371
 372 <p>The format of the MagickFlattenImages method is:</p>
 373
 374 <pre class="code">
 375   MagickWand *MagickFlattenImages(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="MagickGetImageAttribute">MagickGetImageAttribute</a></h2>
 386 <div class="doc-section">
 387
 388 <p>MagickGetImageAttribute() returns a value associated with the specified property.  Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
 389
 390 <p>The format of the MagickGetImageAttribute method is:</p>
 391
 392 <pre class="code">
 393   char *MagickGetImageAttribute(MagickWand *wand,const char *property)
 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 <h5>property</h5>
 402 <ol><p>the property.</p></ol>
 403
 404  </div>
 405 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 406 _8c.html" target="source" name="MagickGetImageMatte">MagickGetImageMatte</a></h2>
 407 <div class="doc-section">
 408
 409 <p>MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.</p></ol>
 410
 411 <p>The format of the MagickGetImageMatte method is:</p>
 412
 413 <pre class="code">
 414   unsigned long MagickGetImageMatte(MagickWand *wand)
 415 </pre>
 416
 417 <p>A description of each parameter follows:</p></ol>
 418
 419 <h5>wand</h5>
 420 <ol><p>the magick wand.</p></ol>
 421
 422  </div>
 423 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 424 _8c.html" target="source" name="MagickGetImagePixels">MagickGetImagePixels</a></h2>
 425 <div class="doc-section">
 426
 427 <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>
 428
 429 <p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
 430
 431 <pre class="text">
 432   MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
 433 </pre>
 434
 435 <p>The format of the MagickGetImagePixels method is:</p>
 436
 437 <pre class="code">
 438   MagickBooleanType MagickGetImagePixels(MagickWand *wand,
 439     const long x,const long y,const unsigned long columns,
 440     const unsigned long rows,const char *map,const StorageType storage,
 441     void *pixels)
 442 </pre>
 443
 444 <p>A description of each parameter follows:</p></ol>
 445
 446 <h5>wand</h5>
 447 <ol><p>the magick wand.</p></ol>
 448
 449 <h5>x, y, columns, rows</h5>
 450 <ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
 451
 452 <h5>map</h5>
 453 <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>
 454
 455 <h5>storage</h5>
 456 <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>
 457
 458 <h5>pixels</h5>
 459 <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>
 460
 461  </div>
 462 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 463 _8c.html" target="source" name="MagickGetImageSize">MagickGetImageSize</a></h2>
 464 <div class="doc-section">
 465
 466 <p>MagickGetImageSize() returns the image length in bytes.</p></ol>
 467
 468 <p>The format of the MagickGetImageSize method is:</p>
 469
 470 <pre class="code">
 471   MagickBooleanType MagickGetImageSize(MagickWand *wand,
 472     MagickSizeType *length)
 473 </pre>
 474
 475 <p>A description of each parameter follows:</p></ol>
 476
 477 <h5>wand</h5>
 478 <ol><p>the magick wand.</p></ol>
 479
 480 <h5>length</h5>
 481 <ol><p>the image length in bytes.</p></ol>
 482
 483  </div>
 484 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 485 _8c.html" target="source" name="MagickMapImage">MagickMapImage</a></h2>
 486 <div class="doc-section">
 487
 488 <p>MagickMapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
 489
 490 <p>The format of the MagickMapImage method is:</p>
 491
 492 <pre class="code">
 493   MagickBooleanType MagickMapImage(MagickWand *wand,
 494     const MagickWand *map_wand,const MagickBooleanType dither)
 495 </pre>
 496
 497 <p>A description of each parameter follows:</p></ol>
 498
 499 <h5>wand</h5>
 500 <ol><p>the magick wand.</p></ol>
 501
 502 <h5>map</h5>
 503 <ol><p>the map wand.</p></ol>
 504
 505 <h5>dither</h5>
 506 <ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
 507
 508  </div>
 509 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 510 _8c.html" target="source" name="MagickMatteFloodfillImage">MagickMatteFloodfillImage</a></h2>
 511 <div class="doc-section">
 512
 513 <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>
 514
 515 <p>The format of the MagickMatteFloodfillImage method is:</p>
 516
 517 <pre class="code">
 518   MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
 519     const double alpha,const double fuzz,const PixelWand *bordercolor,
 520     const long x,const long y)
 521 </pre>
 522
 523 <p>A description of each parameter follows:</p></ol>
 524
 525 <h5>wand</h5>
 526 <ol><p>the magick wand.</p></ol>
 527
 528 <h5>alpha</h5>
 529 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
 530
 531 <h5>fuzz</h5>
 532 <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>
 533
 534 <h5>bordercolor</h5>
 535 <ol><p>the border color pixel wand.</p></ol>
 536
 537 <h5>x,y</h5>
 538 <ol><p>the starting location of the operation.</p></ol>
 539
 540  </div>
 541 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 542 _8c.html" target="source" name="MagickMosaicImages">MagickMosaicImages</a></h2>
 543 <div class="doc-section">
 544
 545 <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>
 546
 547 <p>The format of the MagickMosaicImages method is:</p>
 548
 549 <pre class="code">
 550   MagickWand *MagickMosaicImages(MagickWand *wand)
 551 </pre>
 552
 553 <p>A description of each parameter follows:</p></ol>
 554
 555 <h5>wand</h5>
 556 <ol><p>the magick wand.</p></ol>
 557
 558  </div>
 559 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 560 _8c.html" target="source" name="MagickOpaqueImage">MagickOpaqueImage</a></h2>
 561 <div class="doc-section">
 562
 563 <p>MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 564
 565 <p>The format of the MagickOpaqueImage method is:</p>
 566
 567 <pre class="code">
 568   MagickBooleanType MagickOpaqueImage(MagickWand *wand,
 569     const PixelWand *target,const PixelWand *fill,const double fuzz)
 570 </pre>
 571
 572 <p>A description of each parameter follows:</p></ol>
 573
 574 <h5>wand</h5>
 575 <ol><p>the magick wand.</p></ol>
 576
 577 <h5>channel</h5>
 578 <ol><p>the channel(s).</p></ol>
 579
 580 <h5>target</h5>
 581 <ol><p>Change this target color to the fill color within the image.</p></ol>
 582
 583 <h5>fill</h5>
 584 <ol><p>the fill pixel wand.</p></ol>
 585
 586 <h5>fuzz</h5>
 587 <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>
 588
 589  </div>
 590 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 591 _8c.html" target="source" name="MagickPaintFloodfillImage">MagickPaintFloodfillImage</a></h2>
 592 <div class="doc-section">
 593
 594 <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>
 595
 596 <p>The format of the MagickPaintFloodfillImage method is:</p>
 597
 598 <pre class="code">
 599   MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
 600     const ChannelType channel,const PixelWand *fill,const double fuzz,
 601     const PixelWand *bordercolor,const long x,const long y)
 602 </pre>
 603
 604 <p>A description of each parameter follows:</p></ol>
 605
 606 <h5>wand</h5>
 607 <ol><p>the magick wand.</p></ol>
 608
 609 <h5>channel</h5>
 610 <ol><p>the channel(s).</p></ol>
 611
 612 <h5>fill</h5>
 613 <ol><p>the floodfill color pixel wand.</p></ol>
 614
 615 <h5>fuzz</h5>
 616 <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>
 617
 618 <h5>bordercolor</h5>
 619 <ol><p>the border color pixel wand.</p></ol>
 620
 621 <h5>x,y</h5>
 622 <ol><p>the starting location of the operation.</p></ol>
 623
 624  </div>
 625 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 626 _8c.html" target="source" name="MagickPaintOpaqueImage">MagickPaintOpaqueImage</a></h2>
 627 <div class="doc-section">
 628
 629 <p>MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 630
 631 <p>The format of the MagickPaintOpaqueImage method is:</p>
 632
 633 <pre class="code">
 634   MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
 635     const PixelWand *target,const PixelWand *fill,const double fuzz)
 636   MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
 637     const ChannelType channel,const PixelWand *target,
 638     const PixelWand *fill,const double fuzz)
 639 </pre>
 640
 641 <p>A description of each parameter follows:</p></ol>
 642
 643 <h5>wand</h5>
 644 <ol><p>the magick wand.</p></ol>
 645
 646 <h5>channel</h5>
 647 <ol><p>the channel(s).</p></ol>
 648
 649 <h5>target</h5>
 650 <ol><p>Change this target color to the fill color within the image.</p></ol>
 651
 652 <h5>fill</h5>
 653 <ol><p>the fill pixel wand.</p></ol>
 654
 655 <h5>fuzz</h5>
 656 <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>
 657
 658  </div>
 659 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 660 _8c.html" target="source" name="MagickPaintTransparentImage">MagickPaintTransparentImage</a></h2>
 661 <div class="doc-section">
 662
 663 <p>MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 664
 665 <p>The format of the MagickPaintTransparentImage method is:</p>
 666
 667 <pre class="code">
 668   MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
 669     const PixelWand *target,const double alpha,const double fuzz)
 670 </pre>
 671
 672 <p>A description of each parameter follows:</p></ol>
 673
 674 <h5>wand</h5>
 675 <ol><p>the magick wand.</p></ol>
 676
 677 <h5>target</h5>
 678 <ol><p>Change this target color to specified opacity value within the image.</p></ol>
 679
 680 <h5>alpha</h5>
 681 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
 682
 683 <h5>fuzz</h5>
 684 <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>
 685
 686  </div>
 687 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 688 _8c.html" target="source" name="MagickSetImageAttribute">MagickSetImageAttribute</a></h2>
 689 <div class="doc-section">
 690
 691 <p>MagickSetImageAttribute() associates a property with an image.</p></ol>
 692
 693 <p>The format of the MagickSetImageAttribute method is:</p>
 694
 695 <pre class="code">
 696   MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
 697     const char *property,const char *value)
 698 </pre>
 699
 700 <p>A description of each parameter follows:</p></ol>
 701
 702 <h5>wand</h5>
 703 <ol><p>the magick wand.</p></ol>
 704
 705 <h5>property</h5>
 706 <ol><p>the property.</p></ol>
 707
 708 <h5>value</h5>
 709 <ol><p>the value.</p></ol>
 710
 711  </div>
 712 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 713 _8c.html" target="source" name="MagickSetImageIndex">MagickSetImageIndex</a></h2>
 714 <div class="doc-section">
 715
 716 <p>MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.</p></ol>
 717
 718 <p>The format of the MagickSetImageIndex method is:</p>
 719
 720 <pre class="code">
 721   MagickBooleanType MagickSetImageIndex(MagickWand *wand,const long index)
 722 </pre>
 723
 724 <p>A description of each parameter follows:</p></ol>
 725
 726 <h5>wand</h5>
 727 <ol><p>the magick wand.</p></ol>
 728
 729 <h5>index</h5>
 730 <ol><p>the scene number.</p></ol>
 731
 732  </div>
 733 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 734 _8c.html" target="source" name="MagickTransparentImage">MagickTransparentImage</a></h2>
 735 <div class="doc-section">
 736
 737 <p>MagickTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 738
 739 <p>The format of the MagickTransparentImage method is:</p>
 740
 741 <pre class="code">
 742   MagickBooleanType MagickTransparentImage(MagickWand *wand,
 743     const PixelWand *target,const double alpha,const double fuzz)
 744 </pre>
 745
 746 <p>A description of each parameter follows:</p></ol>
 747
 748 <h5>wand</h5>
 749 <ol><p>the magick wand.</p></ol>
 750
 751 <h5>target</h5>
 752 <ol><p>Change this target color to specified opacity value within the image.</p></ol>
 753
 754 <h5>alpha</h5>
 755 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
 756
 757 <h5>fuzz</h5>
 758 <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>
 759
 760  </div>
 761 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 762 _8c.html" target="source" name="MagickRegionOfInterestImage">MagickRegionOfInterestImage</a></h2>
 763 <div class="doc-section">
 764
 765 <p>MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.</p></ol>
 766
 767 <p>The format of the MagickRegionOfInterestImage method is:</p>
 768
 769 <pre class="code">
 770   MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
 771     const unsigned long width,const unsigned long height,const long x,
 772     const long y)
 773 </pre>
 774
 775 <p>A description of each parameter follows:</p></ol>
 776
 777 <h5>wand</h5>
 778 <ol><p>the magick wand.</p></ol>
 779
 780 <h5>width</h5>
 781 <ol><p>the region width.</p></ol>
 782
 783 <h5>height</h5>
 784 <ol><p>the region height.</p></ol>
 785
 786 <h5>x</h5>
 787 <ol><p>the region x offset.</p></ol>
 788
 789 <h5>y</h5>
 790 <ol><p>the region y offset.</p></ol>
 791
 792  </div>
 793 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 794 _8c.html" target="source" name="MagickSetImagePixels">MagickSetImagePixels</a></h2>
 795 <div class="doc-section">
 796
 797 <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>
 798
 799 <p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
 800
 801 <pre class="text">
 802   MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
 803 </pre>
 804
 805 <p>The format of the MagickSetImagePixels method is:</p>
 806
 807 <pre class="code">
 808   MagickBooleanType MagickSetImagePixels(MagickWand *wand,
 809     const long x,const long y,const unsigned long columns,
 810     const unsigned long rows,const char *map,const StorageType storage,
 811     const void *pixels)
 812 </pre>
 813
 814 <p>A description of each parameter follows:</p></ol>
 815
 816 <h5>wand</h5>
 817 <ol><p>the magick wand.</p></ol>
 818
 819 <h5>x, y, columns, rows</h5>
 820 <ol><p>These values define the perimeter of a region of pixels you want to define.</p></ol>
 821
 822 <h5>map</h5>
 823 <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>
 824
 825 <h5>storage</h5>
 826 <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>
 827
 828 <h5>pixels</h5>
 829 <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>
 830
 831  </div>
 832 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 833 _8c.html" target="source" name="MagickWriteImageBlob">MagickWriteImageBlob</a></h2>
 834 <div class="doc-section">
 835
 836 <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>
 837
 838 <p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p></ol>
 839
 840 <p>The format of the MagickWriteImageBlob method is:</p>
 841
 842 <pre class="code">
 843   unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
 844 </pre>
 845
 846 <p>A description of each parameter follows:</p></ol>
 847
 848 <h5>wand</h5>
 849 <ol><p>the magick wand.</p></ol>
 850
 851 <h5>length</h5>
 852 <ol><p>the length of the blob.</p></ol>
 853
 854  </div>
 855 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 856 _8c.html" target="source" name="PixelGetNextRow">PixelGetNextRow</a></h2>
 857 <div class="doc-section">
 858
 859 <p>PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
 860
 861 <p>The format of the PixelGetNextRow method is:</p>
 862
 863 <pre class="code">
 864   PixelWand **PixelGetNextRow(PixelIterator *iterator,
 865     unsigned long *number_wands)
 866 </pre>
 867
 868 <p>A description of each parameter follows:</p></ol>
 869
 870 <h5>iterator</h5>
 871 <ol><p>the pixel iterator.</p></ol>
 872
 873 <h5>number_wands</h5>
 874 <ol><p>the number of pixel wands.</p></ol>
 875
 876  </div>
 877 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 878 _8c.html" target="source" name="PixelIteratorGetException">PixelIteratorGetException</a></h2>
 879 <div class="doc-section">
 880
 881 <p>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
 882
 883 <p>The format of the PixelIteratorGetException method is:</p>
 884
 885 <pre class="code">
 886   char *PixelIteratorGetException(const Pixeliterator *iterator,
 887     ExceptionType *severity)
 888 </pre>
 889
 890 <p>A description of each parameter follows:</p></ol>
 891
 892 <h5>iterator</h5>
 893 <ol><p>the pixel iterator.</p></ol>
 894
 895 <h5>severity</h5>
 896 <ol><p>the severity of the error is returned here.</p></ol>
 897
 898  </div>
 899 \r
 900 </div>\r
 901 \r
 902 <div id="linkbar">\r
 903  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 904     <span id="linkbar-center">\r
 905       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 906       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 907     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 908     </span>\r
 909     <span id="linkbar-east">&nbsp;</span>\r
 910   </div>\r
 911   <div class="footer">\r
 912     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 913     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 914   </div>\r
 915   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 916 </body>\r
 917 </html>\r