granicus.if.org Git - imagemagick/blob - www/api/paint.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">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  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="Generator" content="PHP"/>
  16   <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"/>
  17   <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."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 127 </div>
 128 <div  class="sponsor">
 129    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 130 </div>
 131 <div  class="sponsor">
 132    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
 142 </div>
 143 </div>
 144 </div>
 145 \r
 146 \r
 147 </div>\r
 148 \r
 149 <div class="main">\r
 150 \r
 151 <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>
 152
 153 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint
 154 _8c.html" target="source" name="FloodfillPaintImage">FloodfillPaintImage</a></h2>
 155 <div class="doc-section">
 156
 157 <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></ol>
 158
 159 <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>
 160
 161 <p>The format of the FloodfillPaintImage method is:</p>
 162
 163 <pre class="code">
 164   MagickBooleanType FloodfillPaintImage(Image *image,
 165     const ChannelType channel,const DrawInfo *draw_info,
 166     const MagickPixelPacket target,const long x_offset,const long y_offset,
 167     const MagickBooleanType invert)
 168 </pre>
 169
 170 <p>A description of each parameter follows:</p></ol>
 171
 172 <h5>image</h5>
 173 <ol><p>the image.</p></ol>
 174
 175 <h5>channel</h5>
 176 <ol><p>the channel(s).</p></ol>
 177
 178 <h5>draw_info</h5>
 179 <ol><p>the draw info.</p></ol>
 180
 181 <h5>target</h5>
 182 <ol><p>the RGB value of the target color.</p></ol>
 183
 184 <h5>x_offset,y_offset</h5>
 185 <ol><p>the starting location of the operation.</p></ol>
 186
 187 <h5>invert</h5>
 188 <ol><p>paint any pixel that does not match the target color.</p></ol>
 189
 190  </div>
 191 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint
 192 _8c.html" target="source" name="OilPaintImage">OilPaintImage</a></h2>
 193 <div class="doc-section">
 194
 195 <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></ol>
 196
 197 <p>The format of the OilPaintImage method is:</p>
 198
 199 <pre class="code">
 200   Image *OilPaintImage(const Image *image,const double radius,
 201     ExceptionInfo *exception)
 202 </pre>
 203
 204 <p>A description of each parameter follows:</p></ol>
 205
 206 <h5>image</h5>
 207 <ol><p>the image.</p></ol>
 208
 209 <h5>radius</h5>
 210 <ol><p>the radius of the circular neighborhood.</p></ol>
 211
 212 <h5>exception</h5>
 213 <ol><p>return any errors or warnings in this structure.</p></ol>
 214
 215  </div>
 216 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint
 217 _8c.html" target="source" name="OpaquePaintImage">OpaquePaintImage</a></h2>
 218 <div class="doc-section">
 219
 220 <p>OpaquePaintImage() changes any pixel that matches color with the color defined by fill.</p></ol>
 221
 222 <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></ol>
 223
 224 <p>The format of the OpaquePaintImage method is:</p>
 225
 226 <pre class="code">
 227   MagickBooleanType OpaquePaintImage(Image *image,
 228     const PixelPacket *target,const PixelPacket *fill,
 229     const MagickBooleanType invert)
 230   MagickBooleanType OpaquePaintImageChannel(Image *image,
 231     const ChannelType channel,const PixelPacket *target,
 232     const PixelPacket *fill,const MagickBooleanType invert)
 233 </pre>
 234
 235 <p>A description of each parameter follows:</p></ol>
 236
 237 <h5>image</h5>
 238 <ol><p>the image.</p></ol>
 239
 240 <h5>channel</h5>
 241 <ol><p>the channel(s).</p></ol>
 242
 243 <h5>target</h5>
 244 <ol><p>the RGB value of the target color.</p></ol>
 245
 246 <h5>fill</h5>
 247 <ol><p>the replacement color.</p></ol>
 248
 249 <h5>invert</h5>
 250 <ol><p>paint any pixel that does not match the target color.</p></ol>
 251
 252  </div>
 253 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint
 254 _8c.html" target="source" name="TransparentPaintImage">TransparentPaintImage</a></h2>
 255 <div class="doc-section">
 256
 257 <p>TransparentPaintImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
 258
 259 <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></ol>
 260
 261 <p>The format of the TransparentPaintImage method is:</p>
 262
 263 <pre class="code">
 264   MagickBooleanType TransparentPaintImage(Image *image,
 265     const MagickPixelPacket *target,const Quantum opacity,
 266     const MagickBooleanType invert)
 267 </pre>
 268
 269 <p>A description of each parameter follows:</p></ol>
 270
 271 <h5>image</h5>
 272 <ol><p>the image.</p></ol>
 273
 274 <h5>target</h5>
 275 <ol><p>the target color.</p></ol>
 276
 277 <h5>opacity</h5>
 278 <ol><p>the replacement opacity value.</p></ol>
 279
 280 <h5>invert</h5>
 281 <ol><p>paint any pixel that does not match the target color.</p></ol>
 282
 283  </div>
 284 <h2><a href="http://www.imagemagick.org/api/MagickCore/paint
 285 _8c.html" target="source" name="TransparentPaintImageChroma">TransparentPaintImageChroma</a></h2>
 286 <div class="doc-section">
 287
 288 <p>TransparentPaintImageChroma() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
 289
 290 <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></ol>
 291
 292 <p>The format of the TransparentPaintImage method is:</p>
 293
 294 <pre class="code">
 295   MagickBooleanType TransparentPaintImage(Image *image,
 296     const MagickPixelPacket *low,const MagickPixelPacket *hight,
 297     const Quantum opacity,const MagickBooleanType invert)
 298 </pre>
 299
 300 <p>A description of each parameter follows:</p></ol>
 301
 302 <h5>image</h5>
 303 <ol><p>the image.</p></ol>
 304
 305 <h5>low</h5>
 306 <ol><p>the low target color.</p></ol>
 307
 308 <h5>high</h5>
 309 <ol><p>the high target color.</p></ol>
 310
 311 <h5>opacity</h5>
 312 <ol><p>the replacement opacity value.</p></ol>
 313
 314 <h5>invert</h5>
 315 <ol><p>paint any pixel that does not match the target color.</p></ol>
 316
 317  </div>
 318 \r
 319 </div>\r
 320 \r
 321 <div id="linkbar">\r
 322  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 323     <span id="linkbar-center">\r
 324       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 325       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 326     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 327     </span>\r
 328     <span id="linkbar-east">&nbsp;</span>\r
 329   </div>\r
 330   <div class="footer">\r
 331     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 332     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 333   </div>\r
 334   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 335 </body>\r
 336 </html>\r