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