blob: 33785199c9d51ae82f298360cb52c9b8f6f017cb [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">
cristy2bd2a982011-02-15 00:52:58 +00003<html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy3eaa0ef2010-03-06 20:35:26 +00008<head>
cristy3c98a4f2010-08-13 20:09:41 +00009 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +000011 <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Image Layers</title>
cristy3ed852e2009-09-05 21:47:34 +000012 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000015 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +000016 <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 +000017 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000018 <meta name="Generator" content="PHP"/>
19 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, dealing, with, image, layers, 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 +000020 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +000026 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000027 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000028 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000029 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +000031 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000032 <style type="text/css" media="all">
33 @import url("../../www/magick.css");
34 </style>
cristydcca3fa2010-12-29 21:50:07 +000035 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000036 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
38 <script type="text/javascript">
39 $(document).ready(function() {
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
41 'transitionIn' : 'elastic',
42 'transitionOut' : 'elastic',
43 'overlayShow' : false,
44 'opacity' : true
45 });
46 });
47 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000048</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
52<a href="../../index.html">
53 <img src="../../images/script.png" alt="[ImageMagick]"
54 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
55<a href="http://www.networkredux.com">
56 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +000057 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000058<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +000059 <img src="../../images/logo.jpg"
60 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +000061 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000062<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +000063 <img src="../../images/sprite.jpg"
64 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +000065 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
66</div>
67
cristyce69bb02010-07-27 19:49:46 +000068<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000069
cristy3ed852e2009-09-05 21:47:34 +000070<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000072</div>
cristy3eaa0ef2010-03-06 20:35:26 +000073<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000074<div class="menu">
cristybb503372010-05-27 20:51:26 +000075 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
79</div>
80<div class="sub">
81 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
82</div>
83<div class="sub">
cristyda16f162011-02-19 23:52:17 +000084 <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
85</div>
86<div class="sub">
cristybb503372010-05-27 20:51:26 +000087 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
88</div>
89<div class="sep"></div>
90<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000091 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000092</div>
93<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000094 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000095</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000098</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000106 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
108<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000109 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
111<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
114<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000115 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000122 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000123</div>
124<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000125 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000126 </div>
127<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000128 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000129</div>
cristybb503372010-05-27 20:51:26 +0000130<div class="menu">
131 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
132</div>
cristy3ed852e2009-09-05 21:47:34 +0000133<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000134 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000135</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000136<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000137<div class="menu">
cristy52923442011-01-15 22:54:31 +0000138 <a title="Search" href="../../www/search.html">Search</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">
cristyffb69ed2010-12-25 00:06:48 +0000142 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000143</div>
144<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000145 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000148<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000149 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000150
151<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000152<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000153 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
154</div>
155<div class="sponsor">
156 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
157</div>
158<div class="sponsor">
cristy2bd2a982011-02-15 00:52:58 +0000159 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
cristy178edaf2011-01-23 03:42:39 +0000160</div>
cristyec6b4752011-01-08 03:16:23 +0000161<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000162 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000163</div>
164<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000165 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
166</div>
167<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000168 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
169</div>
cristyec6b4752011-01-08 03:16:23 +0000170<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000171 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
172</div>
173<div class="sponsor">
cristyda16f162011-02-19 23:52:17 +0000174 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011050100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000175</div>
cristy3ed852e2009-09-05 21:47:34 +0000176</div>
177</div>
cristyce69bb02010-07-27 19:49:46 +0000178</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000179
cristyce69bb02010-07-27 19:49:46 +0000180<div class="eastbar">
181 <script type="text/javascript">
182 <!--
183 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000184 google_ad_slot = "0574824969";
185 google_ad_width = 160;
186 google_ad_height = 600;
187 //-->
188 </script>
189 <script type="text/javascript"
190 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
191 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000192</div>
193
194<div class="main">
195
cristy350dea42011-02-15 17:31:04 +0000196<h1>Module layer Methods</h1>
cristy6f77f692011-02-15 15:31:39 +0000197<p class="navigation-index">[<a href="#CoalesceImages">CoalesceImages</a> &bull; <a href="#DisposeImages">DisposeImages</a> &bull; <a href="#CompareImageLayers">CompareImageLayers</a> &bull; <a href="#DeconstructImages">DeconstructImages</a> &bull; <a href="#OptimizeImageLayers">OptimizeImageLayers</a> &bull; <a href="#OptimizeImagePlusLayers">OptimizeImagePlusLayers</a> &bull; <a href="#OptimizeImageTransparency">OptimizeImageTransparency</a> &bull; <a href="#RemoveDuplicateLayers">RemoveDuplicateLayers</a> &bull; <a href="#RemoveZeroDelayLayers">RemoveZeroDelayLayers</a> &bull; <a href="#CompositeLayers">CompositeLayers</a> &bull; <a href="#MergeImageLayers">MergeImageLayers</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000198
cristy350dea42011-02-15 17:31:04 +0000199<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="CoalesceImages">CoalesceImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000200<div class="doc-section">
201
202<p>CoalesceImages() composites a set of images while respecting any page offsets and disposal methods. GIF, MIFF, and MNG animation sequences typically start with an image background and each subsequent image varies in size and offset. A new image sequence is returned with all images the same size as the first images virtual canvas and composited with the next image in the sequence.</p>
203
204<p>The format of the CoalesceImages method is:</p>
205
206<pre class="code">
207 Image *CoalesceImages(Image *image,ExceptionInfo *exception)
208</pre>
209
210<p>A description of each parameter follows:</p>
211
212<h5>image</h5>
213<p>the image sequence.</p>
214
215<h5>exception</h5>
216<p>return any errors or warnings in this structure.</p>
217
218 </div>
cristy350dea42011-02-15 17:31:04 +0000219<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="DisposeImages">DisposeImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000220<div class="doc-section">
221
222<p>DisposeImages() returns the coalesced frames of a GIF animation as it would appear after the GIF dispose method of that frame has been applied. That is it returned the appearance of each frame before the next is overlaid.</p>
223
224<p>The format of the DisposeImages method is:</p>
225
226<pre class="code">
227 Image *DisposeImages(Image *image,ExceptionInfo *exception)
228</pre>
229
230<p>A description of each parameter follows:</p>
231
232<h5>image</h5>
233<p>the image sequence.</p>
234
235<h5>exception</h5>
236<p>return any errors or warnings in this structure.</p>
237
238 </div>
cristy350dea42011-02-15 17:31:04 +0000239<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="CompareImageLayers">CompareImageLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000240<div class="doc-section">
241
242<p>CompareImageLayers() compares each image with the next in a sequence and returns the minimum bounding region of all the pixel differences (of the ImageLayerMethod specified) it discovers.</p>
243
244<p>Images do NOT have to be the same size, though it is best that all the images are 'coalesced' (images are all the same size, on a flattened canvas, so as to represent exactly how an specific frame should look).</p>
245
246<p>No GIF dispose methods are applied, so GIF animations must be coalesced before applying this image operator to find differences to them.</p>
247
248<p>The format of the CompareImageLayers method is:</p>
249
250<pre class="code">
251 Image *CompareImageLayers(const Image *images,
252 const ImageLayerMethod method,ExceptionInfo *exception)
253</pre>
254
255<p>A description of each parameter follows:</p>
256
257<h5>image</h5>
258<p>the image.</p>
259
260<h5>method</h5>
261<p>the layers type to compare images with. Must be one of... CompareAnyLayer, CompareClearLayer, CompareOverlayLayer.</p>
262
263<h5>exception</h5>
264<p>return any errors or warnings in this structure.</p>
265
266 </div>
cristy350dea42011-02-15 17:31:04 +0000267<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="DeconstructImages">DeconstructImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000268<div class="doc-section">
269
270<p>DeconstructImages() compares each image with the next in a sequence and returns the minimum bounding region of all differences from the first image.</p>
271
272<p>This function is deprecated in favor of the more universal CompareImageLayers() function.</p>
273
274<p>The format of the DeconstructImages method is:</p>
275
276<pre class="code">
277 Image *DeconstructImages(const Image *images, ExceptionInfo *exception)
278</pre>
279
280<p>A description of each parameter follows:</p>
281
282<h5>image</h5>
283<p>the image.</p>
284
285<h5>exception</h5>
286<p>return any errors or warnings in this structure.</p>
287
288 </div>
cristy350dea42011-02-15 17:31:04 +0000289<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="OptimizeImageLayers">OptimizeImageLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000290<div class="doc-section">
291
292<p>OptimizeImageLayers() compares each image the GIF disposed forms of the previous image in the sequence. From this it attempts to select the smallest cropped image to replace each frame, while preserving the results of the GIF animation.</p>
293
294<p>The format of the OptimizeImageLayers method is:</p>
295
296<pre class="code">
297 Image *OptimizeImageLayers(const Image *image,
298 ExceptionInfo *exception)
299</pre>
300
301<p>A description of each parameter follows:</p>
302
303<h5>image</h5>
304<p>the image.</p>
305
306<h5>exception</h5>
307<p>return any errors or warnings in this structure.</p>
308
309 </div>
cristy350dea42011-02-15 17:31:04 +0000310<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="OptimizeImagePlusLayers">OptimizeImagePlusLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000311<div class="doc-section">
312
313<p>OptimizeImagePlusLayers() is exactly as OptimizeImageLayers(), but may also add or even remove extra frames in the animation, if it improves the total number of pixels in the resulting GIF animation.</p>
314
315<p>The format of the OptimizePlusImageLayers method is:</p>
316
317<pre class="code">
318 Image *OptimizePlusImageLayers(const Image *image,
319 ExceptionInfo *exception)
320</pre>
321
322<p>A description of each parameter follows:</p>
323
324<h5>image</h5>
325<p>the image.</p>
326
327<h5>exception</h5>
328<p>return any errors or warnings in this structure.</p>
329
330 </div>
cristy350dea42011-02-15 17:31:04 +0000331<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="OptimizeImageTransparency">OptimizeImageTransparency</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000332<div class="doc-section">
333
334<p>OptimizeImageTransparency() takes a frame optimized GIF animation, and compares the overlayed pixels against the disposal image resulting from all the previous frames in the animation. Any pixel that does not change the disposal image (and thus does not effect the outcome of an overlay) is made transparent.</p>
335
336<p>WARNING: This modifies the current images directly, rather than generate a new image sequence.</p>
337
338<p>The format of the OptimizeImageTransperency method is:</p>
339
340<pre class="code">
341 void OptimizeImageTransperency(Image *image,ExceptionInfo *exception)
342</pre>
343
344<p>A description of each parameter follows:</p>
345
346<h5>image</h5>
347<p>the image sequence</p>
348
349<h5>exception</h5>
350<p>return any errors or warnings in this structure.</p>
351
352 </div>
cristy350dea42011-02-15 17:31:04 +0000353<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="RemoveDuplicateLayers">RemoveDuplicateLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000354<div class="doc-section">
355
356<p>RemoveDuplicateLayers() removes any image that is exactly the same as the next image in the given image list. Image size and virtual canvas offset must also match, though not the virtual canvas size itself.</p>
357
358<p>No check is made with regards to image disposal setting, though it is the dispose setting of later image that is kept. Also any time delays are also added together. As such coalesced image animations should still produce the same result, though with duplicte frames merged into a single frame.</p>
359
360<p>The format of the RemoveDuplicateLayers method is:</p>
361
362<pre class="code">
363 void RemoveDuplicateLayers(Image **image, ExceptionInfo *exception)
364</pre>
365
366<p>A description of each parameter follows:</p>
367
368<h5>images</h5>
369<p>the image list</p>
370
371<h5>exception</h5>
372<p>return any errors or warnings in this structure.</p>
373
374 </div>
cristy350dea42011-02-15 17:31:04 +0000375<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="RemoveZeroDelayLayers">RemoveZeroDelayLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000376<div class="doc-section">
377
378<p>RemoveZeroDelayLayers() removes any image that as a zero delay time. Such images generally represent intermediate or partial updates in GIF animations used for file optimization. They are not ment to be displayed to users of the animation. Viewable images in an animation should have a time delay of 3 or more centi-seconds (hundredths of a second).</p>
379
380<p>However if all the frames have a zero time delay, then either the animation is as yet incomplete, or it is not a GIF animation. This a non-sensible situation, so no image will be removed and a 'Zero Time Animation' warning (exception) given.</p>
381
382<p>No warning will be given if no image was removed because all images had an appropriate non-zero time delay set.</p>
383
384<p>Due to the special requirements of GIF disposal handling, GIF animations should be coalesced first, before calling this function, though that is not a requirement.</p>
385
386<p>The format of the RemoveZeroDelayLayers method is:</p>
387
388<pre class="code">
389 void RemoveZeroDelayLayers(Image **image, ExceptionInfo *exception)
390</pre>
391
392<p>A description of each parameter follows:</p>
393
394<h5>images</h5>
395<p>the image list</p>
396
397<h5>exception</h5>
398<p>return any errors or warnings in this structure.</p>
399
400 </div>
cristy350dea42011-02-15 17:31:04 +0000401<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="CompositeLayers">CompositeLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000402<div class="doc-section">
403
404<p>CompositeLayers() compose first image sequence (source) over the second image sequence (destination), using the given compose method and offsets.</p>
405
406<p>The pointers to the image list does not have to be the start of that image list, but may start somewhere in the middle. Each layer from the two image lists are composted together until the end of one of the image lists is reached. The offset of each composition is also adjusted to match the virtual canvas offsets of each layer. As such the given offset is relative to the virtual canvas, and not the actual image.</p>
407
408<p>No GIF disposal handling is performed, so GIF animations should be coalesced before use. However this not a requirement, and individual layer images may have any size or offset, for special compositions.</p>
409
410<p>Special case:- If one of the image sequences is just a single image that image is repeatally composed with all the images in the other image list. Either the source or destination lists may be the single image, for this situation.</p>
411
412<p>The destination list will be expanded as needed to match number of source image overlaid (from current position to end of list).</p>
413
414<p>The format of the CompositeLayers method is:</p>
415
416<pre class="code">
417 void CompositeLayers(Image *destination,
418 const CompositeOperator compose, Image *source,
419 const ssize_t x_offset, const ssize_t y_offset,
420 ExceptionInfo *exception);
421</pre>
422
423<p>A description of each parameter follows:</p>
424
425<h5>destination</h5>
426<p>the destination images and results</p>
427
428<h5>source</h5>
429<p>source image(s) for the layer composition</p>
430
431<h5>compose, x_offset, y_offset</h5>
432<p>arguments passed on to CompositeImages()</p>
433
434<h5>exception</h5>
435<p>return any errors or warnings in this structure.</p>
436
437 </div>
cristy350dea42011-02-15 17:31:04 +0000438<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="MergeImageLayers">MergeImageLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000439<div class="doc-section">
440
441<p>MergeImageLayers() composes all the image layers from the current given image onward to produce a single image of the merged layers.</p>
442
443<p>The inital canvas's size depends on the given ImageLayerMethod, and is initialized using the first images background color. The images are then compositied onto that image in sequence using the given composition that has been assigned to each individual image.</p>
444
445<p>The format of the MergeImageLayers is:</p>
446
447<pre class="text">
448 Image *MergeImageLayers(const Image *image,
449 const ImageLayerMethod method, ExceptionInfo *exception)
450</pre>
451
452<p>A description of each parameter follows:</p>
453
454<h5>image</h5>
455<p>the image list to be composited together</p>
456
457<h5>method</h5>
458<p>the method of selecting the size of the initial canvas.</p>
459
460<p>MergeLayer: Merge all layers onto a canvas just large enough to hold all the actual images. The virtual canvas of the first image is preserved but otherwise ignored.</p>
461
462<p>FlattenLayer: Use the virtual canvas size of first image. Images which fall outside this canvas is clipped. This can be used to 'fill out' a given virtual canvas.</p>
463
464<p>MosaicLayer: Start with the virtual canvas of the first image, enlarging left and right edges to contain all images. Images with negative offsets will be clipped.</p>
465
466<p>TrimBoundsLayer: Determine the overall bounds of all the image layers just as in "MergeLayer", then adjust the the canvas and offsets to be relative to those bounds, without overlaying the images.</p>
467
468<p>WARNING: a new image is not returned, the original image sequence page data is modified instead.</p>
469
470<h5>exception</h5>
471<p>return any errors or warnings in this structure.</p>
472
473 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000474
475</div>
476
477<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000478 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000479 <span id="linkbar-center">
480 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000481 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000482 </span>
483 <span id="linkbar-east">&nbsp;</span>
484 </div>
485 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000486 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000487 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
488 </div>
489 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000490 <script type="text/javascript">
491 var _gaq = _gaq || [];
492 _gaq.push(['_setAccount', 'UA-17690367-1']);
493 _gaq.push(['_trackPageview']);
494
495 (function() {
496 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
497 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
498 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
499 })();
500 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000501</body>
502</html>