granicus.if.org Git - imagemagick/blob - www/api/deprecate.html

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