Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 178edafa2ddbc40465115383b13685f7bc913b1f / . / www / api / fx.html
blob: 55752efa789a0754aedad04df1bb7dceaa7e1861 [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: Add a Special Effect</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:, add, a, special, effect, 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=""
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame^]56 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]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">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame^]143<div class="sponsor">
144 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
145</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]146<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]147 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +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">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame^]156 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
157</div>
158<div class="sponsor">
cristye855cb32011-01-16 02:13:10 +0000[diff] [blame]159 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]160</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161</div>
162</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]163</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]164
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]165<div class="eastbar">
166 <script type="text/javascript">
167 <!--
168 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]169 google_ad_slot = "0574824969";
170 google_ad_width = 160;
171 google_ad_height = 600;
172 //-->
173 </script>
174 <script type="text/javascript"
175 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
176 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]177</div>
178
179<div class="main">
180
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]181<h1>Module fx
182 Methods</h1>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]183<p class="navigation-index">[<a href="#AddNoiseImage">AddNoiseImage</a> &bull; <a href="#BlueShiftImage">BlueShiftImage</a> &bull; <a href="#CharcoalImage">CharcoalImage</a> &bull; <a href="#ColorizeImage">ColorizeImage</a> &bull; <a href="#ColorMatrixImage">ColorMatrixImage</a> &bull; <a href="#FxImage">FxImage</a> &bull; <a href="#ImplodeImage">ImplodeImage</a> &bull; <a href="#The MorphImages">The MorphImages</a> &bull; <a href="#PlasmaImage">PlasmaImage</a> &bull; <a href="#PolaroidImage">PolaroidImage</a> &bull; <a href="#MagickSepiaToneImage">MagickSepiaToneImage</a> &bull; <a href="#ShadowImage">ShadowImage</a> &bull; <a href="#SketchImage">SketchImage</a> &bull; <a href="#SolarizeImage">SolarizeImage</a> &bull; <a href="#SteganoImage">SteganoImage</a> &bull; <a href="#StereoAnaglyphImage">StereoAnaglyphImage</a> &bull; <a href="#SwirlImage">SwirlImage</a> &bull; <a href="#TintImage">TintImage</a> &bull; <a href="#VignetteImage">VignetteImage</a> &bull; <a href="#WaveImage">WaveImage</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]184
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]185<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
186_8c.html" id="AddNoiseImage">AddNoiseImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]187<div class="doc-section">
188
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]189<p>AddNoiseImage() adds random noise to the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]190
191<p>The format of the AddNoiseImage method is:</p>
192
193<pre class="code">
194 Image *AddNoiseImage(const Image *image,const NoiseType noise_type,
195 ExceptionInfo *exception)
196 Image *AddNoiseImageChannel(const Image *image,const ChannelType channel,
197 const NoiseType noise_type,ExceptionInfo *exception)
198</pre>
199
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]200<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]201
202<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]203<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]204
205<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]206<p>the channel type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]207
208<h5>noise_type</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]209<p>The type of noise: Uniform, Gaussian, Multiplicative, Impulse, Laplacian, or Poisson.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]210
211<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]212<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]213
214 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]215<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
216_8c.html" id="BlueShiftImage">BlueShiftImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]217<div class="doc-section">
218
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]219<p>BlueShiftImage() mutes the colors of the image to simulate a scene at nighttime in the moonlight.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]220
221<p>The format of the BlueShiftImage method is:</p>
222
223<pre class="code">
224 Image *BlueShiftImage(const Image *image,const double factor,
225 ExceptionInfo *exception)
226</pre>
227
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]228<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]229
230<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]231<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]232
233<h5>factor</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]234<p>the shift factor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]235
236<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]237<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]238
239 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]240<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
241_8c.html" id="CharcoalImage">CharcoalImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]242<div class="doc-section">
243
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]244<p>CharcoalImage() creates a new image that is a copy of an existing one with the edge highlighted. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]245
246<p>The format of the CharcoalImage method is:</p>
247
248<pre class="code">
249 Image *CharcoalImage(const Image *image,const double radius,
250 const double sigma,ExceptionInfo *exception)
251</pre>
252
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]253<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]254
255<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]256<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]257
258<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]259<p>the radius of the pixel neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]260
261<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]262<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]263
264<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]265<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]266
267 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]268<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
269_8c.html" id="ColorizeImage">ColorizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]270<div class="doc-section">
271
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]272<p>ColorizeImage() blends the fill color with each pixel in the image. A percentage blend is specified with opacity. Control the application of different color components by specifying a different percentage for each component (e.g. 90/100/10 is 90 red, 100 green, and 10 blue).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]273
274<p>The format of the ColorizeImage method is:</p>
275
276<pre class="code">
277 Image *ColorizeImage(const Image *image,const char *opacity,
278 const PixelPacket colorize,ExceptionInfo *exception)
279</pre>
280
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]281<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]282
283<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]284<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]285
286<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]287<p>A character string indicating the level of opacity as a percentage.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]288
289<h5>colorize</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]290<p>A color value.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]291
292<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]293<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]294
295 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]296<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
297_8c.html" id="ColorMatrixImage">ColorMatrixImage</a></h2>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]298<div class="doc-section">
299
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]300<p>ColorMatrixImage() applies color transformation to an image. This method permits saturation changes, hue rotation, luminance to alpha, and various other effects. Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]301
302<p>The format of the ColorMatrixImage method is:</p>
303
304<pre class="code">
305 Image *ColorMatrixImage(const Image *image,
306 const KernelInfo *color_matrix,ExceptionInfo *exception)
307</pre>
308
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]309<p>A description of each parameter follows:</p>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]310
311<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]312<p>the image.</p>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]313
314<h5>color_matrix</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]315<p>the color matrix.</p>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]316
317<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]318<p>return any errors or warnings in this structure.</p>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]319
320 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]321<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
322_8c.html" id="FxImage">FxImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]323<div class="doc-section">
324
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]325<p>FxImage() applies a mathematical expression to the specified image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]326
327<p>The format of the FxImage method is:</p>
328
329<pre class="code">
330 Image *FxImage(const Image *image,const char *expression,
331 ExceptionInfo *exception)
332 Image *FxImageChannel(const Image *image,const ChannelType channel,
333 const char *expression,ExceptionInfo *exception)
334</pre>
335
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]336<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]337
338<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]339<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]340
341<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]342<p>the channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]343
344<h5>expression</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]345<p>A mathematical expression.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]346
347<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]348<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]349
350 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]351<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
352_8c.html" id="ImplodeImage">ImplodeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]353<div class="doc-section">
354
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]355<p>ImplodeImage() creates a new image that is a copy of an existing one with the image pixels "implode" by the specified percentage. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]356
357<p>The format of the ImplodeImage method is:</p>
358
359<pre class="code">
360 Image *ImplodeImage(const Image *image,const double amount,
361 ExceptionInfo *exception)
362</pre>
363
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]364<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]365
366<h5>implode_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]367<p>Method ImplodeImage returns a pointer to the image after it is implode. A null image is returned if there is a memory shortage.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]368
369<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]370<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]371
372<h5>amount</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]373<p>Define the extent of the implosion.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]374
375<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]376<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]377
378 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]379<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
380_8c.html" id="The_MorphImages">The MorphImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]381<div class="doc-section">
382
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]383<p>The MorphImages() method requires a minimum of two images. The first image is transformed into the second by a number of intervening images as specified by frames.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]384
385<p>The format of the MorphImage method is:</p>
386
387<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]388 Image *MorphImages(const Image *image,const size_t number_frames,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]389 ExceptionInfo *exception)
390</pre>
391
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]392<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]393
394<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]395<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]396
397<h5>number_frames</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]398<p>Define the number of in-between image to generate. The more in-between frames, the smoother the morph.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]399
400<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]401<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]402
403 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]404<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
405_8c.html" id="PlasmaImage">PlasmaImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]406<div class="doc-section">
407
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]408<p>PlasmaImage() initializes an image with plasma fractal values. The image must be initialized with a base color and the random number generator seeded before this method is called.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]409
410<p>The format of the PlasmaImage method is:</p>
411
412<pre class="code">
413 MagickBooleanType PlasmaImage(Image *image,const SegmentInfo *segment,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]414 size_t attenuate,size_t depth)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]415</pre>
416
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]417<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]418
419<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]420<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]421
422<h5>segment</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]423<p> Define the region to apply plasma fractals values.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]424
425<h5>attenuate</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]426<p>Define the plasma attenuation factor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]427
428<h5>depth</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]429<p>Limit the plasma recursion depth.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]430
431 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]432<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
433_8c.html" id="PolaroidImage">PolaroidImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]434<div class="doc-section">
435
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]436<p>PolaroidImage() simulates a Polaroid picture.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]437
438<p>The format of the AnnotateImage method is:</p>
439
440<pre class="code">
441 Image *PolaroidImage(const Image *image,const DrawInfo *draw_info,
442 const double angle,ExceptionInfo exception)
443</pre>
444
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]445<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]446
447<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]448<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]449
450<h5>draw_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]451<p>the draw info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]452
453<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]454<p>Apply the effect along this angle.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]455
456<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]457<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]458
459 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]460<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
461_8c.html" id="MagickSepiaToneImage">MagickSepiaToneImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]462<div class="doc-section">
463
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]464<p>MagickSepiaToneImage() applies a special effect to the image, similar to the effect achieved in a photo darkroom by sepia toning. Threshold ranges from 0 to QuantumRange and is a measure of the extent of the sepia toning. A threshold of 80 is a good starting point for a reasonable tone.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]465
466<p>The format of the SepiaToneImage method is:</p>
467
468<pre class="code">
469 Image *SepiaToneImage(const Image *image,const double threshold,
470 ExceptionInfo *exception)
471</pre>
472
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]473<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]474
475<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]476<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]477
478<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]479<p>the tone threshold.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]480
481<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]482<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]483
484 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]485<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
486_8c.html" id="ShadowImage">ShadowImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]487<div class="doc-section">
488
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]489<p>ShadowImage() simulates a shadow from the specified image and returns it.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]490
491<p>The format of the ShadowImage method is:</p>
492
493<pre class="code">
494 Image *ShadowImage(const Image *image,const double opacity,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]495 const double sigma,const ssize_t x_offset,const ssize_t y_offset,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]496 ExceptionInfo *exception)
497</pre>
498
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]499<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]500
501<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]502<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]503
504<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]505<p>percentage transparency.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]506
507<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]508<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]509
510<h5>x_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]511<p>the shadow x-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]512
513<h5>y_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]514<p>the shadow y-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]515
516<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]517<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]518
519 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]520<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
521_8c.html" id="SketchImage">SketchImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]522<div class="doc-section">
523
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]524<p>SketchImage() simulates a pencil sketch. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and SketchImage() selects a suitable radius for you. Angle gives the angle of the sketch.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]525
526<p>The format of the SketchImage method is:</p>
527
528<pre class="code">
529 Image *SketchImage(const Image *image,const double radius,
530 const double sigma,const double angle,ExceptionInfo *exception)
531</pre>
532
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]533<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]534
535<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]536<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]537
538<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]539<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]540
541<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]542<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]543
544<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]545<p>Apply the effect along this angle.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]546
547<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]548<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]549
550 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]551<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
552_8c.html" id="SolarizeImage">SolarizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]553<div class="doc-section">
554
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]555<p>SolarizeImage() applies a special effect to the image, similar to the effect achieved in a photo darkroom by selectively exposing areas of photo sensitive paper to light. Threshold ranges from 0 to QuantumRange and is a measure of the extent of the solarization.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]556
557<p>The format of the SolarizeImage method is:</p>
558
559<pre class="code">
560 MagickBooleanType SolarizeImage(Image *image,const double threshold)
561</pre>
562
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]563<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]564
565<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]566<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]567
568<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]569<p>Define the extent of the solarization.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]570
571 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]572<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
573_8c.html" id="SteganoImage">SteganoImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]574<div class="doc-section">
575
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]576<p>SteganoImage() hides a digital watermark within the image. Recover the hidden watermark later to prove that the authenticity of an image. Offset defines the start position within the image to hide the watermark.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]577
578<p>The format of the SteganoImage method is:</p>
579
580<pre class="code">
581 Image *SteganoImage(const Image *image,Image *watermark,
582 ExceptionInfo *exception)
583</pre>
584
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]585<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]586
587<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]588<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]589
590<h5>watermark</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]591<p>the watermark image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]592
593<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]594<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]595
596 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]597<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
598_8c.html" id="StereoAnaglyphImage">StereoAnaglyphImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]599<div class="doc-section">
600
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]601<p>StereoAnaglyphImage() combines two images and produces a single image that is the composite of a left and right image of a stereo pair. Special red-green stereo glasses are required to view this effect.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]602
603<p>The format of the StereoAnaglyphImage method is:</p>
604
605<pre class="code">
606 Image *StereoImage(const Image *left_image,const Image *right_image,
607 ExceptionInfo *exception)
608 Image *StereoAnaglyphImage(const Image *left_image,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]609 const Image *right_image,const ssize_t x_offset,const ssize_t y_offset,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]610 ExceptionInfo *exception)
611</pre>
612
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]613<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]614
615<h5>left_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]616<p>the left image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]617
618<h5>right_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]619<p>the right image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]620
621<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]622<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]623
624<h5>x_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]625<p>amount, in pixels, by which the left image is offset to the right of the right image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]626
627<h5>y_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]628<p>amount, in pixels, by which the left image is offset to the bottom of the right image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]629
630
631 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]632<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
633_8c.html" id="SwirlImage">SwirlImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]634<div class="doc-section">
635
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]636<p>SwirlImage() swirls the pixels about the center of the image, where degrees indicates the sweep of the arc through which each pixel is moved. You get a more dramatic effect as the degrees move from 1 to 360.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]637
638<p>The format of the SwirlImage method is:</p>
639
640<pre class="code">
641 Image *SwirlImage(const Image *image,double degrees,
642 ExceptionInfo *exception)
643</pre>
644
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]645<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]646
647<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]648<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]649
650<h5>degrees</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]651<p>Define the tightness of the swirling effect.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]652
653<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]654<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]655
656 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]657<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
658_8c.html" id="TintImage">TintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]659<div class="doc-section">
660
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]661<p>TintImage() applies a color vector to each pixel in the image. The length of the vector is 0 for black and white and at its maximum for the midtones. The vector weighting function is f(x)=(1-(4.0*((x-0.5)*(x-0.5))))</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]662
663<p>The format of the TintImage method is:</p>
664
665<pre class="code">
666 Image *TintImage(const Image *image,const char *opacity,
667 const PixelPacket tint,ExceptionInfo *exception)
668</pre>
669
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]670<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]671
672<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]673<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]674
675<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]676<p>A color value used for tinting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]677
678<h5>tint</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]679<p>A color value used for tinting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]680
681<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]682<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]683
684 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]685<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
686_8c.html" id="VignetteImage">VignetteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]687<div class="doc-section">
688
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]689<p>VignetteImage() softens the edges of the image in vignette style.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]690
691<p>The format of the VignetteImage method is:</p>
692
693<pre class="code">
694 Image *VignetteImage(const Image *image,const double radius,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]695 const double sigma,const ssize_t x,const ssize_t y,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]696</pre>
697
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]698<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]699
700<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]701<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]702
703<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]704<p>the radius of the pixel neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]705
706<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]707<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]708
709<h5>x, y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]710<p>Define the x and y ellipse offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]711
712<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]713<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]714
715 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]716<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
717_8c.html" id="WaveImage">WaveImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]718<div class="doc-section">
719
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]720<p>WaveImage() creates a "ripple" effect in the image by shifting the pixels vertically along a sine wave whose amplitude and wavelength is specified by the given parameters.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]721
722<p>The format of the WaveImage method is:</p>
723
724<pre class="code">
725 Image *WaveImage(const Image *image,const double amplitude,
726 const double wave_length,ExceptionInfo *exception)
727</pre>
728
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]729<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]730
731<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]732<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]733
734<h5>amplitude, wave_length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]735<p>Define the amplitude and wave length of the sine wave.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]736
737<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]738<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]739
740 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]741
742</div>
743
744<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]745 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]746 <span id="linkbar-center">
747 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]748 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]749 </span>
750 <span id="linkbar-east">&nbsp;</span>
751 </div>
752 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]753 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]754 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
755 </div>
756 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]757 <script type="text/javascript">
758 var _gaq = _gaq || [];
759 _gaq.push(['_setAccount', 'UA-17690367-1']);
760 _gaq.push(['_trackPageview']);
761
762 (function() {
763 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
764 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
765 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
766 })();
767 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]768</body>
769</html>