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