Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 689efa2792fc00b3418a812abcdc9bb76e5293b0 / . / www / api / layer.html
blob: 3fddcb2a0b671d91c0735bbf34f5d57cddfeec7e [file] [log] [blame]
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="-//W3C//DTD XHTML 1.1//EN" xml:lang="en" xsi:schemaLocation="http://www.w3.org/1999/xhtml http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]3<head>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]4 <meta http-equiv="content-type" content="text/html; charset=UTF-8"></meta>
5 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"></meta>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]6 <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Image Layers</title>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]7 <meta http-equiv="content-language" content="en-US"></meta>
8 <meta http-equiv="content-type" content="text/html; charset=utf-8"></meta>
9 <meta http-equiv="reply-to" content="magick-users@imagemagick.org"></meta>
10 <meta name="application-name" content="ImageMagick"></meta>
11 <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition, resize, rotate, shear, distort or transform images automagically."></meta>
12 <meta name="application-url" content="http://www.imagemagick.org"></meta>
13 <meta name="generator" content="PHP"></meta>
14 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, dealing, with, image, layers, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"></meta>
15 <meta name="rating" content="GENERAL"></meta>
16 <meta name="robots" content="INDEX, FOLLOW"></meta>
17 <meta name="generator" content="ImageMagick Studio LLC"></meta>
18 <meta name="author" content="ImageMagick Studio LLC"></meta>
19 <meta name="revisit-after" content="2 DAYS"></meta>
20 <meta name="resource-type" content="document"></meta>
21 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"></meta>
22 <meta name="distribution" content="Global"></meta>
23 <link rel="icon" href="../../images/wand.png"></link>
24 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"></link>
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]25 <link rel="canonical" href="http://www.imagemagick.org"></link>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]27
28 <!-- Add jQuery library -->
29 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
30
31 <!-- Add mousewheel plugin (this is optional) -->
32 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
33
34 <!-- Add fancyBox -->
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]35 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]36 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
37
38 <!-- Optionally add helpers - button, thumbnail and/or media -->
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]39 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]40 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
41 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
42
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]43 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]44 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
45
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]46 <script type="text/javascript">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]47 $(document).ready(function() {
48 $(".fancybox").fancybox();
49 });
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]50 </script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]51
52 <!-- ImageMagick style -->
53 <style type="text/css" media="all">
54 @import url("../../www/magick.css");
55 </style>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]56</head>
57
58<body id="www-imagemagick-org">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]59
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]60
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]61
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]62<div class="titlebar">
63<div style="margin: 17px auto; float: left;">
64 <script type="text/javascript">
65 <!--
66 google_ad_client = "pub-3129977114552745";
67 google_ad_slot = "5439289906";
68 google_ad_width = 728;
69 google_ad_height = 90;
70 //-->
71 </script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]72
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]73</div>
cristy417eeb12013-07-28 18:48:22 +0000[diff] [blame]74<a href="../../discourse-server">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]75 <img src="../../images/logo.jpg" alt="ImageMagick Logo" style="width: 123px; height: 118px; border: 0px; float: right;"></img></a>
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]76<a href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]77 <img src="../../images/sprite.jpg" alt="ImageMagick Sprite" style="width: 114px; height: 118px; border: 0px; float: right;"></img></a>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]78</div>
79
80<div class="westbar">
81
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]83 <a title="About ImageMagick" href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]85<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]86 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]87</div>
88<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]89 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]90</div>
91<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]92 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]93</div>
94<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]95 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]96</div>
97<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]98 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]99</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]100<div class="sep"></div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]101<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]102 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]105 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]108 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
110<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
113<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]114 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115</div>
116<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]117 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118</div>
119<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]120 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121</div>
122<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]123 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124</div>
125<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]126 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]128<div class="sep"></div>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]129<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]130 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]131</div>
132<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]133 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]136 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137 </div>
138<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]139 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]141<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]142 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]143</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]145 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristy3dfa2192013-02-24 22:46:05 +0000[diff] [blame]149 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]151<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]152<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]153 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]154</div>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]155<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]156 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]157</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]158<div class="sep"></div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]159</div>
160
161<div class="eastbar">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]162
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]163 <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://www.imagemagick.org/"></a></div>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]164 <noscript>
165 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]166 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0"></img></a>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]167 </noscript>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]168
169
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]170</div>
171
172<div class="main">
173
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]174<h1>Module layer Methods</h1>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]175<p class="navigation-index">[<a href="layer.html#CoalesceImages">CoalesceImages</a> • <a href="layer.html#DisposeImages">DisposeImages</a> • <a href="layer.html#CompareImageLayers">CompareImageLayers</a> • <a href="layer.html#DeconstructImages">DeconstructImages</a> • <a href="layer.html#OptimizeImageLayers">OptimizeImageLayers</a> • <a href="layer.html#OptimizeImagePlusLayers">OptimizeImagePlusLayers</a> • <a href="layer.html#OptimizeImageTransparency">OptimizeImageTransparency</a> • <a href="layer.html#RemoveDuplicateLayers">RemoveDuplicateLayers</a> • <a href="layer.html#RemoveZeroDelayLayers">RemoveZeroDelayLayers</a> • <a href="layer.html#CompositeLayers">CompositeLayers</a> • <a href="layer.html#MergeImageLayers">MergeImageLayers</a>]</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]176
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]177<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="CoalesceImages">CoalesceImages</a></h2>
178<div class="doc-section">
179
180<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>
181
182<p>The format of the CoalesceImages method is:</p>
183
184<pre class="code">
185 Image *CoalesceImages(Image *image,ExceptionInfo *exception)
186</pre>
187
188<p>A description of each parameter follows:</p>
189
190<h5>image</h5>
191<p>the image sequence.</p>
192
193<h5>exception</h5>
194<p>return any errors or warnings in this structure.</p>
195
196 </div>
197<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="DisposeImages">DisposeImages</a></h2>
198<div class="doc-section">
199
200<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>
201
202<p>The format of the DisposeImages method is:</p>
203
204<pre class="code">
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]205 Image *DisposeImages(Image *image,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]206</pre>
207
208<p>A description of each parameter follows:</p>
209
210<h5>image</h5>
211<p>the image sequence.</p>
212
213<h5>exception</h5>
214<p>return any errors or warnings in this structure.</p>
215
216 </div>
217<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="CompareImageLayers">CompareImageLayers</a></h2>
218<div class="doc-section">
219
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]220<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>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]221
222<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>
223
224<p>No GIF dispose methods are applied, so GIF animations must be coalesced before applying this image operator to find differences to them.</p>
225
226<p>The format of the CompareImageLayers method is:</p>
227
228<pre class="code">
229 Image *CompareImageLayers(const Image *images,
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]230 const ImageLayerMethod method,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]231</pre>
232
233<p>A description of each parameter follows:</p>
234
235<h5>image</h5>
236<p>the image.</p>
237
238<h5>method</h5>
239<p>the layers type to compare images with. Must be one of... CompareAnyLayer, CompareClearLayer, CompareOverlayLayer.</p>
240
241<h5>exception</h5>
242<p>return any errors or warnings in this structure.</p>
243
244 </div>
245<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="DeconstructImages">DeconstructImages</a></h2>
246<div class="doc-section">
247
248<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>
249
250<p>This function is deprecated in favor of the more universal CompareImageLayers() function.</p>
251
252<p>The format of the DeconstructImages method is:</p>
253
254<pre class="code">
255 Image *DeconstructImages(const Image *images, ExceptionInfo *exception)
256</pre>
257
258<p>A description of each parameter follows:</p>
259
260<h5>image</h5>
261<p>the image.</p>
262
263<h5>exception</h5>
264<p>return any errors or warnings in this structure.</p>
265
266 </div>
267<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="OptimizeImageLayers">OptimizeImageLayers</a></h2>
268<div class="doc-section">
269
270<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>
271
272<p>The format of the OptimizeImageLayers method is:</p>
273
274<pre class="code">
275 Image *OptimizeImageLayers(const Image *image,
276 ExceptionInfo *exception)
277</pre>
278
279<p>A description of each parameter follows:</p>
280
281<h5>image</h5>
282<p>the image.</p>
283
284<h5>exception</h5>
285<p>return any errors or warnings in this structure.</p>
286
287 </div>
288<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="OptimizeImagePlusLayers">OptimizeImagePlusLayers</a></h2>
289<div class="doc-section">
290
291<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>
292
293<p>The format of the OptimizePlusImageLayers method is:</p>
294
295<pre class="code">
296 Image *OptimizePlusImageLayers(const Image *image,
297 ExceptionInfo *exception)
298</pre>
299
300<p>A description of each parameter follows:</p>
301
302<h5>image</h5>
303<p>the image.</p>
304
305<h5>exception</h5>
306<p>return any errors or warnings in this structure.</p>
307
308 </div>
309<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="OptimizeImageTransparency">OptimizeImageTransparency</a></h2>
310<div class="doc-section">
311
312<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>
313
314<p>WARNING: This modifies the current images directly, rather than generate a new image sequence.</p>
315
316<p>The format of the OptimizeImageTransperency method is:</p>
317
318<pre class="code">
319 void OptimizeImageTransperency(Image *image,ExceptionInfo *exception)
320</pre>
321
322<p>A description of each parameter follows:</p>
323
324<h5>image</h5>
325<p>the image sequence</p>
326
327<h5>exception</h5>
328<p>return any errors or warnings in this structure.</p>
329
330 </div>
331<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="RemoveDuplicateLayers">RemoveDuplicateLayers</a></h2>
332<div class="doc-section">
333
334<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>
335
336<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>
337
338<p>The format of the RemoveDuplicateLayers method is:</p>
339
340<pre class="code">
341 void RemoveDuplicateLayers(Image **image, ExceptionInfo *exception)
342</pre>
343
344<p>A description of each parameter follows:</p>
345
346<h5>images</h5>
347<p>the image list</p>
348
349<h5>exception</h5>
350<p>return any errors or warnings in this structure.</p>
351
352 </div>
353<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="RemoveZeroDelayLayers">RemoveZeroDelayLayers</a></h2>
354<div class="doc-section">
355
356<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>
357
358<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>
359
360<p>No warning will be given if no image was removed because all images had an appropriate non-zero time delay set.</p>
361
362<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>
363
364<p>The format of the RemoveZeroDelayLayers method is:</p>
365
366<pre class="code">
367 void RemoveZeroDelayLayers(Image **image, ExceptionInfo *exception)
368</pre>
369
370<p>A description of each parameter follows:</p>
371
372<h5>images</h5>
373<p>the image list</p>
374
375<h5>exception</h5>
376<p>return any errors or warnings in this structure.</p>
377
378 </div>
379<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="CompositeLayers">CompositeLayers</a></h2>
380<div class="doc-section">
381
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]382<p>CompositeLayers() compose the source image sequence over the destination image sequence, starting with the current image in both lists.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]383
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]384<p>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>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]385
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]386<p>Composition uses given x and y offsets, as the 'origin' location of the source images virtual canvas (not the real image) allowing you to compose a list of 'layer images' into the destiantioni images. This makes it well sutiable for directly composing 'Clears Frame Animations' or 'Coaleased Animations' onto a static or other 'Coaleased Animation' destination image list. GIF disposal handling is not looked at.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]387
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]388<p>Special case:- If one of the image sequences is the last image (just a single image remaining), 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>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]389
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]390<p>In the case of a single destination image (or last image given), that image will ve cloned to match the number of images remaining in the source image list.</p>
391
392<p>This is equivelent to the "-layer Composite" Shell API operator.</p>
393
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]394
395<p>The format of the CompositeLayers method is:</p>
396
397<pre class="code">
398 void CompositeLayers(Image *destination,
399 const CompositeOperator compose, Image *source,
400 const ssize_t x_offset, const ssize_t y_offset,
401 ExceptionInfo *exception);
402</pre>
403
404<p>A description of each parameter follows:</p>
405
406<h5>destination</h5>
407<p>the destination images and results</p>
408
409<h5>source</h5>
410<p>source image(s) for the layer composition</p>
411
412<h5>compose, x_offset, y_offset</h5>
413<p>arguments passed on to CompositeImages()</p>
414
415<h5>exception</h5>
416<p>return any errors or warnings in this structure.</p>
417
418 </div>
419<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="MergeImageLayers">MergeImageLayers</a></h2>
420<div class="doc-section">
421
422<p>MergeImageLayers() composes all the image layers from the current given image onward to produce a single image of the merged layers.</p>
423
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]424<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>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]425
426<p>The format of the MergeImageLayers is:</p>
427
428<pre class="text">
429 Image *MergeImageLayers(const Image *image,
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]430 const ImageLayerMethod method, ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]431</pre>
432
433<p>A description of each parameter follows:</p>
434
435<h5>image</h5>
436<p>the image list to be composited together</p>
437
438<h5>method</h5>
439<p>the method of selecting the size of the initial canvas.</p>
440
441<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>
442
443<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>
444
445<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>
446
447<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>
448
449<p>WARNING: a new image is not returned, the original image sequence page data is modified instead.</p>
450
451<h5>exception</h5>
452<p>return any errors or warnings in this structure.</p>
453
454 </div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]455
456</div>
457
458<div id="linkbar">
cristyac1b4322013-07-28 13:58:06 +0000[diff] [blame]459 <span id="linkbar-west"> </span>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]460
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]461 <span id="linkbar-center">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]462 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
463 <a href="../../discourse-server">Discourse Server</a> •
464 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> •
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]465 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]466 </span>
cristyac1b4322013-07-28 13:58:06 +0000[diff] [blame]467 <span id="linkbar-east"> </span>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]468</div>
469<div class="footer">
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]470 <span id="footer-west">© 1999-2013 ImageMagick Studio LLC</span>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]471 <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
472</div>
473<div style="clear: both; margin: 0; width: 100%; "></div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]474</body>
475</html>