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