Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 29c5c99deece75077feef1d1eccd65dc27ac455c / . / www / api / list.html
blob: 3ec0dfce9125fb75485802cdae9d050a299e72a9 [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: Working with Image Lists</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:, working, with, image, lists, 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 Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]198</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]199<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]200 <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]201</div>
202<div class="sponsor">
cristy9be3b602011-06-16 01:35:51 +0000[diff] [blame]203 <a rel="follow" title="Sponsor: Autoteile Online Shop" href="http://www.autoteile-carparts.de">Autoteile Online Shop</a><!-- 2011080100030 autoteile-Carparts-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]204</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]205</div>
206</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]207</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]208
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]209<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame^]210<div style="margin: 9pt 9pt 9pt 9pt;">
211 <div class="g-plusone" data-size="standard" data-count="false"></div>
212</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]213</div>
214
215<div class="main">
216
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]217<h1>Module list Methods</h1>
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]218<p class="navigation-index">[<a href="#AppendImageToList">AppendImageToList</a> &bull; <a href="#CloneImageList">CloneImageList</a> &bull; <a href="#CloneImages">CloneImages</a> &bull; <a href="#DeleteImageFromList">DeleteImageFromList</a> &bull; <a href="#DeleteImages">DeleteImages</a> &bull; <a href="#DestroyImageList">DestroyImageList</a> &bull; <a href="#DuplicateImages">DuplicateImages</a> &bull; <a href="#GetFirstImageInList">GetFirstImageInList</a> &bull; <a href="#GetImageFromList">GetImageFromList</a> &bull; <a href="#GetImageIndexInList">GetImageIndexInList</a> &bull; <a href="#GetImageListLength">GetImageListLength</a> &bull; <a href="#GetLastImageInList">GetLastImageInList</a> &bull; <a href="#GetNextImageInList">GetNextImageInList</a> &bull; <a href="#GetPreviousImageInList">GetPreviousImageInList</a> &bull; <a href="#ImageListToArray">ImageListToArray</a> &bull; <a href="#InsertImageInList">InsertImageInList</a> &bull; <a href="#NewImageList">NewImageList</a> &bull; <a href="#PrependImageToList">PrependImageToList</a> &bull; <a href="#RemoveImageFromList">RemoveImageFromList</a> &bull; <a href="#RemoveFirstImageFromList">RemoveFirstImageFromList</a> &bull; <a href="#RemoveLastImageFromList">RemoveLastImageFromList</a> &bull; <a href="#ReplaceImageInList">ReplaceImageInList</a> &bull; <a href="#ReplaceImageInListReturnLast">ReplaceImageInListReturnLast</a> &bull; <a href="#ReverseImageList">ReverseImageList</a> &bull; <a href="#SpliceImageIntoList">SpliceImageIntoList</a> &bull; <a href="#SplitImageList">SplitImageList</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]219
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]220<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="AppendImageToList">AppendImageToList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]221<div class="doc-section">
222
223<p>AppendImageToList() appends the second image list to the end of the first list. The given image list pointer is left unchanged, unless it was empty.</p>
224
225<p>The format of the AppendImageToList method is:</p>
226
227<pre class="code">
228 AppendImageToList(Image *images,const Image *image)
229</pre>
230
231<p>A description of each parameter follows:</p>
232
233<h5>images</h5>
234<p>the image list to be appended to.</p>
235
236<h5>image</h5>
237<p>the appended image or image list.</p>
238
239 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]240<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="CloneImageList">CloneImageList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]241<div class="doc-section">
242
243<p>CloneImageList() returns a duplicate of the image list.</p>
244
245<p>The format of the CloneImageList method is:</p>
246
247<pre class="code">
248 Image *CloneImageList(const Image *images,ExceptionInfo *exception)
249</pre>
250
251<p>A description of each parameter follows:</p>
252
253<h5>images</h5>
254<p>the image list.</p>
255
256<h5>exception</h5>
257<p>return any errors or warnings in this structure.</p>
258
259 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]260<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="CloneImages">CloneImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]261<div class="doc-section">
262
263<p>CloneImages() clones one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
264
265<p>The numbers start at 0 for the first image in the list, while negative numbers refer to images starting counting from the end of the range. Images may be refered to multiple times to clone them multiple times. Images refered beyond the available number of images in list are ignored.</p>
266
267<p>Images referenced may be reversed, and results in a clone of those images also being made with a reversed order.</p>
268
269<p>The format of the CloneImages method is:</p>
270
271<pre class="code">
272 Image *CloneImages(const Image *images,const char *scenes,
273 ExceptionInfo *exception)
274</pre>
275
276<p>A description of each parameter follows:</p>
277
278<h5>images</h5>
279<p>the image sequence.</p>
280
281<h5>scenes</h5>
282<p>This character string specifies which scenes to clone (e.g. 1,3-5,7-3,2).</p>
283
284<h5>exception</h5>
285<p>return any errors or warnings in this structure.</p>
286
287 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]288<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DeleteImageFromList">DeleteImageFromList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]289<div class="doc-section">
290
291<p>DeleteImageFromList() deletes an image from the list. List pointer is moved to the next image, if one is present. See RemoveImageFromList().</p>
292
293<p>The format of the DeleteImageFromList method is:</p>
294
295<pre class="code">
296 DeleteImageFromList(Image **images)
297</pre>
298
299<p>A description of each parameter follows:</p>
300
301<h5>images</h5>
302<p>the image list.</p>
303
304 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]305<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DeleteImages">DeleteImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]306<div class="doc-section">
307
308<p>DeleteImages() deletes one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
309
310<p>The numbers start at 0 for the first image, while negative numbers refer to images starting counting from the end of the range. Images may be refered to multiple times without problems. Image refered beyond the available number of images in list are ignored.</p>
311
cristy323f35b2011-03-24 23:05:13 +0000[diff] [blame]312<p>If the referenced images are in the reverse order, that range will be completely ignored, unlike CloneImages().</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]313
314<p>The format of the DeleteImages method is:</p>
315
316<pre class="code">
317 DeleteImages(Image **images,const char *scenes,ExceptionInfo *exception)
318</pre>
319
320<p>A description of each parameter follows:</p>
321
322<h5>images</h5>
323<p>the image sequence.</p>
324
325<h5>scenes</h5>
326<p>This character string specifies which scenes to delete (e.g. 1,3-5,-2-6,2).</p>
327
328<h5>exception</h5>
329<p>return any errors or warnings in this structure.</p>
330
331 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]332<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DestroyImageList">DestroyImageList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]333<div class="doc-section">
334
335<p>DestroyImageList() destroys an image list.</p>
336
337<p>The format of the DestroyImageList method is:</p>
338
339<pre class="code">
340 Image *DestroyImageList(Image *image)
341</pre>
342
343<p>A description of each parameter follows:</p>
344
345<h5>image</h5>
346<p>the image sequence.</p>
347
348 </div>
cristy323f35b2011-03-24 23:05:13 +0000[diff] [blame]349<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DuplicateImages">DuplicateImages</a></h2>
350<div class="doc-section">
351
352<p>DuplicateImages() duplicates one or more images from an image sequence, using a count and a comma separated list of image numbers or ranges.</p>
353
354<p>The numbers start at 0 for the first image, while negative numbers refer to images starting counting from the end of the range. Images may be refered to multiple times without problems. Image refered beyond the available number of images in list are ignored.</p>
355
356<p>The format of the DuplicateImages method is:</p>
357
358<pre class="code">
359 Image *DuplicateImages(Image *images,const size_t number_duplicates,
360 const char *scenes,ExceptionInfo *exception)
361</pre>
362
363<p>A description of each parameter follows:</p>
364
365<h5>images</h5>
366<p>the image sequence.</p>
367
368<h5>number_duplicates</h5>
369<p>duplicate the image sequence this number of times.</p>
370
371<h5>scenes</h5>
372<p>This character string specifies which scenes to duplicate (e.g. 1,3-5,-2-6,2).</p>
373
374<h5>exception</h5>
375<p>return any errors or warnings in this structure.</p>
376
377 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]378<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetFirstImageInList">GetFirstImageInList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]379<div class="doc-section">
380
381<p>GetFirstImageInList() returns a pointer to the first image in the list.</p>
382
383<p>The format of the GetFirstImageInList method is:</p>
384
385<pre class="code">
386 Image *GetFirstImageInList(const Image *images)
387</pre>
388
389<p>A description of each parameter follows:</p>
390
391<h5>images</h5>
392<p>the image list.</p>
393
394 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]395<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageFromList">GetImageFromList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]396<div class="doc-section">
397
398<p>GetImageFromList() returns an image at the specified offset from the list.</p>
399
400<p>The format of the GetImageFromList method is:</p>
401
402<pre class="code">
403 Image *GetImageFromList(const Image *images,const ssize_t index)
404</pre>
405
406<p>A description of each parameter follows:</p>
407
408<h5>images</h5>
409<p>the image list.</p>
410
411<h5>index</h5>
412<p>the position within the list.</p>
413
414 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]415<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageIndexInList">GetImageIndexInList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]416<div class="doc-section">
417
418<p>GetImageIndexInList() returns the offset in the list of the specified image.</p>
419
420<p>The format of the GetImageIndexInList method is:</p>
421
422<pre class="code">
423 ssize_t GetImageIndexInList(const Image *images)
424</pre>
425
426<p>A description of each parameter follows:</p>
427
428<h5>images</h5>
429<p>the image list.</p>
430
431 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]432<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageListLength">GetImageListLength</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]433<div class="doc-section">
434
435<p>GetImageListLength() returns the length of the list (the number of images in the list).</p>
436
437<p>The format of the GetImageListLength method is:</p>
438
439<pre class="code">
440 size_t GetImageListLength(const Image *images)
441</pre>
442
443<p>A description of each parameter follows:</p>
444
445<h5>images</h5>
446<p>the image list.</p>
447
448 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]449<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetLastImageInList">GetLastImageInList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]450<div class="doc-section">
451
452<p>GetLastImageInList() returns a pointer to the last image in the list.</p>
453
454<p>The format of the GetLastImageInList method is:</p>
455
456<pre class="code">
457 Image *GetLastImageInList(const Image *images)
458</pre>
459
460<p>A description of each parameter follows:</p>
461
462<h5>images</h5>
463<p>the image list.</p>
464
465 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]466<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetNextImageInList">GetNextImageInList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]467<div class="doc-section">
468
469<p>GetNextImageInList() returns the next image in the list.</p>
470
471<p>The format of the GetNextImageInList method is:</p>
472
473<pre class="code">
474 Image *GetNextImageInList(const Image *images)
475</pre>
476
477<p>A description of each parameter follows:</p>
478
479<h5>images</h5>
480<p>the image list.</p>
481
482 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]483<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetPreviousImageInList">GetPreviousImageInList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]484<div class="doc-section">
485
486<p>GetPreviousImageInList() returns the previous image in the list.</p>
487
488<p>The format of the GetPreviousImageInList method is:</p>
489
490<pre class="code">
491 Image *GetPreviousImageInList(const Image *images)
492</pre>
493
494<p>A description of each parameter follows:</p>
495
496<h5>images</h5>
497<p>the image list.</p>
498
499 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]500<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ImageListToArray">ImageListToArray</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]501<div class="doc-section">
502
503<p>ImageListToArray() is a convenience method that converts an image list to a sequential array. For example,</p>
504
505<p>group = ImageListToArray(images, exception); while (i = 0; group[i] != (Image *) NULL; i++) printf("s\n", group[i]->filename); printf("d images\n", i); group = RelinquishMagickMemory(group);</p>
506
507<p>The format of the ImageListToArray method is:</p>
508
509<pre class="code">
510 Image **ImageListToArray(const Image *images,ExceptionInfo *exception)
511</pre>
512
513<p>A description of each parameter follows:</p>
514
515<h5>image</h5>
516<p>the image list.</p>
517
518<h5>exception</h5>
519<p>return any errors or warnings in this structure.</p>
520
521 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]522<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="InsertImageInList">InsertImageInList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]523<div class="doc-section">
524
525<p>InsertImageInList() inserts the second image or image list into the first image list immediately after the image pointed to. The given image list pointer is unchanged unless previously empty.</p>
526
527<p>The format of the InsertImageInList method is:</p>
528
529<pre class="code">
530 InsertImageInList(Image **images,Image *image)
531</pre>
532
533<p>A description of each parameter follows:</p>
534
535<h5>images</h5>
536<p>the image list to insert into.</p>
537
538<h5>image</h5>
539<p>the image list to insert.</p>
540
541 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]542<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="NewImageList">NewImageList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]543<div class="doc-section">
544
545<p>NewImageList() creates an empty image list.</p>
546
547<p>The format of the NewImageList method is:</p>
548
549<pre class="code">
550 Image *NewImageList(void)
551</pre>
552
553 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]554<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="PrependImageToList">PrependImageToList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]555<div class="doc-section">
556
557<p>PrependImageToList() prepends the image to the beginning of the list.</p>
558
559<p>The format of the PrependImageToList method is:</p>
560
561<pre class="code">
562 PrependImageToList(Image *images,Image *image)
563</pre>
564
565<p>A description of each parameter follows:</p>
566
567<h5>images</h5>
568<p>the image list.</p>
569
570<h5>image</h5>
571<p>the image.</p>
572
573 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]574<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveImageFromList">RemoveImageFromList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]575<div class="doc-section">
576
577<p>RemoveImageFromList() removes and returns the image pointed to.</p>
578
579<p>The given image list pointer is set to point to the next image in list if it exists, otherwise it is set to the previous image, or NULL if list was emptied.</p>
580
581<p>The format of the RemoveImageFromList method is:</p>
582
583<pre class="code">
584 Image *RemoveImageFromList(Image **images)
585</pre>
586
587<p>A description of each parameter follows:</p>
588
589<h5>images</h5>
590<p>the image list.</p>
591
592 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]593<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveFirstImageFromList">RemoveFirstImageFromList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]594<div class="doc-section">
595
596<p>RemoveFirstImageFromList() removes and returns the first image in the list.</p>
597
598<p>If the given image list pointer pointed to the removed first image, it is set to the new first image of list, or NULL if list was emptied, otherwise it is left as is.</p>
599
600<p>The format of the RemoveFirstImageFromList method is:</p>
601
602<pre class="code">
603 Image *RemoveFirstImageFromList(Image **images)
604</pre>
605
606<p>A description of each parameter follows:</p>
607
608<h5>images</h5>
609<p>the image list.</p>
610
611 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]612<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveLastImageFromList">RemoveLastImageFromList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]613<div class="doc-section">
614
615<p>RemoveLastImageFromList() removes and returns the last image from the list.</p>
616
617<p>If the given image list pointer pointed to the removed last image, it is set to the new last image of list, or NULL if list was emptied, otherwise it is left as is.</p>
618
619<p>The format of the RemoveLastImageFromList method is:</p>
620
621<pre class="code">
622 Image *RemoveLastImageFromList(Image **images)
623</pre>
624
625<p>A description of each parameter follows:</p>
626
627<h5>images</h5>
628<p>the image list.</p>
629
630 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]631<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReplaceImageInList">ReplaceImageInList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]632<div class="doc-section">
633
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]634<p>ReplaceImageInList() replaces an image in the list with the given image, or list of images. Old image is destroyed. The image list pointer is set to point to the first image of the inserted list of images.</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]635
636<p>The format of the ReplaceImageInList method is:</p>
637
638<pre class="code">
639 ReplaceImageInList(Image **images,Image *image)
640</pre>
641
642<p>A description of each parameter follows:</p>
643
644<h5>images</h5>
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]645<p>the list and pointer to image to replace</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]646
647<h5>image</h5>
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]648<p>the image or image list replacing the original</p>
649
650 </div>
651<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReplaceImageInListReturnLast">ReplaceImageInListReturnLast</a></h2>
652<div class="doc-section">
653
654<p>ReplaceImageInListReturnLast() is exactly as ReplaceImageInList() except the image pointer is set to the last image in the list.</p>
655
656<p>This allows you to simply use 'next' to go to the image that follows the just replaced image.</p>
657
658<p>The format of the ReplaceImageInList method is:</p>
659
660<pre class="code">
661 ReplaceImageInListReturnLast(Image **images,Image *image)
662</pre>
663
664<p>A description of each parameter follows:</p>
665
666<h5>images</h5>
667<p>the list and pointer to image to replace</p>
668
669<h5>image</h5>
670<p>the image or image list replacing the original</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]671
672 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]673<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReverseImageList">ReverseImageList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]674<div class="doc-section">
675
676<p>ReverseImageList() reverses the order of an image list. The list pointer is reset to that start of the re-ordered list.</p>
677
678<p>The format of the ReverseImageList method is:</p>
679
680<pre class="code">
681 void ReverseImageList(Image **images)
682</pre>
683
684<p>A description of each parameter follows:</p>
685
686<h5>images</h5>
687<p>the image list.</p>
688
689 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]690<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="SpliceImageIntoList">SpliceImageIntoList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]691<div class="doc-section">
692
693<p>SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice. Removed images are returned.</p>
694
695<p>The format of the SpliceImageIntoList method is:</p>
696
697<pre class="code">
698 SpliceImageIntoList(Image **images,const size_t,
699 const Image *splice)
700</pre>
701
702<p>A description of each parameter follows:</p>
703
704<h5>images</h5>
705<p>the image list.</p>
706
707<h5>length</h5>
708<p>the length of the image list to remove.</p>
709
710<h5>splice</h5>
711<p>Replace the removed image list with this list.</p>
712
713 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]714<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="SplitImageList">SplitImageList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]715<div class="doc-section">
716
717<p>SplitImageList() splits an image into two lists, after given image The list that was split off is returned, which may be empty.</p>
718
719<p>The format of the SplitImageList method is:</p>
720
721<pre class="code">
722 Image *SplitImageList(Image *images)
723</pre>
724
725<p>A description of each parameter follows:</p>
726
727<h5>images</h5>
728<p>the image list.</p>
729
730 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]731
732</div>
733
734<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]735 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]736 <span id="linkbar-center">
737 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]738 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]739 </span>
740 <span id="linkbar-east">&nbsp;</span>
741 </div>
742 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]743 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]744 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
745 </div>
746 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]747 <script type="text/javascript">
748 var _gaq = _gaq || [];
749 _gaq.push(['_setAccount', 'UA-17690367-1']);
750 _gaq.push(['_trackPageview']);
751
752 (function() {
753 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
754 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
755 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
756 })();
757 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]758</body>
759</html>