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" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
   7   <title>ImageMagick: MagickWand, C API for ImageMagick: Deprecated Methods</title/>
   8   <meta http-equiv="Content-Language" content="en-US"/>
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  10   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  11   <meta name="Application-name" content="ImageMagick"/>
  12   <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."/>
  13   <meta name="Application-url" content="http://www.imagemagick.org"/>
  14   <meta name="Generator" content="PHP"/>
  15   <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"/>
  16   <meta name="Rating" content="GENERAL"/>
  17   <meta name="Robots" content="INDEX, FOLLOW"/>
  18   <meta name="Generator" content="ImageMagick Studio LLC"/>
  19   <meta name="Author" content="ImageMagick Studio LLC"/>
  20   <meta name="Revisit-after" content="2 DAYS"/>
  21   <meta name="Resource-type" content="document"/>
  22   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../../images/wand.png"  sizes="32x32"/>
  25   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  26   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  27   <style type="text/css" media="all">\r
  28     @import url("../../www/magick.css");\r
  29   </style>\r
  30 </head>\r
  31 \r
  32 <body id="www-imagemagick-org">\r
  33 <div class="titlebar">\r
  34 <a href="../../index.html">\r
  35   <img src="../../images/script.png" alt="[ImageMagick]"\r
  36   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  37 <a href="http://www.networkredux.com">\r
  38   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  39   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  40 <a href="http://www.imagemagick.org/discourse-server/">\r
  41   <img src="../../images/logo.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 <a href="../../index.html">\r
  44   <img src="../../images/sprite.jpg" alt=""\r
  45   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  46 </div>\r
  47 \r
  48 <div class="westbar">\r
  49 \r
  50 <div class="menu">
  51   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  52 </div>
  53 <div class="sep"></div>\r
  54 <div class="menu">
  55   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  62 </div>
  63 <div class="sub">
  64     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  65 </div>
  66 <div class="sep"></div>\r
  67 <div class="menu">
  68   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  78 </div>
  79 <div class="menu">
  80   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  90 </div>
  91 <div class="sub">
  92     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  93 </div>
  94 <div class="sep"></div>\r
  95 <div  class="menu">
  96    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 103  </div>
 104 <div class="menu">
 105   <a title="Resources" href="../../www/resources.html">Resources</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 109 </div>
 110 <div class="menu">
 111   <a title="Download" href="../../www/download.html">Download</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div class="menu">
 119   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 120 </div>
 121 <div  class="sub">
 122     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 127
 128 <div class="sponsbox">
 129 <div  class="sponsor">
 130   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 146 </div>
 147 <div  class="sponsor">
 148    <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 149 </div>
 150 </div>
 151 </div>
 152 </div>\r
 153 \r
 154 <div class="eastbar">\r
 155   <script type="text/javascript">\r
 156   <!--\r
 157     google_ad_client = "pub-3129977114552745";\r
 158     google_ad_slot = "0574824969";\r
 159     google_ad_width = 160;\r
 160     google_ad_height = 600;\r
 161   //-->\r
 162   </script>\r
 163   <script type="text/javascript"\r
 164     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 165   </script>\r
 166 </div>\r
 167 \r
 168 <div class="main">\r
 169 \r
 170 <p class="navigation-index">[<a href="#MagickAverageImages">MagickAverageImages</a> &bull; <a href="#ClonePixelView">ClonePixelView</a> &bull; <a href="#DestroyPixelView">DestroyPixelView</a> &bull; <a href="#DuplexTransferPixelViewIterator">DuplexTransferPixelViewIterator</a> &bull; <a href="#GetPixelViewException">GetPixelViewException</a> &bull; <a href="#GetPixelViewHeight">GetPixelViewHeight</a> &bull; <a href="#GetPixelViewIterator">GetPixelViewIterator</a> &bull; <a href="#GetPixelViewPixels">GetPixelViewPixels</a> &bull; <a href="#GetPixelViewWand">GetPixelViewWand</a> &bull; <a href="#GetPixelViewWidth">GetPixelViewWidth</a> &bull; <a href="#GetPixelViewX">GetPixelViewX</a> &bull; <a href="#GetPixelViewY">GetPixelViewY</a> &bull; <a href="#IsPixelView">IsPixelView</a> &bull; <a href="#MagickClipPathImage">MagickClipPathImage</a> &bull; <a href="#DrawGetFillAlpha">DrawGetFillAlpha</a> &bull; <a href="#DrawGetStrokeAlpha">DrawGetStrokeAlpha</a> &bull; <a href="#DrawPeekGraphicWand">DrawPeekGraphicWand</a> &bull; <a href="#DrawPopGraphicContext">DrawPopGraphicContext</a> &bull; <a href="#DrawPushGraphicContext">DrawPushGraphicContext</a> &bull; <a href="#DrawSetFillAlpha">DrawSetFillAlpha</a> &bull; <a href="#DrawSetStrokeAlpha">DrawSetStrokeAlpha</a> &bull; <a href="#MagickColorFloodfillImage">MagickColorFloodfillImage</a> &bull; <a href="#MagickDescribeImage">MagickDescribeImage</a> &bull; <a href="#MagickFlattenImages">MagickFlattenImages</a> &bull; <a href="#MagickGetImageAttribute">MagickGetImageAttribute</a> &bull; <a href="#MagickGetImageMatte">MagickGetImageMatte</a> &bull; <a href="#MagickGetImagePixels">MagickGetImagePixels</a> &bull; <a href="#MagickGetImageSize">MagickGetImageSize</a> &bull; <a href="#MagickMapImage">MagickMapImage</a> &bull; <a href="#MagickMatteFloodfillImage">MagickMatteFloodfillImage</a> &bull; <a href="#MagickMaximumImages">MagickMaximumImages</a> &bull; <a href="#MagickMinimumImages">MagickMinimumImages</a> &bull; <a href="#MagickMosaicImages">MagickMosaicImages</a> &bull; <a href="#MagickOpaqueImage">MagickOpaqueImage</a> &bull; <a href="#MagickPaintFloodfillImage">MagickPaintFloodfillImage</a> &bull; <a href="#MagickPaintOpaqueImage">MagickPaintOpaqueImage</a> &bull; <a href="#MagickPaintTransparentImage">MagickPaintTransparentImage</a> &bull; <a href="#MagickRecolorImage">MagickRecolorImage</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="#NewPixelView">NewPixelView</a> &bull; <a href="#NewPixelViewRegion">NewPixelViewRegion</a> &bull; <a href="#PixelGetNextRow">PixelGetNextRow</a> &bull; <a href="#PixelIteratorGetException">PixelIteratorGetException</a> &bull; <a href="#SetPixelViewIterator">SetPixelViewIterator</a> &bull; <a href="#TransferPixelViewIterator">TransferPixelViewIterator</a> &bull; <a href="#UpdatePixelViewIterator">UpdatePixelViewIterator</a>]</p>
 171
 172 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 173 _8c.html" target="source" name="MagickAverageImages">MagickAverageImages</a></h2>
 174 <div class="doc-section">
 175
 176 <p>MagickAverageImages() average a set of images.</p></ol>
 177
 178 <p>The format of the MagickAverageImages method is:</p>
 179
 180 <pre class="code">
 181   MagickWand *MagickAverageImages(MagickWand *wand)
 182 </pre>
 183
 184 <p>A description of each parameter follows:</p></ol>
 185
 186 <h5>wand</h5>
 187 <ol><p>the magick wand.</p></ol>
 188
 189  </div>
 190 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 191 _8c.html" target="source" name="ClonePixelView">ClonePixelView</a></h2>
 192 <div class="doc-section">
 193
 194 <p>ClonePixelView() makes a copy of the specified pixel view.</p></ol>
 195
 196 <p>The format of the ClonePixelView method is:</p>
 197
 198 <pre class="code">
 199   PixelView *ClonePixelView(const PixelView *pixel_view)
 200 </pre>
 201
 202 <p>A description of each parameter follows:</p></ol>
 203
 204 <h5>pixel_view</h5>
 205 <ol><p>the pixel view.</p></ol>
 206
 207  </div>
 208 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 209 _8c.html" target="source" name="DestroyPixelView">DestroyPixelView</a></h2>
 210 <div class="doc-section">
 211
 212 <p>DestroyPixelView() deallocates memory associated with a pixel view.</p></ol>
 213
 214 <p>The format of the DestroyPixelView method is:</p>
 215
 216 <pre class="code">
 217   PixelView *DestroyPixelView(PixelView *pixel_view,
 218     const size_t number_wands,const size_t number_threads)
 219 </pre>
 220
 221 <p>A description of each parameter follows:</p></ol>
 222
 223 <h5>pixel_view</h5>
 224 <ol><p>the pixel view.</p></ol>
 225
 226 <h5>number_wand</h5>
 227 <ol><p>the number of pixel wands.</p></ol>
 228
 229 <h5>number_threads</h5>
 230 <ol><p>number of threads.</p></ol>
 231
 232  </div>
 233 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 234 _8c.html" target="source" name="DuplexTransferPixelViewIterator">DuplexTransferPixelViewIterator</a></h2>
 235 <div class="doc-section">
 236
 237 <p>DuplexTransferPixelViewIterator() iterates over three pixel views in parallel and calls your transfer method for each scanline of the view.  The source and duplex pixel region is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension.  However, the destination pixel view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.</p></ol>
 238
 239 <p>Use this pragma:</p>
 240
 241 <pre class="text">
 242       #pragma omp critical
 243 </pre>
 244
 245 <p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p></ol>
 246
 247 <p>The format of the DuplexTransferPixelViewIterator method is:</p>
 248
 249 <pre class="code">
 250   MagickBooleanType DuplexTransferPixelViewIterator(PixelView *source,
 251     PixelView *duplex,PixelView *destination,
 252     DuplexTransferPixelViewMethod transfer,void *context)
 253 </pre>
 254
 255 <p>A description of each parameter follows:</p></ol>
 256
 257 <h5>source</h5>
 258 <ol><p>the source pixel view.</p></ol>
 259
 260 <h5>duplex</h5>
 261 <ol><p>the duplex pixel view.</p></ol>
 262
 263 <h5>destination</h5>
 264 <ol><p>the destination pixel view.</p></ol>
 265
 266 <h5>transfer</h5>
 267 <ol><p>the transfer callback method.</p></ol>
 268
 269 <h5>context</h5>
 270 <ol><p>the user defined context.</p></ol>
 271
 272  </div>
 273 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 274 _8c.html" target="source" name="GetPixelViewException">GetPixelViewException</a></h2>
 275 <div class="doc-section">
 276
 277 <p>GetPixelViewException() returns the severity, reason, and description of any error that occurs when utilizing a pixel view.</p></ol>
 278
 279 <p>The format of the GetPixelViewException method is:</p>
 280
 281 <pre class="code">
 282   char *GetPixelViewException(const PixelWand *pixel_view,
 283     ExceptionType *severity)
 284 </pre>
 285
 286 <p>A description of each parameter follows:</p></ol>
 287
 288 <h5>pixel_view</h5>
 289 <ol><p>the pixel pixel_view.</p></ol>
 290
 291 <h5>severity</h5>
 292 <ol><p>the severity of the error is returned here.</p></ol>
 293
 294  </div>
 295 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 296 _8c.html" target="source" name="GetPixelViewHeight">GetPixelViewHeight</a></h2>
 297 <div class="doc-section">
 298
 299 <p>GetPixelViewHeight() returns the pixel view height.</p></ol>
 300
 301 <p>The format of the GetPixelViewHeight method is:</p>
 302
 303 <pre class="code">
 304   size_t GetPixelViewHeight(const PixelView *pixel_view)
 305 </pre>
 306
 307 <p>A description of each parameter follows:</p></ol>
 308
 309 <h5>pixel_view</h5>
 310 <ol><p>the pixel view.</p></ol>
 311
 312  </div>
 313 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 314 _8c.html" target="source" name="GetPixelViewIterator">GetPixelViewIterator</a></h2>
 315 <div class="doc-section">
 316
 317 <p>GetPixelViewIterator() iterates over the pixel view in parallel and calls your get method for each scanline of the view.  The pixel region is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension.  Any updates to the pixels in your callback are ignored.</p></ol>
 318
 319 <p>Use this pragma:</p>
 320
 321 <pre class="text">
 322       #pragma omp critical
 323 </pre>
 324
 325 <p>to define a section of code in your callback get method that must be executed by a single thread at a time.</p></ol>
 326
 327 <p>The format of the GetPixelViewIterator method is:</p>
 328
 329 <pre class="code">
 330   MagickBooleanType GetPixelViewIterator(PixelView *source,
 331     GetPixelViewMethod get,void *context)
 332 </pre>
 333
 334 <p>A description of each parameter follows:</p></ol>
 335
 336 <h5>source</h5>
 337 <ol><p>the source pixel view.</p></ol>
 338
 339 <h5>get</h5>
 340 <ol><p>the get callback method.</p></ol>
 341
 342 <h5>context</h5>
 343 <ol><p>the user defined context.</p></ol>
 344
 345  </div>
 346 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 347 _8c.html" target="source" name="GetPixelViewPixels">GetPixelViewPixels</a></h2>
 348 <div class="doc-section">
 349
 350 <p>GetPixelViewPixels() returns the pixel view pixel_wands.</p></ol>
 351
 352 <p>The format of the GetPixelViewPixels method is:</p>
 353
 354 <pre class="code">
 355   PixelWand *GetPixelViewPixels(const PixelView *pixel_view)
 356 </pre>
 357
 358 <p>A description of each parameter follows:</p></ol>
 359
 360 <h5>pixel_view</h5>
 361 <ol><p>the pixel view.</p></ol>
 362
 363  </div>
 364 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 365 _8c.html" target="source" name="GetPixelViewWand">GetPixelViewWand</a></h2>
 366 <div class="doc-section">
 367
 368 <p>GetPixelViewWand() returns the magick wand associated with the pixel view.</p></ol>
 369
 370 <p>The format of the GetPixelViewWand method is:</p>
 371
 372 <pre class="code">
 373   MagickWand *GetPixelViewWand(const PixelView *pixel_view)
 374 </pre>
 375
 376 <p>A description of each parameter follows:</p></ol>
 377
 378 <h5>pixel_view</h5>
 379 <ol><p>the pixel view.</p></ol>
 380
 381  </div>
 382 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 383 _8c.html" target="source" name="GetPixelViewWidth">GetPixelViewWidth</a></h2>
 384 <div class="doc-section">
 385
 386 <p>GetPixelViewWidth() returns the pixel view width.</p></ol>
 387
 388 <p>The format of the GetPixelViewWidth method is:</p>
 389
 390 <pre class="code">
 391   size_t GetPixelViewWidth(const PixelView *pixel_view)
 392 </pre>
 393
 394 <p>A description of each parameter follows:</p></ol>
 395
 396 <h5>pixel_view</h5>
 397 <ol><p>the pixel view.</p></ol>
 398
 399  </div>
 400 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 401 _8c.html" target="source" name="GetPixelViewX">GetPixelViewX</a></h2>
 402 <div class="doc-section">
 403
 404 <p>GetPixelViewX() returns the pixel view x offset.</p></ol>
 405
 406 <p>The format of the GetPixelViewX method is:</p>
 407
 408 <pre class="code">
 409   ssize_t GetPixelViewX(const PixelView *pixel_view)
 410 </pre>
 411
 412 <p>A description of each parameter follows:</p></ol>
 413
 414 <h5>pixel_view</h5>
 415 <ol><p>the pixel view.</p></ol>
 416
 417  </div>
 418 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 419 _8c.html" target="source" name="GetPixelViewY">GetPixelViewY</a></h2>
 420 <div class="doc-section">
 421
 422 <p>GetPixelViewY() returns the pixel view y offset.</p></ol>
 423
 424 <p>The format of the GetPixelViewY method is:</p>
 425
 426 <pre class="code">
 427   ssize_t GetPixelViewY(const PixelView *pixel_view)
 428 </pre>
 429
 430 <p>A description of each parameter follows:</p></ol>
 431
 432 <h5>pixel_view</h5>
 433 <ol><p>the pixel view.</p></ol>
 434
 435  </div>
 436 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 437 _8c.html" target="source" name="IsPixelView">IsPixelView</a></h2>
 438 <div class="doc-section">
 439
 440 <p>IsPixelView() returns MagickTrue if the the parameter is verified as a pixel view container.</p></ol>
 441
 442 <p>The format of the IsPixelView method is:</p>
 443
 444 <pre class="code">
 445   MagickBooleanType IsPixelView(const PixelView *pixel_view)
 446 </pre>
 447
 448 <p>A description of each parameter follows:</p></ol>
 449
 450 <h5>pixel_view</h5>
 451 <ol><p>the pixel view.</p></ol>
 452
 453  </div>
 454 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 455 _8c.html" target="source" name="MagickClipPathImage">MagickClipPathImage</a></h2>
 456 <div class="doc-section">
 457
 458 <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>
 459
 460 <p>The format of the MagickClipPathImage method is:</p>
 461
 462 <pre class="code">
 463   MagickBooleanType MagickClipPathImage(MagickWand *wand,
 464     const char *pathname,const MagickBooleanType inside)
 465 </pre>
 466
 467 <p>A description of each parameter follows:</p></ol>
 468
 469 <h5>wand</h5>
 470 <ol><p>the magick wand.</p></ol>
 471
 472 <h5>pathname</h5>
 473 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
 474
 475 <h5>inside</h5>
 476 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
 477
 478  </div>
 479 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 480 _8c.html" target="source" name="DrawGetFillAlpha">DrawGetFillAlpha</a></h2>
 481 <div class="doc-section">
 482
 483 <p>DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture.  Fully opaque is 1.0.</p></ol>
 484
 485 <p>The format of the DrawGetFillAlpha method is:</p>
 486
 487 <pre class="code">
 488   double DrawGetFillAlpha(const DrawingWand *wand)
 489 </pre>
 490
 491 <p>A description of each parameter follows:</p></ol>
 492
 493 <h5>wand</h5>
 494 <ol><p>the drawing wand.</p></ol>
 495
 496  </div>
 497 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 498 _8c.html" target="source" name="DrawGetStrokeAlpha">DrawGetStrokeAlpha</a></h2>
 499 <div class="doc-section">
 500
 501 <p>DrawGetStrokeAlpha() returns the alpha of stroked object outlines.</p></ol>
 502
 503 <p>The format of the DrawGetStrokeAlpha method is:</p>
 504
 505 <pre class="code">
 506   double DrawGetStrokeAlpha(const DrawingWand *wand)
 507 </pre>
 508
 509 <p>A description of each parameter follows:</p></ol>
 510
 511 <h5>wand</h5>
 512 <ol><p>the drawing wand. </p>
 513  </div>
 514 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 515 _8c.html" target="source" name="DrawPeekGraphicWand">DrawPeekGraphicWand</a></h2>
 516 <div class="doc-section">
 517
 518 <p>DrawPeekGraphicWand() returns the current drawing wand.</p></ol>
 519
 520 <p>The format of the PeekDrawingWand method is:</p>
 521
 522 <pre class="code">
 523   DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
 524 </pre>
 525
 526 <p>A description of each parameter follows:</p></ol>
 527
 528 <h5>wand</h5>
 529 <ol><p>the drawing wand.</p></ol>
 530
 531  </div>
 532 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 533 _8c.html" target="source" name="DrawPopGraphicContext">DrawPopGraphicContext</a></h2>
 534 <div class="doc-section">
 535
 536 <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>
 537
 538 <p>The format of the DrawPopGraphicContext method is:</p>
 539
 540 <pre class="code">
 541   MagickBooleanType DrawPopGraphicContext(DrawingWand *wand)
 542 </pre>
 543
 544 <p>A description of each parameter follows:</p></ol>
 545
 546 <h5>wand</h5>
 547 <ol><p>the drawing wand.</p></ol>
 548
 549  </div>
 550 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 551 _8c.html" target="source" name="DrawPushGraphicContext">DrawPushGraphicContext</a></h2>
 552 <div class="doc-section">
 553
 554 <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>
 555
 556 <p>The format of the DrawPushGraphicContext method is:</p>
 557
 558 <pre class="code">
 559   MagickBooleanType DrawPushGraphicContext(DrawingWand *wand)
 560 </pre>
 561
 562 <p>A description of each parameter follows:</p></ol>
 563
 564 <h5>wand</h5>
 565 <ol><p>the drawing wand.</p></ol>
 566
 567  </div>
 568 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 569 _8c.html" target="source" name="DrawSetFillAlpha">DrawSetFillAlpha</a></h2>
 570 <div class="doc-section">
 571
 572 <p>DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture.  Fully opaque is 1.0.</p></ol>
 573
 574 <p>The format of the DrawSetFillAlpha method is:</p>
 575
 576 <pre class="code">
 577   void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
 578 </pre>
 579
 580 <p>A description of each parameter follows:</p></ol>
 581
 582 <h5>wand</h5>
 583 <ol><p>the drawing wand.</p></ol>
 584
 585 <h5>fill_alpha</h5>
 586 <ol><p>fill alpha</p></ol>
 587
 588  </div>
 589 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 590 _8c.html" target="source" name="DrawSetStrokeAlpha">DrawSetStrokeAlpha</a></h2>
 591 <div class="doc-section">
 592
 593 <p>DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.</p></ol>
 594
 595 <p>The format of the DrawSetStrokeAlpha method is:</p>
 596
 597 <pre class="code">
 598   void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
 599 </pre>
 600
 601 <p>A description of each parameter follows:</p></ol>
 602
 603 <h5>wand</h5>
 604 <ol><p>the drawing wand.</p></ol>
 605
 606 <h5>stroke_alpha</h5>
 607 <ol><p>stroke alpha.  The value 1.0 is opaque.</p></ol>
 608
 609  </div>
 610 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 611 _8c.html" target="source" name="MagickColorFloodfillImage">MagickColorFloodfillImage</a></h2>
 612 <div class="doc-section">
 613
 614 <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>
 615
 616 <p>The format of the MagickColorFloodfillImage method is:</p>
 617
 618 <pre class="code">
 619   MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
 620     const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
 621     const ssize_t x,const ssize_t y)
 622 </pre>
 623
 624 <p>A description of each parameter follows:</p></ol>
 625
 626 <h5>wand</h5>
 627 <ol><p>the magick wand.</p></ol>
 628
 629 <h5>fill</h5>
 630 <ol><p>the floodfill color pixel wand.</p></ol>
 631
 632 <h5>fuzz</h5>
 633 <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>
 634
 635 <h5>bordercolor</h5>
 636 <ol><p>the border color pixel wand.</p></ol>
 637
 638 <h5>x,y</h5>
 639 <ol><p>the starting location of the operation.</p></ol>
 640
 641  </div>
 642 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 643 _8c.html" target="source" name="MagickDescribeImage">MagickDescribeImage</a></h2>
 644 <div class="doc-section">
 645
 646 <p>MagickDescribeImage() identifies an image by printing its attributes to the file.  Attributes include the image width, height, size, and others.</p></ol>
 647
 648 <p>The format of the MagickDescribeImage method is:</p>
 649
 650 <pre class="code">
 651   const char *MagickDescribeImage(MagickWand *wand)
 652 </pre>
 653
 654 <p>A description of each parameter follows:</p></ol>
 655
 656 <h5>wand</h5>
 657 <ol><p>the magick wand.</p></ol>
 658
 659  </div>
 660 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 661 _8c.html" target="source" name="MagickFlattenImages">MagickFlattenImages</a></h2>
 662 <div class="doc-section">
 663
 664 <p>MagickFlattenImages() merges a sequence of images.  This useful for combining Photoshop layers into a single image.</p></ol>
 665
 666 <p>The format of the MagickFlattenImages method is:</p>
 667
 668 <pre class="code">
 669   MagickWand *MagickFlattenImages(MagickWand *wand)
 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  </div>
 678 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 679 _8c.html" target="source" name="MagickGetImageAttribute">MagickGetImageAttribute</a></h2>
 680 <div class="doc-section">
 681
 682 <p>MagickGetImageAttribute() returns a value associated with the specified property.  Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
 683
 684 <p>The format of the MagickGetImageAttribute method is:</p>
 685
 686 <pre class="code">
 687   char *MagickGetImageAttribute(MagickWand *wand,const char *property)
 688 </pre>
 689
 690 <p>A description of each parameter follows:</p></ol>
 691
 692 <h5>wand</h5>
 693 <ol><p>the magick wand.</p></ol>
 694
 695 <h5>property</h5>
 696 <ol><p>the property.</p></ol>
 697
 698  </div>
 699 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 700 _8c.html" target="source" name="MagickGetImageMatte">MagickGetImageMatte</a></h2>
 701 <div class="doc-section">
 702
 703 <p>MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.</p></ol>
 704
 705 <p>The format of the MagickGetImageMatte method is:</p>
 706
 707 <pre class="code">
 708   size_t MagickGetImageMatte(MagickWand *wand)
 709 </pre>
 710
 711 <p>A description of each parameter follows:</p></ol>
 712
 713 <h5>wand</h5>
 714 <ol><p>the magick wand.</p></ol>
 715
 716  </div>
 717 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 718 _8c.html" target="source" name="MagickGetImagePixels">MagickGetImagePixels</a></h2>
 719 <div class="doc-section">
 720
 721 <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, ssize_t, float, or double in the order specified by map.</p></ol>
 722
 723 <p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
 724
 725 <pre class="text">
 726   MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
 727 </pre>
 728
 729 <p>The format of the MagickGetImagePixels method is:</p>
 730
 731 <pre class="code">
 732   MagickBooleanType MagickGetImagePixels(MagickWand *wand,
 733     const ssize_t x,const ssize_t y,const size_t columns,
 734     const size_t rows,const char *map,const StorageType storage,
 735     void *pixels)
 736 </pre>
 737
 738 <p>A description of each parameter follows:</p></ol>
 739
 740 <h5>wand</h5>
 741 <ol><p>the magick wand.</p></ol>
 742
 743 <h5>x, y, columns, rows</h5>
 744 <ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
 745
 746 <h5>map</h5>
 747 <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>
 748
 749 <h5>storage</h5>
 750 <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>
 751
 752 <h5>pixels</h5>
 753 <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>
 754
 755  </div>
 756 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 757 _8c.html" target="source" name="MagickGetImageSize">MagickGetImageSize</a></h2>
 758 <div class="doc-section">
 759
 760 <p>MagickGetImageSize() returns the image length in bytes.</p></ol>
 761
 762 <p>The format of the MagickGetImageSize method is:</p>
 763
 764 <pre class="code">
 765   MagickBooleanType MagickGetImageSize(MagickWand *wand,
 766     MagickSizeType *length)
 767 </pre>
 768
 769 <p>A description of each parameter follows:</p></ol>
 770
 771 <h5>wand</h5>
 772 <ol><p>the magick wand.</p></ol>
 773
 774 <h5>length</h5>
 775 <ol><p>the image length in bytes.</p></ol>
 776
 777  </div>
 778 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 779 _8c.html" target="source" name="MagickMapImage">MagickMapImage</a></h2>
 780 <div class="doc-section">
 781
 782 <p>MagickMapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
 783
 784 <p>The format of the MagickMapImage method is:</p>
 785
 786 <pre class="code">
 787   MagickBooleanType MagickMapImage(MagickWand *wand,
 788     const MagickWand *map_wand,const MagickBooleanType dither)
 789 </pre>
 790
 791 <p>A description of each parameter follows:</p></ol>
 792
 793 <h5>wand</h5>
 794 <ol><p>the magick wand.</p></ol>
 795
 796 <h5>map</h5>
 797 <ol><p>the map wand.</p></ol>
 798
 799 <h5>dither</h5>
 800 <ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
 801
 802  </div>
 803 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 804 _8c.html" target="source" name="MagickMatteFloodfillImage">MagickMatteFloodfillImage</a></h2>
 805 <div class="doc-section">
 806
 807 <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>
 808
 809 <p>The format of the MagickMatteFloodfillImage method is:</p>
 810
 811 <pre class="code">
 812   MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
 813     const double alpha,const double fuzz,const PixelWand *bordercolor,
 814     const ssize_t x,const ssize_t y)
 815 </pre>
 816
 817 <p>A description of each parameter follows:</p></ol>
 818
 819 <h5>wand</h5>
 820 <ol><p>the magick wand.</p></ol>
 821
 822 <h5>alpha</h5>
 823 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
 824
 825 <h5>fuzz</h5>
 826 <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>
 827
 828 <h5>bordercolor</h5>
 829 <ol><p>the border color pixel wand.</p></ol>
 830
 831 <h5>x,y</h5>
 832 <ol><p>the starting location of the operation.</p></ol>
 833
 834  </div>
 835 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 836 _8c.html" target="source" name="MagickMaximumImages">MagickMaximumImages</a></h2>
 837 <div class="doc-section">
 838
 839 <p>MagickMaximumImages() returns the maximum intensity of an image sequence.</p></ol>
 840
 841 <p>The format of the MagickMaximumImages method is:</p>
 842
 843 <pre class="code">
 844   MagickWand *MagickMaximumImages(MagickWand *wand)
 845 </pre>
 846
 847 <p>A description of each parameter follows:</p></ol>
 848
 849 <h5>wand</h5>
 850 <ol><p>the magick wand.</p></ol>
 851
 852  </div>
 853 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 854 _8c.html" target="source" name="MagickMinimumImages">MagickMinimumImages</a></h2>
 855 <div class="doc-section">
 856
 857 <p>MagickMinimumImages() returns the minimum intensity of an image sequence.</p></ol>
 858
 859 <p>The format of the MagickMinimumImages method is:</p>
 860
 861 <pre class="code">
 862   MagickWand *MagickMinimumImages(MagickWand *wand)
 863 </pre>
 864
 865 <p>A description of each parameter follows:</p></ol>
 866
 867 <h5>wand</h5>
 868 <ol><p>the magick wand.</p></ol>
 869
 870  </div>
 871 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 872 _8c.html" target="source" name="MagickMosaicImages">MagickMosaicImages</a></h2>
 873 <div class="doc-section">
 874
 875 <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>
 876
 877 <p>The format of the MagickMosaicImages method is:</p>
 878
 879 <pre class="code">
 880   MagickWand *MagickMosaicImages(MagickWand *wand)
 881 </pre>
 882
 883 <p>A description of each parameter follows:</p></ol>
 884
 885 <h5>wand</h5>
 886 <ol><p>the magick wand.</p></ol>
 887
 888  </div>
 889 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 890 _8c.html" target="source" name="MagickOpaqueImage">MagickOpaqueImage</a></h2>
 891 <div class="doc-section">
 892
 893 <p>MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 894
 895 <p>The format of the MagickOpaqueImage method is:</p>
 896
 897 <pre class="code">
 898   MagickBooleanType MagickOpaqueImage(MagickWand *wand,
 899     const PixelWand *target,const PixelWand *fill,const double fuzz)
 900 </pre>
 901
 902 <p>A description of each parameter follows:</p></ol>
 903
 904 <h5>wand</h5>
 905 <ol><p>the magick wand.</p></ol>
 906
 907 <h5>channel</h5>
 908 <ol><p>the channel(s).</p></ol>
 909
 910 <h5>target</h5>
 911 <ol><p>Change this target color to the fill color within the image.</p></ol>
 912
 913 <h5>fill</h5>
 914 <ol><p>the fill pixel wand.</p></ol>
 915
 916 <h5>fuzz</h5>
 917 <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>
 918
 919  </div>
 920 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 921 _8c.html" target="source" name="MagickPaintFloodfillImage">MagickPaintFloodfillImage</a></h2>
 922 <div class="doc-section">
 923
 924 <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>
 925
 926 <p>The format of the MagickPaintFloodfillImage method is:</p>
 927
 928 <pre class="code">
 929   MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
 930     const ChannelType channel,const PixelWand *fill,const double fuzz,
 931     const PixelWand *bordercolor,const ssize_t x,const ssize_t y)
 932 </pre>
 933
 934 <p>A description of each parameter follows:</p></ol>
 935
 936 <h5>wand</h5>
 937 <ol><p>the magick wand.</p></ol>
 938
 939 <h5>channel</h5>
 940 <ol><p>the channel(s).</p></ol>
 941
 942 <h5>fill</h5>
 943 <ol><p>the floodfill color pixel wand.</p></ol>
 944
 945 <h5>fuzz</h5>
 946 <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>
 947
 948 <h5>bordercolor</h5>
 949 <ol><p>the border color pixel wand.</p></ol>
 950
 951 <h5>x,y</h5>
 952 <ol><p>the starting location of the operation.</p></ol>
 953
 954  </div>
 955 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 956 _8c.html" target="source" name="MagickPaintOpaqueImage">MagickPaintOpaqueImage</a></h2>
 957 <div class="doc-section">
 958
 959 <p>MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 960
 961 <p>The format of the MagickPaintOpaqueImage method is:</p>
 962
 963 <pre class="code">
 964   MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
 965     const PixelWand *target,const PixelWand *fill,const double fuzz)
 966   MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
 967     const ChannelType channel,const PixelWand *target,
 968     const PixelWand *fill,const double fuzz)
 969 </pre>
 970
 971 <p>A description of each parameter follows:</p></ol>
 972
 973 <h5>wand</h5>
 974 <ol><p>the magick wand.</p></ol>
 975
 976 <h5>channel</h5>
 977 <ol><p>the channel(s).</p></ol>
 978
 979 <h5>target</h5>
 980 <ol><p>Change this target color to the fill color within the image.</p></ol>
 981
 982 <h5>fill</h5>
 983 <ol><p>the fill pixel wand.</p></ol>
 984
 985 <h5>fuzz</h5>
 986 <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>
 987
 988  </div>
 989 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
 990 _8c.html" target="source" name="MagickPaintTransparentImage">MagickPaintTransparentImage</a></h2>
 991 <div class="doc-section">
 992
 993 <p>MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 994
 995 <p>The format of the MagickPaintTransparentImage method is:</p>
 996
 997 <pre class="code">
 998   MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
 999     const PixelWand *target,const double alpha,const double fuzz)
1000 </pre>
1001
1002 <p>A description of each parameter follows:</p></ol>
1003
1004 <h5>wand</h5>
1005 <ol><p>the magick wand.</p></ol>
1006
1007 <h5>target</h5>
1008 <ol><p>Change this target color to specified opacity value within the image.</p></ol>
1009
1010 <h5>alpha</h5>
1011 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
1012
1013 <h5>fuzz</h5>
1014 <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>
1015
1016  </div>
1017 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1018 _8c.html" target="source" name="MagickRecolorImage">MagickRecolorImage</a></h2>
1019 <div class="doc-section">
1020
1021 <p>MagickRecolorImage() apply color transformation to an image. The method permits saturation changes, hue rotation, luminance to alpha, and various other effects.  Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets).  The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255).</p></ol>
1022
1023 <p>The format of the MagickRecolorImage method is:</p>
1024
1025 <pre class="code">
1026   MagickBooleanType MagickRecolorImage(MagickWand *wand,
1027     const size_t order,const double *color_matrix)
1028 </pre>
1029
1030 <p>A description of each parameter follows:</p></ol>
1031
1032 <h5>wand</h5>
1033 <ol><p>the magick wand.</p></ol>
1034
1035 <h5>order</h5>
1036 <ol><p>the number of columns and rows in the color matrix.</p></ol>
1037
1038 <h5>color_matrix</h5>
1039 <ol><p>An array of doubles representing the color matrix.</p></ol>
1040
1041  </div>
1042 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1043 _8c.html" target="source" name="MagickSetImageAttribute">MagickSetImageAttribute</a></h2>
1044 <div class="doc-section">
1045
1046 <p>MagickSetImageAttribute() associates a property with an image.</p></ol>
1047
1048 <p>The format of the MagickSetImageAttribute method is:</p>
1049
1050 <pre class="code">
1051   MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
1052     const char *property,const char *value)
1053 </pre>
1054
1055 <p>A description of each parameter follows:</p></ol>
1056
1057 <h5>wand</h5>
1058 <ol><p>the magick wand.</p></ol>
1059
1060 <h5>property</h5>
1061 <ol><p>the property.</p></ol>
1062
1063 <h5>value</h5>
1064 <ol><p>the value.</p></ol>
1065
1066  </div>
1067 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1068 _8c.html" target="source" name="MagickSetImageIndex">MagickSetImageIndex</a></h2>
1069 <div class="doc-section">
1070
1071 <p>MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.</p></ol>
1072
1073 <p>The format of the MagickSetImageIndex method is:</p>
1074
1075 <pre class="code">
1076   MagickBooleanType MagickSetImageIndex(MagickWand *wand,const ssize_t index)
1077 </pre>
1078
1079 <p>A description of each parameter follows:</p></ol>
1080
1081 <h5>wand</h5>
1082 <ol><p>the magick wand.</p></ol>
1083
1084 <h5>index</h5>
1085 <ol><p>the scene number.</p></ol>
1086
1087  </div>
1088 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1089 _8c.html" target="source" name="MagickTransparentImage">MagickTransparentImage</a></h2>
1090 <div class="doc-section">
1091
1092 <p>MagickTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
1093
1094 <p>The format of the MagickTransparentImage method is:</p>
1095
1096 <pre class="code">
1097   MagickBooleanType MagickTransparentImage(MagickWand *wand,
1098     const PixelWand *target,const double alpha,const double fuzz)
1099 </pre>
1100
1101 <p>A description of each parameter follows:</p></ol>
1102
1103 <h5>wand</h5>
1104 <ol><p>the magick wand.</p></ol>
1105
1106 <h5>target</h5>
1107 <ol><p>Change this target color to specified opacity value within the image.</p></ol>
1108
1109 <h5>alpha</h5>
1110 <ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
1111
1112 <h5>fuzz</h5>
1113 <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>
1114
1115  </div>
1116 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1117 _8c.html" target="source" name="MagickRegionOfInterestImage">MagickRegionOfInterestImage</a></h2>
1118 <div class="doc-section">
1119
1120 <p>MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.</p></ol>
1121
1122 <p>The format of the MagickRegionOfInterestImage method is:</p>
1123
1124 <pre class="code">
1125   MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
1126     const size_t width,const size_t height,const ssize_t x,
1127     const ssize_t y)
1128 </pre>
1129
1130 <p>A description of each parameter follows:</p></ol>
1131
1132 <h5>wand</h5>
1133 <ol><p>the magick wand.</p></ol>
1134
1135 <h5>width</h5>
1136 <ol><p>the region width.</p></ol>
1137
1138 <h5>height</h5>
1139 <ol><p>the region height.</p></ol>
1140
1141 <h5>x</h5>
1142 <ol><p>the region x offset.</p></ol>
1143
1144 <h5>y</h5>
1145 <ol><p>the region y offset.</p></ol>
1146
1147  </div>
1148 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1149 _8c.html" target="source" name="MagickSetImagePixels">MagickSetImagePixels</a></h2>
1150 <div class="doc-section">
1151
1152 <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, ssize_t, float, or double in the order specified by map.</p></ol>
1153
1154 <p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
1155
1156 <pre class="text">
1157   MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
1158 </pre>
1159
1160 <p>The format of the MagickSetImagePixels method is:</p>
1161
1162 <pre class="code">
1163   MagickBooleanType MagickSetImagePixels(MagickWand *wand,
1164     const ssize_t x,const ssize_t y,const size_t columns,
1165     const size_t rows,const char *map,const StorageType storage,
1166     const void *pixels)
1167 </pre>
1168
1169 <p>A description of each parameter follows:</p></ol>
1170
1171 <h5>wand</h5>
1172 <ol><p>the magick wand.</p></ol>
1173
1174 <h5>x, y, columns, rows</h5>
1175 <ol><p>These values define the perimeter of a region of pixels you want to define.</p></ol>
1176
1177 <h5>map</h5>
1178 <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>
1179
1180 <h5>storage</h5>
1181 <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>
1182
1183 <h5>pixels</h5>
1184 <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>
1185
1186  </div>
1187 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1188 _8c.html" target="source" name="MagickWriteImageBlob">MagickWriteImageBlob</a></h2>
1189 <div class="doc-section">
1190
1191 <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>
1192
1193 <p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p></ol>
1194
1195 <p>The format of the MagickWriteImageBlob method is:</p>
1196
1197 <pre class="code">
1198   unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
1199 </pre>
1200
1201 <p>A description of each parameter follows:</p></ol>
1202
1203 <h5>wand</h5>
1204 <ol><p>the magick wand.</p></ol>
1205
1206 <h5>length</h5>
1207 <ol><p>the length of the blob.</p></ol>
1208
1209  </div>
1210 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1211 _8c.html" target="source" name="NewPixelView">NewPixelView</a></h2>
1212 <div class="doc-section">
1213
1214 <p>NewPixelView() returns a pixel view required for all other methods in the Pixel View API.</p></ol>
1215
1216 <p>The format of the NewPixelView method is:</p>
1217
1218 <pre class="code">
1219   PixelView *NewPixelView(MagickWand *wand)
1220 </pre>
1221
1222 <p>A description of each parameter follows:</p></ol>
1223
1224 <h5>wand</h5>
1225 <ol><p>the wand.</p></ol>
1226
1227  </div>
1228 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1229 _8c.html" target="source" name="NewPixelViewRegion">NewPixelViewRegion</a></h2>
1230 <div class="doc-section">
1231
1232 <p>NewPixelViewRegion() returns a pixel view required for all other methods in the Pixel View API.</p></ol>
1233
1234 <p>The format of the NewPixelViewRegion method is:</p>
1235
1236 <pre class="code">
1237   PixelView *NewPixelViewRegion(MagickWand *wand,const ssize_t x,
1238     const ssize_t y,const size_t width,const size_t height)
1239 </pre>
1240
1241 <p>A description of each parameter follows:</p></ol>
1242
1243 <h5>wand</h5>
1244 <ol><p>the magick wand.</p></ol>
1245
1246 <h5>x,y,columns,rows</h5>
1247 <ol><p>These values define the perimeter of a region of pixel_wands view.</p></ol>
1248
1249  </div>
1250 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1251 _8c.html" target="source" name="PixelGetNextRow">PixelGetNextRow</a></h2>
1252 <div class="doc-section">
1253
1254 <p>PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
1255
1256 <p>The format of the PixelGetNextRow method is:</p>
1257
1258 <pre class="code">
1259   PixelWand **PixelGetNextRow(PixelIterator *iterator,
1260     size_t *number_wands)
1261 </pre>
1262
1263 <p>A description of each parameter follows:</p></ol>
1264
1265 <h5>iterator</h5>
1266 <ol><p>the pixel iterator.</p></ol>
1267
1268 <h5>number_wands</h5>
1269 <ol><p>the number of pixel wands.</p></ol>
1270
1271  </div>
1272 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1273 _8c.html" target="source" name="PixelIteratorGetException">PixelIteratorGetException</a></h2>
1274 <div class="doc-section">
1275
1276 <p>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
1277
1278 <p>The format of the PixelIteratorGetException method is:</p>
1279
1280 <pre class="code">
1281   char *PixelIteratorGetException(const Pixeliterator *iterator,
1282     ExceptionType *severity)
1283 </pre>
1284
1285 <p>A description of each parameter follows:</p></ol>
1286
1287 <h5>iterator</h5>
1288 <ol><p>the pixel iterator.</p></ol>
1289
1290 <h5>severity</h5>
1291 <ol><p>the severity of the error is returned here.</p></ol>
1292
1293  </div>
1294 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1295 _8c.html" target="source" name="SetPixelViewIterator">SetPixelViewIterator</a></h2>
1296 <div class="doc-section">
1297
1298 <p>SetPixelViewIterator() iterates over the pixel view in parallel and calls your set method for each scanline of the view.  The pixel region is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension.  The pixels are initiallly undefined and any settings you make in the callback method are automagically synced back to your image.</p></ol>
1299
1300 <p>Use this pragma:</p>
1301
1302 <pre class="text">
1303       #pragma omp critical
1304 </pre>
1305
1306 <p>to define a section of code in your callback set method that must be executed by a single thread at a time.</p></ol>
1307
1308 <p>The format of the SetPixelViewIterator method is:</p>
1309
1310 <pre class="code">
1311   MagickBooleanType SetPixelViewIterator(PixelView *destination,
1312     SetPixelViewMethod set,void *context)
1313 </pre>
1314
1315 <p>A description of each parameter follows:</p></ol>
1316
1317 <h5>destination</h5>
1318 <ol><p>the pixel view.</p></ol>
1319
1320 <h5>set</h5>
1321 <ol><p>the set callback method.</p></ol>
1322
1323 <h5>context</h5>
1324 <ol><p>the user defined context.</p></ol>
1325
1326  </div>
1327 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1328 _8c.html" target="source" name="TransferPixelViewIterator">TransferPixelViewIterator</a></h2>
1329 <div class="doc-section">
1330
1331 <p>TransferPixelViewIterator() iterates over two pixel views in parallel and calls your transfer method for each scanline of the view.  The source pixel region is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. However, the destination pixel view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.</p></ol>
1332
1333 <p>Use this pragma:</p>
1334
1335 <pre class="text">
1336       #pragma omp critical
1337 </pre>
1338
1339 <p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p></ol>
1340
1341 <p>The format of the TransferPixelViewIterator method is:</p>
1342
1343 <pre class="code">
1344   MagickBooleanType TransferPixelViewIterator(PixelView *source,
1345     PixelView *destination,TransferPixelViewMethod transfer,void *context)
1346 </pre>
1347
1348 <p>A description of each parameter follows:</p></ol>
1349
1350 <h5>source</h5>
1351 <ol><p>the source pixel view.</p></ol>
1352
1353 <h5>destination</h5>
1354 <ol><p>the destination pixel view.</p></ol>
1355
1356 <h5>transfer</h5>
1357 <ol><p>the transfer callback method.</p></ol>
1358
1359 <h5>context</h5>
1360 <ol><p>the user defined context.</p></ol>
1361
1362  </div>
1363 <h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
1364 _8c.html" target="source" name="UpdatePixelViewIterator">UpdatePixelViewIterator</a></h2>
1365 <div class="doc-section">
1366
1367 <p>UpdatePixelViewIterator() iterates over the pixel view in parallel and calls your update method for each scanline of the view.  The pixel region is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.  Updates to pixels in your callback are automagically synced back to the image.</p></ol>
1368
1369 <p>Use this pragma:</p>
1370
1371 <pre class="text">
1372       #pragma omp critical
1373 </pre>
1374
1375 <p>to define a section of code in your callback update method that must be executed by a single thread at a time.</p></ol>
1376
1377 <p>The format of the UpdatePixelViewIterator method is:</p>
1378
1379 <pre class="code">
1380   MagickBooleanType UpdatePixelViewIterator(PixelView *source,
1381     UpdatePixelViewMethod update,void *context)
1382 </pre>
1383
1384 <p>A description of each parameter follows:</p></ol>
1385
1386 <h5>source</h5>
1387 <ol><p>the source pixel view.</p></ol>
1388
1389 <h5>update</h5>
1390 <ol><p>the update callback method.</p></ol>
1391
1392 <h5>context</h5>
1393 <ol><p>the user defined context.</p></ol>
1394
1395  </div>
1396 \r
1397 </div>\r
1398 \r
1399 <div id="linkbar">\r
1400     <span id="linkbar-west">&nbsp;</span>\r
1401     <span id="linkbar-center">\r
1402       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
1403       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
1404     </span>\r
1405     <span id="linkbar-east">&nbsp;</span>\r
1406   </div>\r
1407   <div class="footer">\r
1408     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
1409     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
1410   </div>\r
1411   <div style="clear: both; margin: 0; width: 100%; "></div>\r
1412   <script type="text/javascript">\r
1413     var _gaq = _gaq || [];\r
1414     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
1415     _gaq.push(['_trackPageview']);\r
1416 \r
1417     (function() {\r
1418       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
1419       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
1420       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
1421     })();\r
1422   </script>\r
1423 </body>\r
1424 </html>\r