Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / ffb69edc137c5ad509f39e4e2cdb1fefe792068a / . / www / api / layer.html
blob: 485ad86e3c48c28ee52d7bcaee2e90d1ee725479 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Image Layers</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, 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 +0000[diff] [blame]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]30</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]48<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]49
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]52</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]53<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]54<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]55 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]93</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]94<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]119 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]122 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127
128<div class="sponsbox">
129<div class="sponsor">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]130 <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]131</div>
132<div class="sponsor">
133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristybebec402010-04-23 19:19:08 +0000[diff] [blame]143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]149</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]153
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]166</div>
167
168<div class="main">
169
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]170<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>
171
172<h2><a href="http://www.imagemagick.org/api/MagickCore/layer
173_8c.html" target="source" name="CoalesceImages">CoalesceImages</a></h2>
174<div class="doc-section">
175
176<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></ol>
177
178<p>The format of the CoalesceImages method is:</p>
179
180<pre class="code">
181 Image *CoalesceImages(Image *image,ExceptionInfo *exception)
182</pre>
183
184<p>A description of each parameter follows:</p></ol>
185
186<h5>image</h5>
187<ol><p>the image sequence.</p></ol>
188
189<h5>exception</h5>
190<ol><p>return any errors or warnings in this structure.</p></ol>
191
192 </div>
193<h2><a href="http://www.imagemagick.org/api/MagickCore/layer
194_8c.html" target="source" name="DisposeImages">DisposeImages</a></h2>
195<div class="doc-section">
196
197<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></ol>
198
199<p>The format of the DisposeImages method is:</p>
200
201<pre class="code">
202 Image *DisposeImages(Image *image,ExceptionInfo *exception)
203</pre>
204
205<p>A description of each parameter follows:</p></ol>
206
207<h5>image</h5>
208<ol><p>the image sequence.</p></ol>
209
210<h5>exception</h5>
211<ol><p>return any errors or warnings in this structure.</p></ol>
212
213 </div>
214<h2><a href="http://www.imagemagick.org/api/MagickCore/layer
215_8c.html" target="source" name="CompareImageLayers">CompareImageLayers</a></h2>
216<div class="doc-section">
217
218<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></ol>
219
220<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></ol>
221
222<p>No GIF dispose methods are applied, so GIF animations must be coalesced before applying this image operator to find differences to them.</p></ol>
223
224<p>The format of the CompareImageLayers method is:</p>
225
226<pre class="code">
227 Image *CompareImageLayers(const Image *images,
228 const ImageLayerMethod method,ExceptionInfo *exception)
229</pre>
230
231<p>A description of each parameter follows:</p></ol>
232
233<h5>image</h5>
234<ol><p>the image.</p></ol>
235
236<h5>method</h5>
237<ol><p>the layers type to compare images with. Must be one of... CompareAnyLayer, CompareClearLayer, CompareOverlayLayer.</p></ol>
238
239<h5>exception</h5>
240<ol><p>return any errors or warnings in this structure.</p></ol>
241
242 </div>
243<h2><a href="http://www.imagemagick.org/api/MagickCore/layer
244_8c.html" target="source" name="DeconstructImages">DeconstructImages</a></h2>
245<div class="doc-section">
246
247<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></ol>
248
249<p>This function is deprecated in favor of the more universal CompareImageLayers() function.</p></ol>
250
251<p>The format of the DeconstructImages method is:</p>
252
253<pre class="code">
254 Image *DeconstructImages(const Image *images, ExceptionInfo *exception)
255</pre>
256
257<p>A description of each parameter follows:</p></ol>
258
259<h5>image</h5>
260<ol><p>the image.</p></ol>
261
262<h5>exception</h5>
263<ol><p>return any errors or warnings in this structure.</p></ol>
264
265 </div>
266<h2><a href="http://www.imagemagick.org/api/MagickCore/layer
267_8c.html" target="source" name="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></ol>
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></ol>
280
281<h5>image</h5>
282<ol><p>the image.</p></ol>
283
284<h5>exception</h5>
285<ol><p>return any errors or warnings in this structure.</p></ol>
286
287 </div>
288<h2><a href="http://www.imagemagick.org/api/MagickCore/layer
289_8c.html" target="source" name="OptimizeImagePlusLayers">OptimizeImagePlusLayers</a></h2>
290<div class="doc-section">
291
292<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></ol>
293
294<p>The format of the OptimizePlusImageLayers method is:</p>
295
296<pre class="code">
297 Image *OptimizePlusImageLayers(const Image *image,
298 ExceptionInfo *exception)
299</pre>
300
301<p>A description of each parameter follows:</p></ol>
302
303<h5>image</h5>
304<ol><p>the image.</p></ol>
305
306<h5>exception</h5>
307<ol><p>return any errors or warnings in this structure.</p></ol>
308
309 </div>
310<h2><a href="http://www.imagemagick.org/api/MagickCore/layer
311_8c.html" target="source" name="OptimizeImageTransparency">OptimizeImageTransparency</a></h2>
312<div class="doc-section">
313
314<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></ol>
315
316<p>WARNING: This modifies the current images directly, rather than generate a new image sequence.</p></ol>
317
318<p>The format of the OptimizeImageTransperency method is:</p>
319
320<pre class="code">
321 void OptimizeImageTransperency(Image *image,ExceptionInfo *exception)
322</pre>
323
324<p>A description of each parameter follows:</p></ol>
325
326<h5>image</h5>
327<ol><p>the image sequence</p></ol>
328
329<h5>exception</h5>
330<ol><p>return any errors or warnings in this structure.</p></ol>
331
332 </div>
333<h2><a href="http://www.imagemagick.org/api/MagickCore/layer
334_8c.html" target="source" name="RemoveDuplicateLayers">RemoveDuplicateLayers</a></h2>
335<div class="doc-section">
336
337<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></ol>
338
339<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></ol>
340
341<p>The format of the RemoveDuplicateLayers method is:</p>
342
343<pre class="code">
344 void RemoveDuplicateLayers(Image **image, ExceptionInfo *exception)
345</pre>
346
347<p>A description of each parameter follows:</p></ol>
348
349<h5>images</h5>
350<ol><p>the image list</p></ol>
351
352<h5>exception</h5>
353<ol><p>return any errors or warnings in this structure.</p></ol>
354
355 </div>
356<h2><a href="http://www.imagemagick.org/api/MagickCore/layer
357_8c.html" target="source" name="RemoveZeroDelayLayers">RemoveZeroDelayLayers</a></h2>
358<div class="doc-section">
359
360<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></ol>
361
362<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></ol>
363
364<p>No warning will be given if no image was removed because all images had an appropriate non-zero time delay set.</p></ol>
365
366<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></ol>
367
368<p>The format of the RemoveZeroDelayLayers method is:</p>
369
370<pre class="code">
371 void RemoveZeroDelayLayers(Image **image, ExceptionInfo *exception)
372</pre>
373
374<p>A description of each parameter follows:</p></ol>
375
376<h5>images</h5>
377<ol><p>the image list</p></ol>
378
379<h5>exception</h5>
380<ol><p>return any errors or warnings in this structure.</p></ol>
381
382 </div>
383<h2><a href="http://www.imagemagick.org/api/MagickCore/layer
384_8c.html" target="source" name="CompositeLayers">CompositeLayers</a></h2>
385<div class="doc-section">
386
387<p>CompositeLayers() compose first image sequence (source) over the second image sequence (destination), using the given compose method and offsets.</p></ol>
388
389<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></ol>
390
391<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></ol>
392
393<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></ol>
394
395<p>The destination list will be expanded as needed to match number of source image overlaid (from current position to end of list).</p></ol>
396
397<p>The format of the CompositeLayers method is:</p>
398
399<pre class="code">
400 void CompositeLayers(Image *destination,
401 const CompositeOperator compose, Image *source,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]402 const ssize_t x_offset, const ssize_t y_offset,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]403 ExceptionInfo *exception);
404</pre>
405
406<p>A description of each parameter follows:</p></ol>
407
408<h5>destination</h5>
409<ol><p>the destination images and results</p></ol>
410
411<h5>source</h5>
412<ol><p>source image(s) for the layer composition</p></ol>
413
414<h5>compose, x_offset, y_offset</h5>
415<ol><p>arguments passed on to CompositeImages()</p></ol>
416
417<h5>exception</h5>
418<ol><p>return any errors or warnings in this structure.</p></ol>
419
420 </div>
421<h2><a href="http://www.imagemagick.org/api/MagickCore/layer
422_8c.html" target="source" name="MergeImageLayers">MergeImageLayers</a></h2>
423<div class="doc-section">
424
425<p>MergeImageLayers() composes all the image layers from the current given image onward to produce a single image of the merged layers.</p></ol>
426
427<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></ol>
428
429<p>The format of the MergeImageLayers is:</p>
430
431<pre class="text">
432 Image *MergeImageLayers(const Image *image,
433 const ImageLayerMethod method, ExceptionInfo *exception)
434</pre>
435
436<p>A description of each parameter follows:</p></ol>
437
438<h5>image</h5>
439<ol><p>the image list to be composited together</p></ol>
440
441<h5>method</h5>
442<ol><p>the method of selecting the size of the initial canvas.</p></ol>
443
444<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></ol>
445
446<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></ol>
447
448<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></ol>
449
450<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></ol>
451
452<p>WARNING: a new image is not returned, the original image sequence page data is modified instead.</p></ol>
453
454<h5>exception</h5>
455<ol><p>return any errors or warnings in this structure.</p></ol>
456
457 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]458
459</div>
460
461<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]462 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]463 <span id="linkbar-center">
464 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]465 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]466 </span>
467 <span id="linkbar-east">&nbsp;</span>
468 </div>
469 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]470 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]471 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
472 </div>
473 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]474 <script type="text/javascript">
475 var _gaq = _gaq || [];
476 _gaq.push(['_setAccount', 'UA-17690367-1']);
477 _gaq.push(['_trackPageview']);
478
479 (function() {
480 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
481 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
482 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
483 })();
484 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]485</body>
486</html>