Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 7363fdec3d60ce2a051a6d363a95d0634002e6e7 / . / www / api / paint.html
blob: 0ec6fe2069c006c69e415c852a9ffb6da99e788e [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Paint on an Image</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]12 <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."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <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"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]27 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]28 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]31 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]32 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]44</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]53 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]54<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]55 <img src="../../images/logo.jpg"
56 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]57 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]58<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]59 <img src="../../images/sprite.jpg"
60 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]61 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
62</div>
63
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]64<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]67 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]70<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]71 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
72</div>
73<div class="sub">
74 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
75</div>
76<div class="sub">
77 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
78</div>
79<div class="sub">
80 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
81</div>
82<div class="sep"></div>
83<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]84 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]85</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]87 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]88</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]90 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]91</div>
92<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]108 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
114<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
117<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]118 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]119 </div>
120<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]121 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]123<div class="menu">
124 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
125</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]129<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]131 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]133<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]135 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
137<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]138 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]140<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143
144<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]145<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]146 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
147</div>
148<div class="sponsor">
149 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
150</div>
151<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]152 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
153</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]154<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]155 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristya6d7cf72010-11-07 15:58:34 +0000[diff] [blame]156</div>
157<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]158 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
159</div>
160<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]161 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
162</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]163<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]164 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
165</div>
166<div class="sponsor">
cristya3c43262011-02-13 16:50:35 +0000[diff] [blame]167 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011050100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]168</div>
cristyb15553d2010-07-03 22:53:14 +0000[diff] [blame]169</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]170</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]171</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]172
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]173<div class="eastbar">
174 <script type="text/javascript">
175 <!--
176 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]177 google_ad_slot = "0574824969";
178 google_ad_width = 160;
179 google_ad_height = 600;
180 //-->
181 </script>
182 <script type="text/javascript"
183 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
184 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]185</div>
186
187<div class="main">
188
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]189<h1>Module paint
190 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]191<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>
192
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame]193<h2><a href="http://www.imagemagick.org/api/MagickCore/paint
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]194_8c.html" id="FloodfillPaintImage">FloodfillPaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]195<div class="doc-section">
196
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]197<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]198
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]199<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]200
201<p>The format of the FloodfillPaintImage method is:</p>
202
203<pre class="code">
204 MagickBooleanType FloodfillPaintImage(Image *image,
205 const ChannelType channel,const DrawInfo *draw_info,
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]206 const MagickPixelPacket target,const ssize_t x_offset,
207 const ssize_t y_offset,const MagickBooleanType invert)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]208</pre>
209
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]210<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]211
212<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]213<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]214
215<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]216<p>the channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]217
218<h5>draw_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]219<p>the draw info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]220
221<h5>target</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]222<p>the RGB value of the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]223
224<h5>x_offset,y_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]225<p>the starting location of the operation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]226
227<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]228<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]229
230 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame]231<h2><a href="http://www.imagemagick.org/api/MagickCore/paint
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]232_8c.html" id="OilPaintImage">OilPaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]233<div class="doc-section">
234
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]235<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]236
237<p>The format of the OilPaintImage method is:</p>
238
239<pre class="code">
240 Image *OilPaintImage(const Image *image,const double radius,
241 ExceptionInfo *exception)
242</pre>
243
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]244<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]245
246<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]247<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]248
249<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]250<p>the radius of the circular neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]251
252<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]253<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]254
255 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame]256<h2><a href="http://www.imagemagick.org/api/MagickCore/paint
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]257_8c.html" id="OpaquePaintImage">OpaquePaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]258<div class="doc-section">
259
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]260<p>OpaquePaintImage() changes any pixel that matches color with the color defined by fill.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]261
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]262<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]263
264<p>The format of the OpaquePaintImage method is:</p>
265
266<pre class="code">
267 MagickBooleanType OpaquePaintImage(Image *image,
268 const PixelPacket *target,const PixelPacket *fill,
269 const MagickBooleanType invert)
270 MagickBooleanType OpaquePaintImageChannel(Image *image,
271 const ChannelType channel,const PixelPacket *target,
272 const PixelPacket *fill,const MagickBooleanType invert)
273</pre>
274
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]275<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]276
277<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]278<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]279
280<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]281<p>the channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]282
283<h5>target</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]284<p>the RGB value of the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]285
286<h5>fill</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]287<p>the replacement color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]288
289<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]290<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]291
292 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame]293<h2><a href="http://www.imagemagick.org/api/MagickCore/paint
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]294_8c.html" id="TransparentPaintImage">TransparentPaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]295<div class="doc-section">
296
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]297<p>TransparentPaintImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]298
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]299<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]300
301<p>The format of the TransparentPaintImage method is:</p>
302
303<pre class="code">
304 MagickBooleanType TransparentPaintImage(Image *image,
305 const MagickPixelPacket *target,const Quantum opacity,
306 const MagickBooleanType invert)
307</pre>
308
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]309<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]310
311<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]312<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]313
314<h5>target</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]315<p>the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]316
317<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]318<p>the replacement opacity value.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]319
320<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]321<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]322
323 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame]324<h2><a href="http://www.imagemagick.org/api/MagickCore/paint
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]325_8c.html" id="TransparentPaintImageChroma">TransparentPaintImageChroma</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]326<div class="doc-section">
327
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]328<p>TransparentPaintImageChroma() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]329
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]330<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]331
332<p>The format of the TransparentPaintImage method is:</p>
333
334<pre class="code">
335 MagickBooleanType TransparentPaintImage(Image *image,
336 const MagickPixelPacket *low,const MagickPixelPacket *hight,
337 const Quantum opacity,const MagickBooleanType invert)
338</pre>
339
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]340<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]341
342<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]343<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]344
345<h5>low</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]346<p>the low target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]347
348<h5>high</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]349<p>the high target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]350
351<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]352<p>the replacement opacity value.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]353
354<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]355<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]356
357 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]358
359</div>
360
361<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]362 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]363 <span id="linkbar-center">
364 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]365 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]366 </span>
367 <span id="linkbar-east">&nbsp;</span>
368 </div>
369 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]370 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]371 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
372 </div>
373 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]374 <script type="text/javascript">
375 var _gaq = _gaq || [];
376 _gaq.push(['_setAccount', 'UA-17690367-1']);
377 _gaq.push(['_trackPageview']);
378
379 (function() {
380 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
381 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
382 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
383 })();
384 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]385</body>
386</html>