Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 44443b9be690ffb2fb66ae9298ad552639994ac0 / . / www / api / layer.html
blob: b6e12dbb2d7cb8d69e522b254838d4915ec86778 [file] [log] [blame]
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html lang="en">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]3<head>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Image Layers</title>
cristy44443b92015-05-05 00:06:07 +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">
11 <meta name="application-name" content="ImageMagick">
12 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
13 <meta name="application-url" content="http://www.imagemagick.org">
14 <meta name="generator" content="PHP">
15 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, dealing, with, image, layers, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
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">
22 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC">
23 <meta name="distribution" content="Global">
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
25 <link rel="icon" href="../../images/wand.png">
26 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon">
27 <link rel="stylesheet" href="css/bootstrap.min.css">
28 <link rel="stylesheet" href="css/magick.css">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]29</head>
30
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]31<body>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]32<div class="main">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]33<div class="magick-masthead">
34 <div class="container">
35 <script type="text/javascript">
36 <!--
37 google_ad_client = "pub-3129977114552745";
38 google_ad_slot = "5439289906";
39 google_ad_width = 728;
40 google_ad_height = 90;
41 //-->
42 </script>
43 <center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
44 </script></center>
45 <nav class="magick-nav">
46 <a class="magick-nav-item " href="../../index.html">Home</a>
47 <a class="magick-nav-item " href="../../www/binary-releases.html">Downloads</a>
48 <a class="magick-nav-item " href="../../www/command-line-tools.html">Tools</a>
49 <a class="magick-nav-item " href="../../www/command-line-options.html">Options</a>
50 <a class="magick-nav-item " href="../../www/api.html">Development</a>
51 <a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a>
52 <a class="magick-nav-item navbar-right " href="http://www.imagemagick.org/script/search.php">Search</a>
53 </nav>
54 </div>
55</div>
56<div class="container">
57<p class="text-center"><a href="layer.html#CoalesceImages">CoalesceImages</a> • <a href="layer.html#DisposeImages">DisposeImages</a> • <a href="layer.html#CompareImagesLayers">CompareImagesLayers</a> • <a href="layer.html#OptimizeImageLayers">OptimizeImageLayers</a> • <a href="layer.html#OptimizeImagePlusLayers">OptimizeImagePlusLayers</a> • <a href="layer.html#OptimizeImageTransparency">OptimizeImageTransparency</a> • <a href="layer.html#RemoveDuplicateLayers">RemoveDuplicateLayers</a> • <a href="layer.html#RemoveZeroDelayLayers">RemoveZeroDelayLayers</a> • <a href="layer.html#CompositeLayers">CompositeLayers</a> • <a href="layer.html#MergeImageLayers">MergeImageLayers</a></p>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]58
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]59<div class="magick-header">
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]60<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="CoalesceImages">CoalesceImages</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]61
62<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>
63
64<p>The format of the CoalesceImages method is:</p>
65
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]66<pre class="text">
67Image *CoalesceImages(Image *image,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]68</pre>
69
70<p>A description of each parameter follows:</p>
71
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]72<dd>
73</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]74
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]75<dd> </dd>
76<dl class="dl-horizontal">
77<dt>image</dt>
78<dd>the image sequence. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]79
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]80<dd> </dd>
81<dt>exception</dt>
82<dd>return any errors or warnings in this structure. </dd>
83
84<dd> </dd>
85</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]86<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="DisposeImages">DisposeImages</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]87
88<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>
89
90<p>The format of the DisposeImages method is:</p>
91
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]92<pre class="text">
93Image *DisposeImages(Image *image,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]94</pre>
95
96<p>A description of each parameter follows:</p>
97
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]98<dd>
99</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]100
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]101<dd> </dd>
102<dl class="dl-horizontal">
103<dt>images</dt>
104<dd>the image sequence. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]105
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]106<dd> </dd>
107<dt>exception</dt>
108<dd>return any errors or warnings in this structure. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]109
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]110<dd> </dd>
111</dl>
112<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="CompareImagesLayers">CompareImagesLayers</a></h2>
113
114<p>CompareImagesLayers() compares each image with the next in a sequence and returns the minimum bounding region of all the pixel differences (of the LayerMethod specified) it discovers.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]115
116<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>
117
118<p>No GIF dispose methods are applied, so GIF animations must be coalesced before applying this image operator to find differences to them.</p>
119
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]120<p>The format of the CompareImagesLayers method is:</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]121
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]122<pre class="text">
123Image *CompareImagesLayers(const Image *images,
124 const LayerMethod method,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]125</pre>
126
127<p>A description of each parameter follows:</p>
128
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]129<dd>
130</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]131
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]132<dd> </dd>
133<dl class="dl-horizontal">
134<dt>image</dt>
135<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]136
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]137<dd> </dd>
138<dt>method</dt>
139<dd>the layers type to compare images with. Must be one of... CompareAnyLayer, CompareClearLayer, CompareOverlayLayer. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]140
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]141<dd> </dd>
142<dt>exception</dt>
143<dd>return any errors or warnings in this structure. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]144
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]145<dd> </dd>
146</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]147<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="OptimizeImageLayers">OptimizeImageLayers</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]148
149<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>
150
151<p>The format of the OptimizeImageLayers method is:</p>
152
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]153<pre class="text">
154Image *OptimizeImageLayers(const Image *image,
155 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]156</pre>
157
158<p>A description of each parameter follows:</p>
159
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]160<dd>
161</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]162
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]163<dd> </dd>
164<dl class="dl-horizontal">
165<dt>image</dt>
166<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]167
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]168<dd> </dd>
169<dt>exception</dt>
170<dd>return any errors or warnings in this structure. </dd>
171
172<dd> </dd>
173</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]174<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="OptimizeImagePlusLayers">OptimizeImagePlusLayers</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]175
176<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>
177
178<p>The format of the OptimizePlusImageLayers method is:</p>
179
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]180<pre class="text">
181Image *OptimizePlusImageLayers(const Image *image,
182 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]183</pre>
184
185<p>A description of each parameter follows:</p>
186
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]187<dd>
188</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]189
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]190<dd> </dd>
191<dl class="dl-horizontal">
192<dt>image</dt>
193<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]194
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]195<dd> </dd>
196<dt>exception</dt>
197<dd>return any errors or warnings in this structure. </dd>
198
199<dd> </dd>
200</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]201<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="OptimizeImageTransparency">OptimizeImageTransparency</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]202
203<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>
204
205<p>WARNING: This modifies the current images directly, rather than generate a new image sequence.</p>
206
207<p>The format of the OptimizeImageTransperency method is:</p>
208
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]209<pre class="text">
210void OptimizeImageTransperency(Image *image,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]211</pre>
212
213<p>A description of each parameter follows:</p>
214
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]215<dd>
216</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]217
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]218<dd> </dd>
219<dl class="dl-horizontal">
220<dt>image</dt>
221<dd>the image sequence </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]222
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]223<dd> </dd>
224<dt>exception</dt>
225<dd>return any errors or warnings in this structure. </dd>
226
227<dd> </dd>
228</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]229<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="RemoveDuplicateLayers">RemoveDuplicateLayers</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]230
231<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>
232
233<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>
234
235<p>The format of the RemoveDuplicateLayers method is:</p>
236
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]237<pre class="text">
238void RemoveDuplicateLayers(Image **image, ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]239</pre>
240
241<p>A description of each parameter follows:</p>
242
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]243<dd>
244</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]245
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]246<dd> </dd>
247<dl class="dl-horizontal">
248<dt>images</dt>
249<dd>the image list </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]250
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]251<dd> </dd>
252<dt>exception</dt>
253<dd>return any errors or warnings in this structure. </dd>
254
255<dd> </dd>
256</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]257<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="RemoveZeroDelayLayers">RemoveZeroDelayLayers</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]258
259<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>
260
261<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>
262
263<p>No warning will be given if no image was removed because all images had an appropriate non-zero time delay set.</p>
264
265<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>
266
267<p>The format of the RemoveZeroDelayLayers method is:</p>
268
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]269<pre class="text">
270void RemoveZeroDelayLayers(Image **image, ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]271</pre>
272
273<p>A description of each parameter follows:</p>
274
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]275<dd>
276</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]277
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]278<dd> </dd>
279<dl class="dl-horizontal">
280<dt>images</dt>
281<dd>the image list </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]282
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]283<dd> </dd>
284<dt>exception</dt>
285<dd>return any errors or warnings in this structure. </dd>
286
287<dd> </dd>
288</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]289<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="CompositeLayers">CompositeLayers</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]290
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]291<p>CompositeLayers() compose the source image sequence over the destination image sequence, starting with the current image in both lists.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]292
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]293<p>Each layer from the two image lists are composted together until the end of one of the image lists is reached. The offset of each composition is also adjusted to match the virtual canvas offsets of each layer. As such the given offset is relative to the virtual canvas, and not the actual image.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]294
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]295<p>Composition uses given x and y offsets, as the 'origin' location of the source images virtual canvas (not the real image) allowing you to compose a list of 'layer images' into the destiantioni images. This makes it well sutiable for directly composing 'Clears Frame Animations' or 'Coaleased Animations' onto a static or other 'Coaleased Animation' destination image list. GIF disposal handling is not looked at.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]296
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]297<p>Special case:- If one of the image sequences is the last image (just a single image remaining), that image is repeatally composed with all the images in the other image list. Either the source or destination lists may be the single image, for this situation.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]298
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]299<p>In the case of a single destination image (or last image given), that image will ve cloned to match the number of images remaining in the source image list.</p>
300
301<p>This is equivelent to the "-layer Composite" Shell API operator.</p>
302
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]303
304<p>The format of the CompositeLayers method is:</p>
305
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]306<pre class="text">
307void CompositeLayers(Image *destination, const CompositeOperator
308compose, Image *source, const ssize_t x_offset, const ssize_t y_offset,
309ExceptionInfo *exception);
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]310</pre>
311
312<p>A description of each parameter follows:</p>
313
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]314<dd>
315</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]316
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]317<dd> </dd>
318<dl class="dl-horizontal">
319<dt>destination</dt>
320<dd>the destination images and results </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]321
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]322<dd> </dd>
323<dt>source</dt>
324<dd>source image(s) for the layer composition </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]325
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]326<dd> </dd>
327<dt>compose, x_offset, y_offset</dt>
328<dd> arguments passed on to CompositeImages() </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]329
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]330<dd> </dd>
331<dt>exception</dt>
332<dd>return any errors or warnings in this structure. </dd>
333
334<dd> </dd>
335</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]336<h2><a href="http://www.imagemagick.org/api/MagickCore/layer_8c.html" id="MergeImageLayers">MergeImageLayers</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]337
338<p>MergeImageLayers() composes all the image layers from the current given image onward to produce a single image of the merged layers.</p>
339
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]340<p>The inital canvas's size depends on the given LayerMethod, and is initialized using the first images background color. The images are then compositied onto that image in sequence using the given composition that has been assigned to each individual image.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]341
342<p>The format of the MergeImageLayers is:</p>
343
344<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]345Image *MergeImageLayers(const Image *image,
346 const LayerMethod method, ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]347</pre>
348
349<p>A description of each parameter follows:</p>
350
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]351<dd>
352</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]353
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]354<dd> </dd>
355<dl class="dl-horizontal">
356<dt>image</dt>
357<dd>the image list to be composited together </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]358
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]359<dd> </dd>
360<dt>method</dt>
361<dd>the method of selecting the size of the initial canvas. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]362
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]363<dd> 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. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]364
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]365<dd> 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. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]366
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]367<dd> 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. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]368
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]369<dd> 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. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]370
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]371<dd> WARNING: a new image is not returned, the original image sequence page data is modified instead. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]372
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]373<dd> </dd>
374<dt>exception</dt>
375<dd>return any errors or warnings in this structure. </dd>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]376
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]377<dd> </dd>
378</dl>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]379</div>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]380 <footer class="magick-footer">
381 <div class="magick-nav-item navbar-left">
382 <a href="../../www/support.html">Donations</a>
383 </div>
384 <div class="magick-nav-item navbar-right">
385 <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a>
386 <noscript>
387 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
388 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>
389 </noscript>
390 </div>
391 <p><a href="../../www/sitemap.html">Sitemap</a> •
392 <a href="../../www/links.html">Related</a> •
393 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> •
394 <a href="http://jqmagick.imagemagick.org/">JqMagick</a> •
395 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
396</p>
397 <p><a href="layer.html#">Back to top</a> •
398 <a href="../../www/contact.html">Contact Us</a></p>
399 </footer>
400</div><!-- /.container -->
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]401
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]402 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
403 <script src="../../js/bootstrap.min.js"></script>
404 <script type="text/javascript">
405 /* */
406 (function() {
407 var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
408 s.type = 'text/javascript';
409 s.async = true;
410 s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
411 t.parentNode.insertBefore(s, t);
412 })();
413 /* */
414 </script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]415</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]416</body>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]417</html><!-- Magick Cache 4th May 2015 17:59 -->