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

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