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