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