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