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