Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 874cf8e1d96c5ff893cf693b2f71ebb21da88901 / . / www / api / layer.html
blob: b108c04e4abf549e00bd8e789c7bac7a36eaab29 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]3<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 +0000[diff] [blame]8<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]11 <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Image Layers</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]12 <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 +0000[diff] [blame]15 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]16 <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 +0000[diff] [blame]17 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]18 <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 +0000[diff] [blame]20 <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 +0000[diff] [blame]26 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]27 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]28 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]29 <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 +0000[diff] [blame]31 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]32 <style type="text/css" media="all">
33 @import url("../../www/magick.css");
34 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]35 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]36 <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 +0000[diff] [blame]48</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]52<div style="margin: 17px auto; float: left;">
53 <script type="text/javascript">
54 <!--
55 google_ad_client = "pub-3129977114552745";
56 google_ad_slot = "5439289906";
57 google_ad_width = 728;
58 google_ad_height = 90;
59 //-->
60 </script>
61 <script type="text/javascript"
62 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
63 </script>
64</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]66 <img src="../../images/logo.jpg"
67 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]68 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]70 <img src="../../images/sprite.jpg"
71 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]72 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
73</div>
74
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]75<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]76
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]77<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]78 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]80<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]82 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
83</div>
84<div class="sub">
85 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
89</div>
90<div class="sub">
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]91 <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
92</div>
93<div class="sub">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]94 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
95</div>
96<div class="sep"></div>
97<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]98 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]99</div>
100<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]101 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]102</div>
103<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]104 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]105</div>
106<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]107 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]108</div>
109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]122 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</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="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127</div>
128<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]129 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
131<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]132 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]133 </div>
134<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]135 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]137<div class="menu">
138 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
139</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]141 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]143<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]145 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]149 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]152 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]153</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]154<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]156 <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]157
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]158<a href="http://www.networkredux.com">
159 <img src="../../images/networkredux.png" alt="[sponsor]"
160 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]162<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]163 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
164</div>
165<div class="sponsor">
166 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
167</div>
168<div class="sponsor">
169 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
170</div>
171<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]172 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]173</div>
174<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]175 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000[diff] [blame]176</div>
177<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000[diff] [blame]178 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]179</div>
180<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]181 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]182</div>
183<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]184 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]185</div>
186<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]187 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]188</div>
189<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]190 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]191</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]192<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]193 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]194</div>
195<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]196 <a rel="follow" title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]197</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]198</div>
199</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]200</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]201
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]202<div class="eastbar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]203
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]204</div>
205
206<div class="main">
207
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]208<h1>Module layer Methods</h1>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]209<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 +0000[diff] [blame]210
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]211<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="CoalesceImages">CoalesceImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]212<div class="doc-section">
213
214<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>
215
216<p>The format of the CoalesceImages method is:</p>
217
218<pre class="code">
219 Image *CoalesceImages(Image *image,ExceptionInfo *exception)
220</pre>
221
222<p>A description of each parameter follows:</p>
223
224<h5>image</h5>
225<p>the image sequence.</p>
226
227<h5>exception</h5>
228<p>return any errors or warnings in this structure.</p>
229
230 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]231<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="DisposeImages">DisposeImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]232<div class="doc-section">
233
234<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>
235
236<p>The format of the DisposeImages method is:</p>
237
238<pre class="code">
239 Image *DisposeImages(Image *image,ExceptionInfo *exception)
240</pre>
241
242<p>A description of each parameter follows:</p>
243
244<h5>image</h5>
245<p>the image sequence.</p>
246
247<h5>exception</h5>
248<p>return any errors or warnings in this structure.</p>
249
250 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]251<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="CompareImageLayers">CompareImageLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]252<div class="doc-section">
253
254<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>
255
256<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>
257
258<p>No GIF dispose methods are applied, so GIF animations must be coalesced before applying this image operator to find differences to them.</p>
259
260<p>The format of the CompareImageLayers method is:</p>
261
262<pre class="code">
263 Image *CompareImageLayers(const Image *images,
264 const ImageLayerMethod method,ExceptionInfo *exception)
265</pre>
266
267<p>A description of each parameter follows:</p>
268
269<h5>image</h5>
270<p>the image.</p>
271
272<h5>method</h5>
273<p>the layers type to compare images with. Must be one of... CompareAnyLayer, CompareClearLayer, CompareOverlayLayer.</p>
274
275<h5>exception</h5>
276<p>return any errors or warnings in this structure.</p>
277
278 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]279<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="DeconstructImages">DeconstructImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]280<div class="doc-section">
281
282<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>
283
284<p>This function is deprecated in favor of the more universal CompareImageLayers() function.</p>
285
286<p>The format of the DeconstructImages method is:</p>
287
288<pre class="code">
289 Image *DeconstructImages(const Image *images, ExceptionInfo *exception)
290</pre>
291
292<p>A description of each parameter follows:</p>
293
294<h5>image</h5>
295<p>the image.</p>
296
297<h5>exception</h5>
298<p>return any errors or warnings in this structure.</p>
299
300 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]301<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="OptimizeImageLayers">OptimizeImageLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]302<div class="doc-section">
303
304<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>
305
306<p>The format of the OptimizeImageLayers method is:</p>
307
308<pre class="code">
309 Image *OptimizeImageLayers(const Image *image,
310 ExceptionInfo *exception)
311</pre>
312
313<p>A description of each parameter follows:</p>
314
315<h5>image</h5>
316<p>the image.</p>
317
318<h5>exception</h5>
319<p>return any errors or warnings in this structure.</p>
320
321 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]322<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="OptimizeImagePlusLayers">OptimizeImagePlusLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]323<div class="doc-section">
324
325<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>
326
327<p>The format of the OptimizePlusImageLayers method is:</p>
328
329<pre class="code">
330 Image *OptimizePlusImageLayers(const Image *image,
331 ExceptionInfo *exception)
332</pre>
333
334<p>A description of each parameter follows:</p>
335
336<h5>image</h5>
337<p>the image.</p>
338
339<h5>exception</h5>
340<p>return any errors or warnings in this structure.</p>
341
342 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]343<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="OptimizeImageTransparency">OptimizeImageTransparency</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]344<div class="doc-section">
345
346<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>
347
348<p>WARNING: This modifies the current images directly, rather than generate a new image sequence.</p>
349
350<p>The format of the OptimizeImageTransperency method is:</p>
351
352<pre class="code">
353 void OptimizeImageTransperency(Image *image,ExceptionInfo *exception)
354</pre>
355
356<p>A description of each parameter follows:</p>
357
358<h5>image</h5>
359<p>the image sequence</p>
360
361<h5>exception</h5>
362<p>return any errors or warnings in this structure.</p>
363
364 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]365<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="RemoveDuplicateLayers">RemoveDuplicateLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]366<div class="doc-section">
367
368<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>
369
370<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>
371
372<p>The format of the RemoveDuplicateLayers method is:</p>
373
374<pre class="code">
375 void RemoveDuplicateLayers(Image **image, ExceptionInfo *exception)
376</pre>
377
378<p>A description of each parameter follows:</p>
379
380<h5>images</h5>
381<p>the image list</p>
382
383<h5>exception</h5>
384<p>return any errors or warnings in this structure.</p>
385
386 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]387<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="RemoveZeroDelayLayers">RemoveZeroDelayLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]388<div class="doc-section">
389
390<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>
391
392<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>
393
394<p>No warning will be given if no image was removed because all images had an appropriate non-zero time delay set.</p>
395
396<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>
397
398<p>The format of the RemoveZeroDelayLayers method is:</p>
399
400<pre class="code">
401 void RemoveZeroDelayLayers(Image **image, ExceptionInfo *exception)
402</pre>
403
404<p>A description of each parameter follows:</p>
405
406<h5>images</h5>
407<p>the image list</p>
408
409<h5>exception</h5>
410<p>return any errors or warnings in this structure.</p>
411
412 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]413<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="CompositeLayers">CompositeLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]414<div class="doc-section">
415
416<p>CompositeLayers() compose first image sequence (source) over the second image sequence (destination), using the given compose method and offsets.</p>
417
418<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>
419
420<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>
421
422<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>
423
424<p>The destination list will be expanded as needed to match number of source image overlaid (from current position to end of list).</p>
425
426<p>The format of the CompositeLayers method is:</p>
427
428<pre class="code">
429 void CompositeLayers(Image *destination,
430 const CompositeOperator compose, Image *source,
431 const ssize_t x_offset, const ssize_t y_offset,
432 ExceptionInfo *exception);
433</pre>
434
435<p>A description of each parameter follows:</p>
436
437<h5>destination</h5>
438<p>the destination images and results</p>
439
440<h5>source</h5>
441<p>source image(s) for the layer composition</p>
442
443<h5>compose, x_offset, y_offset</h5>
444<p>arguments passed on to CompositeImages()</p>
445
446<h5>exception</h5>
447<p>return any errors or warnings in this structure.</p>
448
449 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]450<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="MergeImageLayers">MergeImageLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]451<div class="doc-section">
452
453<p>MergeImageLayers() composes all the image layers from the current given image onward to produce a single image of the merged layers.</p>
454
455<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>
456
457<p>The format of the MergeImageLayers is:</p>
458
459<pre class="text">
460 Image *MergeImageLayers(const Image *image,
461 const ImageLayerMethod method, ExceptionInfo *exception)
462</pre>
463
464<p>A description of each parameter follows:</p>
465
466<h5>image</h5>
467<p>the image list to be composited together</p>
468
469<h5>method</h5>
470<p>the method of selecting the size of the initial canvas.</p>
471
472<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>
473
474<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>
475
476<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>
477
478<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>
479
480<p>WARNING: a new image is not returned, the original image sequence page data is modified instead.</p>
481
482<h5>exception</h5>
483<p>return any errors or warnings in this structure.</p>
484
485 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]486
487</div>
488
489<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]490 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]491 <span id="linkbar-center">
492 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]493 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]494 </span>
495 <span id="linkbar-east">&nbsp;</span>
496 </div>
497 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]498 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]499 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
500 </div>
501 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]502 <script type="text/javascript">
503 var _gaq = _gaq || [];
504 _gaq.push(['_setAccount', 'UA-17690367-1']);
505 _gaq.push(['_trackPageview']);
506
507 (function() {
508 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
509 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
510 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
511 })();
512 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]513</body>
514</html>