blob: b1483a2e4dae023632928a1beea0c41774df6bc2 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +00001<!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 +00004<head>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +00007 <title>ImageMagick: MagickCore, C API for ImageMagick: Add a Special Effect</title>
cristy3ed852e2009-09-05 21:47:34 +00008 <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 +000011 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +000012 <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 +000013 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000014 <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 +000016 <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 +000022 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000023 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000024 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000025 <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 +000027 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000028 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +000031 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000032 <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 +000044</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 +000053 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000054<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +000055 <img src="../../images/logo.jpg"
56 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +000057 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000058<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +000059 <img src="../../images/sprite.jpg"
60 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +000061 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
62</div>
63
cristyce69bb02010-07-27 19:49:46 +000064<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000065
cristy3ed852e2009-09-05 21:47:34 +000066<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000067 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000068</div>
cristy3eaa0ef2010-03-06 20:35:26 +000069<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000070<div class="menu">
cristybb503372010-05-27 20:51:26 +000071 <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 +000084 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000085</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000087 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000088</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000090 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000091</div>
92<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
104<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
107<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000108 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
114<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
117<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000118 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000119 </div>
120<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000121 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000122</div>
cristybb503372010-05-27 20:51:26 +0000123<div class="menu">
124 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
125</div>
cristy3ed852e2009-09-05 21:47:34 +0000126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000127 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000128</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000129<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000130<div class="menu">
cristy52923442011-01-15 22:54:31 +0000131 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000132</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000133<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000134<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000135 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000136</div>
137<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000138 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000139</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000140<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000141<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000143
144<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000145<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000146 <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 +0000152 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
153</div>
cristyec6b4752011-01-08 03:16:23 +0000154<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000155 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000156</div>
157<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000158 <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 +0000161 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
162</div>
cristyec6b4752011-01-08 03:16:23 +0000163<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000164 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
165</div>
166<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000167 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011050100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000168</div>
cristy3ed852e2009-09-05 21:47:34 +0000169</div>
170</div>
cristyce69bb02010-07-27 19:49:46 +0000171</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000172
cristyce69bb02010-07-27 19:49:46 +0000173<div class="eastbar">
174 <script type="text/javascript">
175 <!--
176 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000177 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 +0000185</div>
186
187<div class="main">
188
cristy307ba182010-12-25 01:00:34 +0000189<h1>Module fx
190 Methods</h1>
cristy0291e2d2010-04-04 17:50:18 +0000191<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 +0000192
cristy7a40ba82011-01-08 20:31:18 +0000193<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
194_8c.html" id="AddNoiseImage">AddNoiseImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000195<div class="doc-section">
196
cristy7a40ba82011-01-08 20:31:18 +0000197<p>AddNoiseImage() adds random noise to the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000198
199<p>The format of the AddNoiseImage method is:</p>
200
201<pre class="code">
202 Image *AddNoiseImage(const Image *image,const NoiseType noise_type,
203 ExceptionInfo *exception)
204 Image *AddNoiseImageChannel(const Image *image,const ChannelType channel,
205 const NoiseType noise_type,ExceptionInfo *exception)
206</pre>
207
cristy7a40ba82011-01-08 20:31:18 +0000208<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000209
210<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000211<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000212
213<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000214<p>the channel type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000215
216<h5>noise_type</h5>
cristy7a40ba82011-01-08 20:31:18 +0000217<p>The type of noise: Uniform, Gaussian, Multiplicative, Impulse, Laplacian, or Poisson.</p>
cristy3ed852e2009-09-05 21:47:34 +0000218
219<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000220<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000221
222 </div>
cristy7a40ba82011-01-08 20:31:18 +0000223<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
224_8c.html" id="BlueShiftImage">BlueShiftImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000225<div class="doc-section">
226
cristy7a40ba82011-01-08 20:31:18 +0000227<p>BlueShiftImage() mutes the colors of the image to simulate a scene at nighttime in the moonlight.</p>
cristy3ed852e2009-09-05 21:47:34 +0000228
229<p>The format of the BlueShiftImage method is:</p>
230
231<pre class="code">
232 Image *BlueShiftImage(const Image *image,const double factor,
233 ExceptionInfo *exception)
234</pre>
235
cristy7a40ba82011-01-08 20:31:18 +0000236<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000237
238<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000239<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000240
241<h5>factor</h5>
cristy7a40ba82011-01-08 20:31:18 +0000242<p>the shift factor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000243
244<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000245<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000246
247 </div>
cristy7a40ba82011-01-08 20:31:18 +0000248<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
249_8c.html" id="CharcoalImage">CharcoalImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000250<div class="doc-section">
251
cristy7a40ba82011-01-08 20:31:18 +0000252<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 +0000253
254<p>The format of the CharcoalImage method is:</p>
255
256<pre class="code">
257 Image *CharcoalImage(const Image *image,const double radius,
258 const double sigma,ExceptionInfo *exception)
259</pre>
260
cristy7a40ba82011-01-08 20:31:18 +0000261<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000262
263<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000264<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000265
266<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000267<p>the radius of the pixel neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000268
269<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000270<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000271
272<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000273<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000274
275 </div>
cristy7a40ba82011-01-08 20:31:18 +0000276<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
277_8c.html" id="ColorizeImage">ColorizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000278<div class="doc-section">
279
cristy7a40ba82011-01-08 20:31:18 +0000280<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 +0000281
282<p>The format of the ColorizeImage method is:</p>
283
284<pre class="code">
285 Image *ColorizeImage(const Image *image,const char *opacity,
286 const PixelPacket colorize,ExceptionInfo *exception)
287</pre>
288
cristy7a40ba82011-01-08 20:31:18 +0000289<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000290
291<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000292<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000293
294<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000295<p>A character string indicating the level of opacity as a percentage.</p>
cristy3ed852e2009-09-05 21:47:34 +0000296
297<h5>colorize</h5>
cristy7a40ba82011-01-08 20:31:18 +0000298<p>A color value.</p>
cristy3ed852e2009-09-05 21:47:34 +0000299
300<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000301<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000302
303 </div>
cristy7a40ba82011-01-08 20:31:18 +0000304<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
305_8c.html" id="ColorMatrixImage">ColorMatrixImage</a></h2>
cristy0291e2d2010-04-04 17:50:18 +0000306<div class="doc-section">
307
cristy7a40ba82011-01-08 20:31:18 +0000308<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 +0000309
310<p>The format of the ColorMatrixImage method is:</p>
311
312<pre class="code">
313 Image *ColorMatrixImage(const Image *image,
314 const KernelInfo *color_matrix,ExceptionInfo *exception)
315</pre>
316
cristy7a40ba82011-01-08 20:31:18 +0000317<p>A description of each parameter follows:</p>
cristy0291e2d2010-04-04 17:50:18 +0000318
319<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000320<p>the image.</p>
cristy0291e2d2010-04-04 17:50:18 +0000321
322<h5>color_matrix</h5>
cristy7a40ba82011-01-08 20:31:18 +0000323<p>the color matrix.</p>
cristy0291e2d2010-04-04 17:50:18 +0000324
325<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000326<p>return any errors or warnings in this structure.</p>
cristy0291e2d2010-04-04 17:50:18 +0000327
328 </div>
cristy7a40ba82011-01-08 20:31:18 +0000329<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
330_8c.html" id="FxImage">FxImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000331<div class="doc-section">
332
cristy7a40ba82011-01-08 20:31:18 +0000333<p>FxImage() applies a mathematical expression to the specified image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000334
335<p>The format of the FxImage method is:</p>
336
337<pre class="code">
338 Image *FxImage(const Image *image,const char *expression,
339 ExceptionInfo *exception)
340 Image *FxImageChannel(const Image *image,const ChannelType channel,
341 const char *expression,ExceptionInfo *exception)
342</pre>
343
cristy7a40ba82011-01-08 20:31:18 +0000344<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000345
346<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000347<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000348
349<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000350<p>the channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000351
352<h5>expression</h5>
cristy7a40ba82011-01-08 20:31:18 +0000353<p>A mathematical expression.</p>
cristy3ed852e2009-09-05 21:47:34 +0000354
355<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000356<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000357
358 </div>
cristy7a40ba82011-01-08 20:31:18 +0000359<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
360_8c.html" id="ImplodeImage">ImplodeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000361<div class="doc-section">
362
cristy7a40ba82011-01-08 20:31:18 +0000363<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 +0000364
365<p>The format of the ImplodeImage method is:</p>
366
367<pre class="code">
368 Image *ImplodeImage(const Image *image,const double amount,
369 ExceptionInfo *exception)
370</pre>
371
cristy7a40ba82011-01-08 20:31:18 +0000372<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000373
374<h5>implode_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000375<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 +0000376
377<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000378<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000379
380<h5>amount</h5>
cristy7a40ba82011-01-08 20:31:18 +0000381<p>Define the extent of the implosion.</p>
cristy3ed852e2009-09-05 21:47:34 +0000382
383<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000384<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000385
386 </div>
cristy7a40ba82011-01-08 20:31:18 +0000387<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
388_8c.html" id="The_MorphImages">The MorphImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000389<div class="doc-section">
390
cristy7a40ba82011-01-08 20:31:18 +0000391<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 +0000392
393<p>The format of the MorphImage method is:</p>
394
395<pre class="code">
cristybb503372010-05-27 20:51:26 +0000396 Image *MorphImages(const Image *image,const size_t number_frames,
cristy3ed852e2009-09-05 21:47:34 +0000397 ExceptionInfo *exception)
398</pre>
399
cristy7a40ba82011-01-08 20:31:18 +0000400<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000401
402<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000403<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000404
405<h5>number_frames</h5>
cristy7a40ba82011-01-08 20:31:18 +0000406<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 +0000407
408<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000409<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000410
411 </div>
cristy7a40ba82011-01-08 20:31:18 +0000412<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
413_8c.html" id="PlasmaImage">PlasmaImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000414<div class="doc-section">
415
cristy7a40ba82011-01-08 20:31:18 +0000416<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 +0000417
418<p>The format of the PlasmaImage method is:</p>
419
420<pre class="code">
421 MagickBooleanType PlasmaImage(Image *image,const SegmentInfo *segment,
cristybb503372010-05-27 20:51:26 +0000422 size_t attenuate,size_t depth)
cristy3ed852e2009-09-05 21:47:34 +0000423</pre>
424
cristy7a40ba82011-01-08 20:31:18 +0000425<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000426
427<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000428<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000429
430<h5>segment</h5>
cristy7a40ba82011-01-08 20:31:18 +0000431<p> Define the region to apply plasma fractals values.</p>
cristy3ed852e2009-09-05 21:47:34 +0000432
433<h5>attenuate</h5>
cristy7a40ba82011-01-08 20:31:18 +0000434<p>Define the plasma attenuation factor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000435
436<h5>depth</h5>
cristy7a40ba82011-01-08 20:31:18 +0000437<p>Limit the plasma recursion depth.</p>
cristy3ed852e2009-09-05 21:47:34 +0000438
439 </div>
cristy7a40ba82011-01-08 20:31:18 +0000440<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
441_8c.html" id="PolaroidImage">PolaroidImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000442<div class="doc-section">
443
cristy7a40ba82011-01-08 20:31:18 +0000444<p>PolaroidImage() simulates a Polaroid picture.</p>
cristy3ed852e2009-09-05 21:47:34 +0000445
446<p>The format of the AnnotateImage method is:</p>
447
448<pre class="code">
449 Image *PolaroidImage(const Image *image,const DrawInfo *draw_info,
450 const double angle,ExceptionInfo exception)
451</pre>
452
cristy7a40ba82011-01-08 20:31:18 +0000453<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000454
455<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000456<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000457
458<h5>draw_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000459<p>the draw info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000460
461<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000462<p>Apply the effect along this angle.</p>
cristy3ed852e2009-09-05 21:47:34 +0000463
464<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000465<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000466
467 </div>
cristy7a40ba82011-01-08 20:31:18 +0000468<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
469_8c.html" id="MagickSepiaToneImage">MagickSepiaToneImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000470<div class="doc-section">
471
cristy7a40ba82011-01-08 20:31:18 +0000472<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 +0000473
474<p>The format of the SepiaToneImage method is:</p>
475
476<pre class="code">
477 Image *SepiaToneImage(const Image *image,const double threshold,
478 ExceptionInfo *exception)
479</pre>
480
cristy7a40ba82011-01-08 20:31:18 +0000481<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000482
483<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000484<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000485
486<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000487<p>the tone threshold.</p>
cristy3ed852e2009-09-05 21:47:34 +0000488
489<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000490<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000491
492 </div>
cristy7a40ba82011-01-08 20:31:18 +0000493<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
494_8c.html" id="ShadowImage">ShadowImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000495<div class="doc-section">
496
cristy7a40ba82011-01-08 20:31:18 +0000497<p>ShadowImage() simulates a shadow from the specified image and returns it.</p>
cristy3ed852e2009-09-05 21:47:34 +0000498
499<p>The format of the ShadowImage method is:</p>
500
501<pre class="code">
502 Image *ShadowImage(const Image *image,const double opacity,
cristybb503372010-05-27 20:51:26 +0000503 const double sigma,const ssize_t x_offset,const ssize_t y_offset,
cristy3ed852e2009-09-05 21:47:34 +0000504 ExceptionInfo *exception)
505</pre>
506
cristy7a40ba82011-01-08 20:31:18 +0000507<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000508
509<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000510<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000511
512<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000513<p>percentage transparency.</p>
cristy3ed852e2009-09-05 21:47:34 +0000514
515<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000516<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000517
518<h5>x_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000519<p>the shadow x-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000520
521<h5>y_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000522<p>the shadow y-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000523
524<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000525<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000526
527 </div>
cristy7a40ba82011-01-08 20:31:18 +0000528<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
529_8c.html" id="SketchImage">SketchImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000530<div class="doc-section">
531
cristy7a40ba82011-01-08 20:31:18 +0000532<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 +0000533
534<p>The format of the SketchImage method is:</p>
535
536<pre class="code">
537 Image *SketchImage(const Image *image,const double radius,
538 const double sigma,const double angle,ExceptionInfo *exception)
539</pre>
540
cristy7a40ba82011-01-08 20:31:18 +0000541<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000542
543<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000544<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000545
546<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000547<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000548
549<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000550<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000551
552<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000553<p>Apply the effect along this angle.</p>
cristy3ed852e2009-09-05 21:47:34 +0000554
555<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000556<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000557
558 </div>
cristy7a40ba82011-01-08 20:31:18 +0000559<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
560_8c.html" id="SolarizeImage">SolarizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000561<div class="doc-section">
562
cristy7a40ba82011-01-08 20:31:18 +0000563<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 +0000564
565<p>The format of the SolarizeImage method is:</p>
566
567<pre class="code">
568 MagickBooleanType SolarizeImage(Image *image,const double threshold)
569</pre>
570
cristy7a40ba82011-01-08 20:31:18 +0000571<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000572
573<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000574<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000575
576<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000577<p>Define the extent of the solarization.</p>
cristy3ed852e2009-09-05 21:47:34 +0000578
579 </div>
cristy7a40ba82011-01-08 20:31:18 +0000580<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
581_8c.html" id="SteganoImage">SteganoImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000582<div class="doc-section">
583
cristy7a40ba82011-01-08 20:31:18 +0000584<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 +0000585
586<p>The format of the SteganoImage method is:</p>
587
588<pre class="code">
589 Image *SteganoImage(const Image *image,Image *watermark,
590 ExceptionInfo *exception)
591</pre>
592
cristy7a40ba82011-01-08 20:31:18 +0000593<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000594
595<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000596<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000597
598<h5>watermark</h5>
cristy7a40ba82011-01-08 20:31:18 +0000599<p>the watermark image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000600
601<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000602<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000603
604 </div>
cristy7a40ba82011-01-08 20:31:18 +0000605<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
606_8c.html" id="StereoAnaglyphImage">StereoAnaglyphImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000607<div class="doc-section">
608
cristy7a40ba82011-01-08 20:31:18 +0000609<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 +0000610
611<p>The format of the StereoAnaglyphImage method is:</p>
612
613<pre class="code">
614 Image *StereoImage(const Image *left_image,const Image *right_image,
615 ExceptionInfo *exception)
616 Image *StereoAnaglyphImage(const Image *left_image,
cristybb503372010-05-27 20:51:26 +0000617 const Image *right_image,const ssize_t x_offset,const ssize_t y_offset,
cristy3ed852e2009-09-05 21:47:34 +0000618 ExceptionInfo *exception)
619</pre>
620
cristy7a40ba82011-01-08 20:31:18 +0000621<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000622
623<h5>left_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000624<p>the left image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000625
626<h5>right_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000627<p>the right image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000628
629<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000630<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000631
632<h5>x_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000633<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 +0000634
635<h5>y_offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000636<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 +0000637
638
639 </div>
cristy7a40ba82011-01-08 20:31:18 +0000640<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
641_8c.html" id="SwirlImage">SwirlImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000642<div class="doc-section">
643
cristy7a40ba82011-01-08 20:31:18 +0000644<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 +0000645
646<p>The format of the SwirlImage method is:</p>
647
648<pre class="code">
649 Image *SwirlImage(const Image *image,double degrees,
650 ExceptionInfo *exception)
651</pre>
652
cristy7a40ba82011-01-08 20:31:18 +0000653<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000654
655<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000656<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000657
658<h5>degrees</h5>
cristy7a40ba82011-01-08 20:31:18 +0000659<p>Define the tightness of the swirling effect.</p>
cristy3ed852e2009-09-05 21:47:34 +0000660
661<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000662<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000663
664 </div>
cristy7a40ba82011-01-08 20:31:18 +0000665<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
666_8c.html" id="TintImage">TintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000667<div class="doc-section">
668
cristy7a40ba82011-01-08 20:31:18 +0000669<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 +0000670
671<p>The format of the TintImage method is:</p>
672
673<pre class="code">
674 Image *TintImage(const Image *image,const char *opacity,
675 const PixelPacket tint,ExceptionInfo *exception)
676</pre>
677
cristy7a40ba82011-01-08 20:31:18 +0000678<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000679
680<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000681<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000682
683<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000684<p>A color value used for tinting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000685
686<h5>tint</h5>
cristy7a40ba82011-01-08 20:31:18 +0000687<p>A color value used for tinting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000688
689<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000690<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000691
692 </div>
cristy7a40ba82011-01-08 20:31:18 +0000693<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
694_8c.html" id="VignetteImage">VignetteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000695<div class="doc-section">
696
cristy7a40ba82011-01-08 20:31:18 +0000697<p>VignetteImage() softens the edges of the image in vignette style.</p>
cristy3ed852e2009-09-05 21:47:34 +0000698
699<p>The format of the VignetteImage method is:</p>
700
701<pre class="code">
702 Image *VignetteImage(const Image *image,const double radius,
cristybb503372010-05-27 20:51:26 +0000703 const double sigma,const ssize_t x,const ssize_t y,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000704</pre>
705
cristy7a40ba82011-01-08 20:31:18 +0000706<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000707
708<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000709<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000710
711<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000712<p>the radius of the pixel neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000713
714<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000715<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000716
717<h5>x, y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000718<p>Define the x and y ellipse offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000719
720<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000721<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000722
723 </div>
cristy7a40ba82011-01-08 20:31:18 +0000724<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/fx
725_8c.html" id="WaveImage">WaveImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000726<div class="doc-section">
727
cristy7a40ba82011-01-08 20:31:18 +0000728<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 +0000729
730<p>The format of the WaveImage method is:</p>
731
732<pre class="code">
733 Image *WaveImage(const Image *image,const double amplitude,
734 const double wave_length,ExceptionInfo *exception)
735</pre>
736
cristy7a40ba82011-01-08 20:31:18 +0000737<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000738
739<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000740<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000741
742<h5>amplitude, wave_length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000743<p>Define the amplitude and wave length of the sine wave.</p>
cristy3ed852e2009-09-05 21:47:34 +0000744
745<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000746<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000747
748 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000749
750</div>
751
752<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000753 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000754 <span id="linkbar-center">
755 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000756 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000757 </span>
758 <span id="linkbar-east">&nbsp;</span>
759 </div>
760 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000761 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000762 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
763 </div>
764 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000765 <script type="text/javascript">
766 var _gaq = _gaq || [];
767 _gaq.push(['_setAccount', 'UA-17690367-1']);
768 _gaq.push(['_trackPageview']);
769
770 (function() {
771 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
772 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
773 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
774 })();
775 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000776</body>
777</html>