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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html version="-//W3C//DTD XHTML 1.1//EN"\r
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
   8 <head>\r
   9   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
  10   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Paint on an Image</title>
  12   <meta http-equiv="Content-Language" content="en-US"/>
  13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  15   <meta name="Application-name" content="ImageMagick"/>
  16   <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images."/>
  17   <meta name="Application-url" content="http://www.imagemagick.org"/>
  18   <meta name="Generator" content="PHP"/>
  19   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, paint, on, an, image, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  20   <meta name="Rating" content="GENERAL"/>
  21   <meta name="Robots" content="INDEX, FOLLOW"/>
  22   <meta name="Generator" content="ImageMagick Studio LLC"/>
  23   <meta name="Author" content="ImageMagick Studio LLC"/>
  24   <meta name="Revisit-after" content="2 DAYS"/>
  25   <meta name="Resource-type" content="document"/>
  26   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  27   <meta name="Distribution" content="Global"/>
  28   <link rel="icon" href="../../images/wand.png"/>
  29   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  30   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  31   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  32   <style type="text/css" media="all">\r
  33     @import url("../../www/magick.css");\r
  34   </style>\r
  35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  36   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  37   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  38   <script type="text/javascript">\r
  39     $(document).ready(function() {\r
  40       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  41         'transitionIn'  : 'elastic',\r
  42         'transitionOut' : 'elastic',\r
  43         'overlayShow'   : false,\r
  44         'opacity'       : true\r
  45       });\r
  46     });\r
  47   </script>\r
  48 </head>\r
  49 \r
  50 <body id="www-imagemagick-org">\r
  51 <div class="titlebar">\r
  52 <div style="margin: 17px auto; float: left;">\r
  53   <script type="text/javascript">\r
  54   <!--\r
  55     google_ad_client = "pub-3129977114552745";\r
  56     google_ad_slot = "5439289906";\r
  57     google_ad_width = 728;\r
  58     google_ad_height = 90;\r
  59   //-->\r
  60   </script>\r
  61   <script type="text/javascript"\r
  62     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
  63   </script>\r
  64 </div>\r
  65 <a href="http://www.imagemagick.org/discourse-server/">\r
  66   <img src="../../images/logo.jpg"\r
  67   alt="ImageMagick Logo"\r
  68   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  69 <a href="../../index.html">\r
  70   <img src="../../images/sprite.jpg"\r
  71   alt="ImageMagick Sprite"\r
  72   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  73 </div>\r
  74 \r
  75 <div class="westbar">\r
  76 \r
  77 <div class="menu">
  78   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div class="menu">
  82   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  83 </div>
  84 <div class="sub">
  85     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  89 </div>
  90 <div class="sub">
  91     <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
  92 </div>
  93 <div class="sub">
  94     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  95 </div>
  96 <div class="sep"></div>\r
  97 <div class="menu">
  98   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
 105 </div>
 106 <div class="sub">
 107     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 108 </div>
 109 <div class="menu">
 110   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 111 </div>
 112 <div class="sub">
 113     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 114 </div>
 115 <div class="sub">
 116     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 117 </div>
 118 <div class="sub">
 119     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 120 </div>
 121 <div class="sub">
 122     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 133  </div>
 134 <div class="menu">
 135   <a title="Resources" href="../../www/resources.html">Resources</a>
 136 </div>
 137 <div class="menu">
 138   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 139 </div>
 140 <div class="menu">
 141   <a title="Download" href="../../www/download.html">Download</a>
 142 </div>
 143 <div class="sep"></div>\r
 144 <div class="menu">
 145   <a title="Search" href="../../www/search.html">Search</a>
 146 </div>
 147 <div class="sep"></div>\r
 148 <div class="menu">
 149   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 150 </div>
 151 <div  class="sub">
 152   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 153 </div>
 154 <div class="sep"></div>\r
 155 <div  class="menu">
 156   <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 157
 158 <a href="http://www.networkredux.com">
 159   <img src="../../images/networkredux.png" alt="[sponsor]"
 160   style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 161 <div class="sponsbox">
 162 <div  class="sponsor">
 163   <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
 164 </div>
 165 <div  class="sponsor">
 166   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 167 </div>
 168 <div  class="sponsor">
 169   <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
 170 </div>
 171 <div  class="sponsor">
 172   <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 173 </div>
 174 <div  class="sponsor">
 175   <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 176 </div>
 177 <div  class="sponsor">
 178   <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 179 </div>
 180 <div  class="sponsor">
 181   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
 182 </div>
 183 <div  class="sponsor">
 184   <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 185 </div>
 186 <div  class="sponsor">
 187   <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 188 </div>
 189 <div  class="sponsor">
 190    <a rel="follow" title="Sponsor: Fototapete" href=" http://www.allesdruck.de/Fototapete-Tapetendruck,category,8830.html">Fototapete</a><!-- 20110701000080 a-o.de -->
 191 </div>
 192 </div>
 193 </div>
 194 </div>\r
 195 \r
 196 <div class="eastbar">\r
 197 \r
 198 </div>\r
 199 \r
 200 <div class="main">\r
 201 \r
 202 <h1>Module paint Methods</h1>
 203 <p class="navigation-index">[<a href="#FloodfillPaintImage">FloodfillPaintImage</a> &bull; <a href="#OilPaintImage">OilPaintImage</a> &bull; <a href="#OpaquePaintImage">OpaquePaintImage</a> &bull; <a href="#TransparentPaintImage">TransparentPaintImage</a> &bull; <a href="#TransparentPaintImageChroma">TransparentPaintImageChroma</a>]</p>
 204
 205 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint_8c.html" id="FloodfillPaintImage">FloodfillPaintImage</a></h2>
 206 <div class="doc-section">
 207
 208 <p>FloodfillPaintImage() 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>
 209
 210 <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>
 211
 212 <p>The format of the FloodfillPaintImage method is:</p>
 213
 214 <pre class="code">
 215   MagickBooleanType FloodfillPaintImage(Image *image,
 216     const ChannelType channel,const DrawInfo *draw_info,
 217     const MagickPixelPacket target,const ssize_t x_offset,
 218     const ssize_t y_offset,const MagickBooleanType invert)
 219 </pre>
 220
 221 <p>A description of each parameter follows:</p>
 222
 223 <h5>image</h5>
 224 <p>the image.</p>
 225
 226 <h5>channel</h5>
 227 <p>the channel(s).</p>
 228
 229 <h5>draw_info</h5>
 230 <p>the draw info.</p>
 231
 232 <h5>target</h5>
 233 <p>the RGB value of the target color.</p>
 234
 235 <h5>x_offset,y_offset</h5>
 236 <p>the starting location of the operation.</p>
 237
 238 <h5>invert</h5>
 239 <p>paint any pixel that does not match the target color.</p>
 240
 241  </div>
 242 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint_8c.html" id="OilPaintImage">OilPaintImage</a></h2>
 243 <div class="doc-section">
 244
 245 <p>OilPaintImage() applies a special effect filter that simulates an oil painting.  Each pixel is replaced by the most frequent color occurring in a circular region defined by radius.</p>
 246
 247 <p>The format of the OilPaintImage method is:</p>
 248
 249 <pre class="code">
 250   Image *OilPaintImage(const Image *image,const double radius,
 251     ExceptionInfo *exception)
 252 </pre>
 253
 254 <p>A description of each parameter follows:</p>
 255
 256 <h5>image</h5>
 257 <p>the image.</p>
 258
 259 <h5>radius</h5>
 260 <p>the radius of the circular neighborhood.</p>
 261
 262 <h5>exception</h5>
 263 <p>return any errors or warnings in this structure.</p>
 264
 265  </div>
 266 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint_8c.html" id="OpaquePaintImage">OpaquePaintImage</a></h2>
 267 <div class="doc-section">
 268
 269 <p>OpaquePaintImage() changes any pixel that matches color with the color defined by fill.</p>
 270
 271 <p>By default color must match a particular pixel color exactly.  However, in many cases two colors may differ by a small amount.  Fuzz 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.</p>
 272
 273 <p>The format of the OpaquePaintImage method is:</p>
 274
 275 <pre class="code">
 276   MagickBooleanType OpaquePaintImage(Image *image,
 277     const PixelPacket *target,const PixelPacket *fill,
 278     const MagickBooleanType invert)
 279   MagickBooleanType OpaquePaintImageChannel(Image *image,
 280     const ChannelType channel,const PixelPacket *target,
 281     const PixelPacket *fill,const MagickBooleanType invert)
 282 </pre>
 283
 284 <p>A description of each parameter follows:</p>
 285
 286 <h5>image</h5>
 287 <p>the image.</p>
 288
 289 <h5>channel</h5>
 290 <p>the channel(s).</p>
 291
 292 <h5>target</h5>
 293 <p>the RGB value of the target color.</p>
 294
 295 <h5>fill</h5>
 296 <p>the replacement color.</p>
 297
 298 <h5>invert</h5>
 299 <p>paint any pixel that does not match the target color.</p>
 300
 301  </div>
 302 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint_8c.html" id="TransparentPaintImage">TransparentPaintImage</a></h2>
 303 <div class="doc-section">
 304
 305 <p>TransparentPaintImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p>
 306
 307 <p>By default color must match a particular pixel color exactly.  However, in many cases two colors may differ by a small amount.  Fuzz 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.</p>
 308
 309 <p>The format of the TransparentPaintImage method is:</p>
 310
 311 <pre class="code">
 312   MagickBooleanType TransparentPaintImage(Image *image,
 313     const MagickPixelPacket *target,const Quantum opacity,
 314     const MagickBooleanType invert)
 315 </pre>
 316
 317 <p>A description of each parameter follows:</p>
 318
 319 <h5>image</h5>
 320 <p>the image.</p>
 321
 322 <h5>target</h5>
 323 <p>the target color.</p>
 324
 325 <h5>opacity</h5>
 326 <p>the replacement opacity value.</p>
 327
 328 <h5>invert</h5>
 329 <p>paint any pixel that does not match the target color.</p>
 330
 331  </div>
 332 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint_8c.html" id="TransparentPaintImageChroma">TransparentPaintImageChroma</a></h2>
 333 <div class="doc-section">
 334
 335 <p>TransparentPaintImageChroma() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p>
 336
 337 <p>As there is one fuzz value for the all the channels, the TransparentPaintImage() API is not suitable for the operations like chroma, where the tolerance for similarity of two color component (RGB) can be different, Thus we define this method take two target pixels (one low and one hight) and all the pixels of an image which are lying between these two pixels are made transparent.</p>
 338
 339 <p>The format of the TransparentPaintImage method is:</p>
 340
 341 <pre class="code">
 342   MagickBooleanType TransparentPaintImage(Image *image,
 343     const MagickPixelPacket *low,const MagickPixelPacket *hight,
 344     const Quantum opacity,const MagickBooleanType invert)
 345 </pre>
 346
 347 <p>A description of each parameter follows:</p>
 348
 349 <h5>image</h5>
 350 <p>the image.</p>
 351
 352 <h5>low</h5>
 353 <p>the low target color.</p>
 354
 355 <h5>high</h5>
 356 <p>the high target color.</p>
 357
 358 <h5>opacity</h5>
 359 <p>the replacement opacity value.</p>
 360
 361 <h5>invert</h5>
 362 <p>paint any pixel that does not match the target color.</p>
 363
 364  </div>
 365 \r
 366 </div>\r
 367 \r
 368 <div id="linkbar">\r
 369     <span id="linkbar-west">&nbsp;</span>\r
 370     <span id="linkbar-center">\r
 371       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 372       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 373     </span>\r
 374     <span id="linkbar-east">&nbsp;</span>\r
 375   </div>\r
 376   <div class="footer">\r
 377     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 378     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 379   </div>\r
 380   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 381   <script type="text/javascript">\r
 382     var _gaq = _gaq || [];\r
 383     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 384     _gaq.push(['_trackPageview']);\r
 385 \r
 386     (function() {\r
 387       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 388       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 389       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 390     })();\r
 391   </script>\r
 392 </body>\r
 393 </html>\r