granicus.if.org Git - imagemagick/blob - www/api/layer.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   7   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   8   <style type="text/css" media="screen,projection"><!--\r
   9     @import url("../../www/magick.css");\r
  10   --></style>\r
  11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  12   <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Image Layers</title>
  13   <meta http-equiv="Content-Language" content="en-US"/>
  14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="Generator" content="PHP"/>
  17   <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"/>
  18   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
  19   <meta name="Rating" content="GENERAL"/>
  20   <meta name="Robots" content="INDEX, FOLLOW"/>
  21   <meta name="Generator" content="ImageMagick Studio LLC"/>
  22   <meta name="Author" content="ImageMagick Studio LLC"/>
  23   <meta name="Revisit-after" content="2 DAYS"/>
  24   <meta name="Resource-type" content="document"/>
  25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  26   <meta name="Distribution" content="Global"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../../index.html">\r
  32   <img src="../../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../../index.html">\r
  41   <img src="../../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="eastbar">\r
  46 \r
  47 <div class="menu">
  48   <a href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
 128 </div>
 129 <div  class="sponsor">
 130   <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 134 </div>
 135 <div  class="sponsor">
 136   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 140 </div>
 141 <div  class="sponsor">
 142   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 143 </div>
 144 <div  class="sponsor">
 145    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 146 </div>
 147 </div>
 148 </div>
 149 \r
 150 \r
 151 </div>\r
 152 \r
 153 <div class="main">\r
 154 \r
 155 <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>
 156
 157 <h2><a href="http://www.imagemagick.org/api/MagickCore/layer
 158 _8c.html" target="source" name="CoalesceImages">CoalesceImages</a></h2>
 159 <div class="doc-section">
 160
 161 <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></ol>
 162
 163 <p>The format of the CoalesceImages method is:</p>
 164
 165 <pre class="code">
 166   Image *CoalesceImages(Image *image,ExceptionInfo *exception)
 167 </pre>
 168
 169 <p>A description of each parameter follows:</p></ol>
 170
 171 <h5>image</h5>
 172 <ol><p>the image sequence.</p></ol>
 173
 174 <h5>exception</h5>
 175 <ol><p>return any errors or warnings in this structure.</p></ol>
 176
 177  </div>
 178 <h2><a href="http://www.imagemagick.org/api/MagickCore/layer
 179 _8c.html" target="source" name="DisposeImages">DisposeImages</a></h2>
 180 <div class="doc-section">
 181
 182 <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></ol>
 183
 184 <p>The format of the DisposeImages method is:</p>
 185
 186 <pre class="code">
 187   Image *DisposeImages(Image *image,ExceptionInfo *exception)
 188 </pre>
 189
 190 <p>A description of each parameter follows:</p></ol>
 191
 192 <h5>image</h5>
 193 <ol><p>the image sequence.</p></ol>
 194
 195 <h5>exception</h5>
 196 <ol><p>return any errors or warnings in this structure.</p></ol>
 197
 198  </div>
 199 <h2><a href="http://www.imagemagick.org/api/MagickCore/layer
 200 _8c.html" target="source" name="CompareImageLayers">CompareImageLayers</a></h2>
 201 <div class="doc-section">
 202
 203 <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></ol>
 204
 205 <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></ol>
 206
 207 <p>No GIF dispose methods are applied, so GIF animations must be coalesced before applying this image operator to find differences to them.</p></ol>
 208
 209 <p>The format of the CompareImageLayers method is:</p>
 210
 211 <pre class="code">
 212   Image *CompareImageLayers(const Image *images,
 213     const ImageLayerMethod method,ExceptionInfo *exception)
 214 </pre>
 215
 216 <p>A description of each parameter follows:</p></ol>
 217
 218 <h5>image</h5>
 219 <ol><p>the image.</p></ol>
 220
 221 <h5>method</h5>
 222 <ol><p>the layers type to compare images with. Must be one of... CompareAnyLayer, CompareClearLayer, CompareOverlayLayer.</p></ol>
 223
 224 <h5>exception</h5>
 225 <ol><p>return any errors or warnings in this structure.</p></ol>
 226
 227  </div>
 228 <h2><a href="http://www.imagemagick.org/api/MagickCore/layer
 229 _8c.html" target="source" name="DeconstructImages">DeconstructImages</a></h2>
 230 <div class="doc-section">
 231
 232 <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></ol>
 233
 234 <p>This function is deprecated in favor of the more universal CompareImageLayers() function.</p></ol>
 235
 236 <p>The format of the DeconstructImages method is:</p>
 237
 238 <pre class="code">
 239   Image *DeconstructImages(const Image *images, ExceptionInfo *exception)
 240 </pre>
 241
 242 <p>A description of each parameter follows:</p></ol>
 243
 244 <h5>image</h5>
 245 <ol><p>the image.</p></ol>
 246
 247 <h5>exception</h5>
 248 <ol><p>return any errors or warnings in this structure.</p></ol>
 249
 250  </div>
 251 <h2><a href="http://www.imagemagick.org/api/MagickCore/layer
 252 _8c.html" target="source" name="OptimizeImageLayers">OptimizeImageLayers</a></h2>
 253 <div class="doc-section">
 254
 255 <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></ol>
 256
 257 <p>The format of the OptimizeImageLayers method is:</p>
 258
 259 <pre class="code">
 260   Image *OptimizeImageLayers(const Image *image,
 261            ExceptionInfo *exception)
 262 </pre>
 263
 264 <p>A description of each parameter follows:</p></ol>
 265
 266 <h5>image</h5>
 267 <ol><p>the image.</p></ol>
 268
 269 <h5>exception</h5>
 270 <ol><p>return any errors or warnings in this structure.</p></ol>
 271
 272  </div>
 273 <h2><a href="http://www.imagemagick.org/api/MagickCore/layer
 274 _8c.html" target="source" name="OptimizeImagePlusLayers">OptimizeImagePlusLayers</a></h2>
 275 <div class="doc-section">
 276
 277 <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></ol>
 278
 279 <p>The format of the OptimizePlusImageLayers method is:</p>
 280
 281 <pre class="code">
 282   Image *OptimizePlusImageLayers(const Image *image,
 283            ExceptionInfo *exception)
 284 </pre>
 285
 286 <p>A description of each parameter follows:</p></ol>
 287
 288 <h5>image</h5>
 289 <ol><p>the image.</p></ol>
 290
 291 <h5>exception</h5>
 292 <ol><p>return any errors or warnings in this structure.</p></ol>
 293
 294  </div>
 295 <h2><a href="http://www.imagemagick.org/api/MagickCore/layer
 296 _8c.html" target="source" name="OptimizeImageTransparency">OptimizeImageTransparency</a></h2>
 297 <div class="doc-section">
 298
 299 <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></ol>
 300
 301 <p>WARNING: This modifies the current images directly, rather than generate a new image sequence.</p></ol>
 302
 303 <p>The format of the OptimizeImageTransperency method is:</p>
 304
 305 <pre class="code">
 306   void OptimizeImageTransperency(Image *image,ExceptionInfo *exception)
 307 </pre>
 308
 309 <p>A description of each parameter follows:</p></ol>
 310
 311 <h5>image</h5>
 312 <ol><p>the image sequence</p></ol>
 313
 314 <h5>exception</h5>
 315 <ol><p>return any errors or warnings in this structure.</p></ol>
 316
 317  </div>
 318 <h2><a href="http://www.imagemagick.org/api/MagickCore/layer
 319 _8c.html" target="source" name="RemoveDuplicateLayers">RemoveDuplicateLayers</a></h2>
 320 <div class="doc-section">
 321
 322 <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></ol>
 323
 324 <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></ol>
 325
 326 <p>The format of the RemoveDuplicateLayers method is:</p>
 327
 328 <pre class="code">
 329   void RemoveDuplicateLayers(Image **image, ExceptionInfo *exception)
 330 </pre>
 331
 332 <p>A description of each parameter follows:</p></ol>
 333
 334 <h5>images</h5>
 335 <ol><p>the image list</p></ol>
 336
 337 <h5>exception</h5>
 338 <ol><p>return any errors or warnings in this structure.</p></ol>
 339
 340  </div>
 341 <h2><a href="http://www.imagemagick.org/api/MagickCore/layer
 342 _8c.html" target="source" name="RemoveZeroDelayLayers">RemoveZeroDelayLayers</a></h2>
 343 <div class="doc-section">
 344
 345 <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></ol>
 346
 347 <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></ol>
 348
 349 <p>No warning will be given if no image was removed because all images had an appropriate non-zero time delay set.</p></ol>
 350
 351 <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></ol>
 352
 353 <p>The format of the RemoveZeroDelayLayers method is:</p>
 354
 355 <pre class="code">
 356   void RemoveZeroDelayLayers(Image **image, ExceptionInfo *exception)
 357 </pre>
 358
 359 <p>A description of each parameter follows:</p></ol>
 360
 361 <h5>images</h5>
 362 <ol><p>the image list</p></ol>
 363
 364 <h5>exception</h5>
 365 <ol><p>return any errors or warnings in this structure.</p></ol>
 366
 367  </div>
 368 <h2><a href="http://www.imagemagick.org/api/MagickCore/layer
 369 _8c.html" target="source" name="CompositeLayers">CompositeLayers</a></h2>
 370 <div class="doc-section">
 371
 372 <p>CompositeLayers() compose first image sequence (source) over the second image sequence (destination), using the given compose method and offsets.</p></ol>
 373
 374 <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></ol>
 375
 376 <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></ol>
 377
 378 <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></ol>
 379
 380 <p>The destination list will be expanded as needed to match number of source image overlaid (from current position to end of list).</p></ol>
 381
 382 <p>The format of the CompositeLayers method is:</p>
 383
 384 <pre class="code">
 385   void CompositeLayers(Image *destination,
 386       const CompositeOperator compose, Image *source,
 387       const long x_offset, const long y_offset,
 388       ExceptionInfo *exception);
 389 </pre>
 390
 391 <p>A description of each parameter follows:</p></ol>
 392
 393 <h5>destination</h5>
 394 <ol><p>the destination images and results</p></ol>
 395
 396 <h5>source</h5>
 397 <ol><p>source image(s) for the layer composition</p></ol>
 398
 399 <h5>compose, x_offset, y_offset</h5>
 400 <ol><p>arguments passed on to CompositeImages()</p></ol>
 401
 402 <h5>exception</h5>
 403 <ol><p>return any errors or warnings in this structure.</p></ol>
 404
 405  </div>
 406 <h2><a href="http://www.imagemagick.org/api/MagickCore/layer
 407 _8c.html" target="source" name="MergeImageLayers">MergeImageLayers</a></h2>
 408 <div class="doc-section">
 409
 410 <p>MergeImageLayers() composes all the image layers from the current given image onward to produce a single image of the merged layers.</p></ol>
 411
 412 <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></ol>
 413
 414 <p>The format of the MergeImageLayers is:</p>
 415
 416 <pre class="text">
 417   Image *MergeImageLayers(const Image *image,
 418     const ImageLayerMethod method, ExceptionInfo *exception)
 419 </pre>
 420
 421 <p>A description of each parameter follows:</p></ol>
 422
 423 <h5>image</h5>
 424 <ol><p>the image list to be composited together</p></ol>
 425
 426 <h5>method</h5>
 427 <ol><p>the method of selecting the size of the initial canvas.</p></ol>
 428
 429 <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></ol>
 430
 431 <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></ol>
 432
 433 <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></ol>
 434
 435 <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></ol>
 436
 437 <p>WARNING: a new image is not returned, the original image sequence page data is modified instead.</p></ol>
 438
 439 <h5>exception</h5>
 440 <ol><p>return any errors or warnings in this structure.</p></ol>
 441
 442  </div>
 443 \r
 444 </div>\r
 445 \r
 446 <div id="linkbar">\r
 447  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 448     <span id="linkbar-center">\r
 449       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 450     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 451     </span>\r
 452     <span id="linkbar-east">&nbsp;</span>\r
 453   </div>\r
 454   <div class="footer">\r
 455     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 456     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 457   </div>\r
 458   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 459 </body>\r
 460 </html>\r