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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html version="-//W3C//DTD XHTML 1.1//EN"
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
   8 <head>
   9   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
  10   <meta name=viewport content="width=device-width, initial-scale=0.3333334">
  11   <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"/>
  12   <title>ImageMagick: MagickCore, C API for ImageMagick: Paint on an Image</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="application-name" content="ImageMagick"/>
  17   <meta name="description" content="A collection of tools and libraries to read, write, and manipulate an image in any of the more popular image formats."/>
  18   <meta name="application-url" content="http://www.imagemagick.org"/>
  19   <meta name="generator" content="PHP"/>
  20   <meta name="keywords" content="magickcore, c, api, for, imagemagick:, paint, on, an, image, convert, edit, compose, image, pixel"/>
  21   <meta name="rating" content="GENERAL"/>
  22   <meta name="robots" content="INDEX, FOLLOW"/>
  23   <meta name="generator" content="ImageMagick Studio LLC"/>
  24   <meta name="author" content="ImageMagick Studio LLC"/>
  25   <meta name="revisit-after" content="2 DAYS"/>
  26   <meta name="resource-type" content="document"/>
  27   <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
  28   <meta name="distribution" content="Global"/>
  29   <link rel="icon" href="../../images/wand.png"/>
  30   <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
  31   <link rel="canonical" href="http://www.imagemagick.org" />
  32   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
  33
  34   <!-- Add jQuery library -->
  35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/2.1.0/jquery.min.js"></script>
  36
  37   <!-- Add mousewheel plugin (this is optional) -->
  38   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
  39
  40   <!-- Add fancyBox -->
  41   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.1.5" type="text/css" media="screen" />
  42   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.1.5"></script>
  43
  44   <!-- Optionally add helpers - button, thumbnail and/or media -->
  45   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.5" type="text/css" media="screen" />
  46   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.5"></script>
  47   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.6"></script>
  48
  49   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=1.0.7" type="text/css" media="screen" />
  50   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=1.0.7"></script>
  51
  52   <script type="text/javascript">
  53         $(document).ready(function() {
  54                 $(".fancybox").fancybox();
  55         });
  56   </script>
  57
  58   <!-- ImageMagick style -->
  59   <style type="text/css" media="all">
  60     @import url("../../www/magick.css");
  61   </style>
  62 </head>
  63
  64 <body id="www-imagemagick-org">
  65
  66 <script type="text/javascript">
  67   (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  68   (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  69   m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  70   })(window,document,'offline-script','//www.google-analytics.com/analytics.js','ga');
  71
  72   ga('create', 'UA-40133312-1', 'imagemagick.org');
  73   ga('send', 'pageview');
  74 </script>
  75
  76 <div class="titlebar">
  77 <div style="margin: 17px auto; float: left;">
  78   <script type="text/javascript">
  79   <!--
  80     google_ad_client = "pub-3129977114552745";
  81     google_ad_slot = "5439289906";
  82     google_ad_width = 728;
  83     google_ad_height = 90;
  84   //-->
  85   </script>
  86   <script type="text/javascript"
  87     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
  88   </script>
  89 </div>
  90 <a href="../../discourse-server">
  91   <img src="../../images/logo.jpg"
  92   alt="ImageMagick Logo" width="123" height="118"
  93   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
  94 <a href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">
  95   <img src="../../images/sprite.jpg"
  96   alt="ImageMagick Sprite" width="114" height="118"
  97   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  98 </div>
  99
 100 <div class="westbar">
 101
 102 <div class="menu">
 103   <a title="About ImageMagick" href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">About ImageMagick</a>
 104 </div>
 105 <div class="menu">
 106   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
 107 </div>
 108 <div class="sub">
 109     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
 110 </div>
 111 <div class="sub">
 112     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
 116 </div>
 117 <div class="sub">
 118     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
 119 </div>
 120 <div class="sep"></div>
 121 <div class="menu">
 122   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
 123 </div>
 124 <div class="sub">
 125     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
 126 </div>
 127 <div class="sub">
 128     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
 129 </div>
 130 <div class="sub">
 131     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 132 </div>
 133 <div class="menu">
 134   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 135 </div>
 136 <div class="sub">
 137     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 138 </div>
 139 <div class="sub">
 140     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 141 </div>
 142 <div class="sub">
 143     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 144 </div>
 145 <div class="sub">
 146     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 147 </div>
 148 <div class="sep"></div>
 149 <div  class="menu">
 150    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 151 </div>
 152 <div class="sub">
 153     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 154 </div>
 155 <div class="sub">
 156     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 157  </div>
 158 <div class="menu">
 159   <a title="Resources" href="../../www/resources.html">Resources</a>
 160 </div>
 161 <div class="menu">
 162   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 163 </div>
 164 <div class="menu">
 165   <a title="Download" href="../../www/download.html">Download</a>
 166 </div>
 167 <div class="sep"></div>
 168 <div class="menu">
 169   <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
 170 </div>
 171 <div class="sep"></div>
 172 <div class="menu">
 173   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 174 </div>
 175 <div  class="sub">
 176   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 177 </div>
 178 <div class="sep"></div>
 179 </div>
 180
 181 <div class="eastbar">
 182   <script type="text/javascript">
 183     /* <![CDATA[ */
 184     window.___gcfg = {
 185       lang: 'en-US'
 186     };
 187
 188     (function() {
 189       var po = document.createElement('offline-script');
 190       po.type = 'text/javascript';
 191       po.async = true;
 192       po.src = 'https://apis.google.com/js/plusone.js';
 193       var script = document.getElementsByTagName('offline-script')[0];
 194       script.parentNode.insertBefore(po, script);
 195     })();
 196     var gplusone = document.getElementById("gplusone");
 197     gplusone.setAttribute("data-size","medium");
 198     gplusone.setAttribute("data-count","true");
 199     /* ]]> */
 200   </script>
 201   <script type="text/javascript">
 202     /* <![CDATA[ */
 203     (function() {
 204         var po = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
 205         po.type = 'text/javascript';
 206         po.async = true;
 207         po.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
 208         var script = document.getElementsByTagName('offline-script')[0];
 209         script.parentNode.insertBefore(po, script);
 210     })();
 211     /* ]]> */
 212   </script>
 213   <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://www.imagemagick.org/"></a></div>
 214   <noscript>
 215     <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
 216     <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0" /></a>
 217   </noscript>
 218   <div class="g-plusone" data-size="standard" data-count="true"></div>
 219 </div>
 220
 221 <div class="main">
 222
 223 <h1>Module paint Methods</h1>
 224 <p class="navigation-index">[<a href="paint.html#FloodfillPaintImage">FloodfillPaintImage</a> &#8226; <a href="paint.html#OilPaintImage">OilPaintImage</a> &#8226; <a href="paint.html#OpaquePaintImage">OpaquePaintImage</a> &#8226; <a href="paint.html#TransparentPaintImage">TransparentPaintImage</a> &#8226; <a href="paint.html#TransparentPaintImageChroma">TransparentPaintImageChroma</a>]</p>
 225
 226 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint_8c.html" id="FloodfillPaintImage">FloodfillPaintImage</a></h2>
 227 <div class="doc-section">
 228
 229 <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>
 230
 231 <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>
 232
 233 <p>The format of the FloodfillPaintImage method is:</p>
 234
 235 <pre class="code">
 236   MagickBooleanType FloodfillPaintImage(Image *image,
 237     const ChannelType channel,const DrawInfo *draw_info,
 238     const MagickPixelPacket target,const ssize_t x_offset,
 239     const ssize_t y_offset,const MagickBooleanType invert)
 240 </pre>
 241
 242 <p>A description of each parameter follows:</p>
 243
 244 <h5>image</h5>
 245 <p>the image.</p>
 246
 247 <h5>channel</h5>
 248 <p>the channel(s).</p>
 249
 250 <h5>draw_info</h5>
 251 <p>the draw info.</p>
 252
 253 <h5>target</h5>
 254 <p>the RGB value of the target color.</p>
 255
 256 <h5>x_offset,y_offset</h5>
 257 <p>the starting location of the operation.</p>
 258
 259 <h5>invert</h5>
 260 <p>paint any pixel that does not match the target color.</p>
 261
 262  </div>
 263 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint_8c.html" id="OilPaintImage">OilPaintImage</a></h2>
 264 <div class="doc-section">
 265
 266 <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>
 267
 268 <p>The format of the OilPaintImage method is:</p>
 269
 270 <pre class="code">
 271   Image *OilPaintImage(const Image *image,const double radius,
 272     ExceptionInfo *exception)
 273 </pre>
 274
 275 <p>A description of each parameter follows:</p>
 276
 277 <h5>image</h5>
 278 <p>the image.</p>
 279
 280 <h5>radius</h5>
 281 <p>the radius of the circular neighborhood.</p>
 282
 283 <h5>exception</h5>
 284 <p>return any errors or warnings in this structure.</p>
 285
 286  </div>
 287 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint_8c.html" id="OpaquePaintImage">OpaquePaintImage</a></h2>
 288 <div class="doc-section">
 289
 290 <p>OpaquePaintImage() changes any pixel that matches color with the color defined by fill.</p>
 291
 292 <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>
 293
 294 <p>The format of the OpaquePaintImage method is:</p>
 295
 296 <pre class="code">
 297   MagickBooleanType OpaquePaintImage(Image *image,
 298     const PixelPacket *target,const PixelPacket *fill,
 299     const MagickBooleanType invert)
 300   MagickBooleanType OpaquePaintImageChannel(Image *image,
 301     const ChannelType channel,const PixelPacket *target,
 302     const PixelPacket *fill,const MagickBooleanType invert)
 303 </pre>
 304
 305 <p>A description of each parameter follows:</p>
 306
 307 <h5>image</h5>
 308 <p>the image.</p>
 309
 310 <h5>channel</h5>
 311 <p>the channel(s).</p>
 312
 313 <h5>target</h5>
 314 <p>the RGB value of the target color.</p>
 315
 316 <h5>fill</h5>
 317 <p>the replacement color.</p>
 318
 319 <h5>invert</h5>
 320 <p>paint any pixel that does not match the target color.</p>
 321
 322  </div>
 323 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint_8c.html" id="TransparentPaintImage">TransparentPaintImage</a></h2>
 324 <div class="doc-section">
 325
 326 <p>TransparentPaintImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p>
 327
 328 <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>
 329
 330 <p>The format of the TransparentPaintImage method is:</p>
 331
 332 <pre class="code">
 333   MagickBooleanType TransparentPaintImage(Image *image,
 334     const MagickPixelPacket *target,const Quantum opacity,
 335     const MagickBooleanType invert)
 336 </pre>
 337
 338 <p>A description of each parameter follows:</p>
 339
 340 <h5>image</h5>
 341 <p>the image.</p>
 342
 343 <h5>target</h5>
 344 <p>the target color.</p>
 345
 346 <h5>opacity</h5>
 347 <p>the replacement opacity value.</p>
 348
 349 <h5>invert</h5>
 350 <p>paint any pixel that does not match the target color.</p>
 351
 352  </div>
 353 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint_8c.html" id="TransparentPaintImageChroma">TransparentPaintImageChroma</a></h2>
 354 <div class="doc-section">
 355
 356 <p>TransparentPaintImageChroma() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p>
 357
 358 <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>
 359
 360 <p>The format of the TransparentPaintImage method is:</p>
 361
 362 <pre class="code">
 363   MagickBooleanType TransparentPaintImage(Image *image,
 364     const MagickPixelPacket *low,const MagickPixelPacket *hight,
 365     const Quantum opacity,const MagickBooleanType invert)
 366 </pre>
 367
 368 <p>A description of each parameter follows:</p>
 369
 370 <h5>image</h5>
 371 <p>the image.</p>
 372
 373 <h5>low</h5>
 374 <p>the low target color.</p>
 375
 376 <h5>high</h5>
 377 <p>the high target color.</p>
 378
 379 <h5>opacity</h5>
 380 <p>the replacement opacity value.</p>
 381
 382 <h5>invert</h5>
 383 <p>paint any pixel that does not match the target color.</p>
 384
 385  </div>
 386
 387 </div>
 388
 389 <div id="linkbar">
 390     <span id="linkbar-west"> </span>
 391
 392     <span id="linkbar-center">
 393       <a href="../../discourse-server">Discourse Server</a> •
 394       <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
 395       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> •
 396       <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
 397     </span>
 398     <span id="linkbar-east"> </span>
 399 </div>
 400 <div class="footer">
 401   <span id="footer-west">©  1999-2014 ImageMagick Studio LLC</span>
 402   <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
 403 </div>
 404 <div style="clear: both; margin: 0; width: 100%; "></div>
 405 </body>
 406 </html>