Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 5292344af862c8d10e50c4e9300a591aad3acae5 / . / www / api / paint.html
blob: 97529b7a904049305f709131dbf7e9c1d435afd3 [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"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, 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/">
55 <img src="../../images/logo.jpg" alt=""
56 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
57<a href="../../index.html">
58 <img src="../../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]62<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]63
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]67<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]69 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]82 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]83</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]85 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]86</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]88 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]89</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]106 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]121<div class="menu">
122 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame^]129 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]133 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]136 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]140 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141
142<div class="sponsbox">
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]143<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame^]144 <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]145</div>
146<div class="sponsor">
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]147 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]155<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame^]156 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]157</div>
cristyb15553d2010-07-03 22:53:14 +0000[diff] [blame]158</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]159</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]160</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]161
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]162<div class="eastbar">
163 <script type="text/javascript">
164 <!--
165 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]166 google_ad_slot = "0574824969";
167 google_ad_width = 160;
168 google_ad_height = 600;
169 //-->
170 </script>
171 <script type="text/javascript"
172 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
173 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]174</div>
175
176<div class="main">
177
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]178<h1>Module paint
179 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]180<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>
181
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]182<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/paint
183_8c.html" id="FloodfillPaintImage">FloodfillPaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]184<div class="doc-section">
185
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]186<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]187
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]188<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]189
190<p>The format of the FloodfillPaintImage method is:</p>
191
192<pre class="code">
193 MagickBooleanType FloodfillPaintImage(Image *image,
194 const ChannelType channel,const DrawInfo *draw_info,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]195 const MagickPixelPacket target,const ssize_t x_offset,const ssize_t y_offset,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]196 const MagickBooleanType invert)
197</pre>
198
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]199<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]200
201<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]202<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]203
204<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]205<p>the channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]206
207<h5>draw_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]208<p>the draw info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]209
210<h5>target</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]211<p>the RGB value of the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]212
213<h5>x_offset,y_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]214<p>the starting location of the operation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]215
216<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]217<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]218
219 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]220<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/paint
221_8c.html" id="OilPaintImage">OilPaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]222<div class="doc-section">
223
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]224<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]225
226<p>The format of the OilPaintImage method is:</p>
227
228<pre class="code">
229 Image *OilPaintImage(const Image *image,const double radius,
230 ExceptionInfo *exception)
231</pre>
232
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]233<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]234
235<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]236<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]237
238<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]239<p>the radius of the circular neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]240
241<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]242<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]243
244 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]245<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/paint
246_8c.html" id="OpaquePaintImage">OpaquePaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]247<div class="doc-section">
248
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]249<p>OpaquePaintImage() changes any pixel that matches color with the color defined by fill.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]250
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]251<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]252
253<p>The format of the OpaquePaintImage method is:</p>
254
255<pre class="code">
256 MagickBooleanType OpaquePaintImage(Image *image,
257 const PixelPacket *target,const PixelPacket *fill,
258 const MagickBooleanType invert)
259 MagickBooleanType OpaquePaintImageChannel(Image *image,
260 const ChannelType channel,const PixelPacket *target,
261 const PixelPacket *fill,const MagickBooleanType invert)
262</pre>
263
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]264<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]265
266<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]267<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]268
269<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]270<p>the channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]271
272<h5>target</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]273<p>the RGB value of the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]274
275<h5>fill</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]276<p>the replacement color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]277
278<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]279<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]280
281 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]282<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/paint
283_8c.html" id="TransparentPaintImage">TransparentPaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]284<div class="doc-section">
285
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]286<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]287
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]288<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]289
290<p>The format of the TransparentPaintImage method is:</p>
291
292<pre class="code">
293 MagickBooleanType TransparentPaintImage(Image *image,
294 const MagickPixelPacket *target,const Quantum opacity,
295 const MagickBooleanType invert)
296</pre>
297
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]298<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]299
300<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]301<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]302
303<h5>target</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]304<p>the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]305
306<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]307<p>the replacement opacity value.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]308
309<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]310<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]311
312 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]313<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/paint
314_8c.html" id="TransparentPaintImageChroma">TransparentPaintImageChroma</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]315<div class="doc-section">
316
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]317<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]318
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]319<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]320
321<p>The format of the TransparentPaintImage method is:</p>
322
323<pre class="code">
324 MagickBooleanType TransparentPaintImage(Image *image,
325 const MagickPixelPacket *low,const MagickPixelPacket *hight,
326 const Quantum opacity,const MagickBooleanType invert)
327</pre>
328
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]329<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]330
331<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]332<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]333
334<h5>low</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]335<p>the low target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]336
337<h5>high</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]338<p>the high target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]339
340<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]341<p>the replacement opacity value.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]342
343<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]344<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]345
346 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]347
348</div>
349
350<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]351 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]352 <span id="linkbar-center">
353 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]354 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]355 </span>
356 <span id="linkbar-east">&nbsp;</span>
357 </div>
358 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]359 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]360 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
361 </div>
362 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]363 <script type="text/javascript">
364 var _gaq = _gaq || [];
365 _gaq.push(['_setAccount', 'UA-17690367-1']);
366 _gaq.push(['_trackPageview']);
367
368 (function() {
369 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
370 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
371 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
372 })();
373 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]374</body>
375</html>