Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / ce69bb0630da050618321fbefe3c5010e5414c3d / . / www / api / list.html
blob: 4545529ee393e7c53a99020265410713b3f3a37d [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]8 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]9 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]10 </style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]11 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Working with Image Lists</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:, working, with, image, lists, 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"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]45<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]52 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
53</div>
54<div class="sub">
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
62</div>
63<div class="sep"></div>
64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]91<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124
125<div class="sponsbox">
126<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyc49f7992009-09-22 22:48:40 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]142 <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144</div>
145</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]147
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]148<div class="eastbar">
149 <script type="text/javascript">
150 <!--
151 google_ad_client = "pub-3129977114552745";
152 /* 160x600, created 7/27/10 */
153 google_ad_slot = "0574824969";
154 google_ad_width = 160;
155 google_ad_height = 600;
156 //-->
157 </script>
158 <script type="text/javascript"
159 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
160 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]161</div>
162
163<div class="main">
164
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]165<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="#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="#ReverseImageList">ReverseImageList</a> &bull; <a href="#SpliceImageIntoList">SpliceImageIntoList</a> &bull; <a href="#SplitImageList">SplitImageList</a>]</p>
166
167<h2><a href="http://www.imagemagick.org/api/MagickCore/list
168_8c.html" target="source" name="AppendImageToList">AppendImageToList</a></h2>
169<div class="doc-section">
170
171<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></ol>
172
173<p>The format of the AppendImageToList method is:</p>
174
175<pre class="code">
176 AppendImageToList(Image *images,const Image *image)
177</pre>
178
179<p>A description of each parameter follows:</p></ol>
180
181<h5>images</h5>
182<ol><p>the image list to be appended to.</p></ol>
183
184<h5>image</h5>
185<ol><p>the appended image or image list.</p></ol>
186
187 </div>
188<h2><a href="http://www.imagemagick.org/api/MagickCore/list
189_8c.html" target="source" name="CloneImageList">CloneImageList</a></h2>
190<div class="doc-section">
191
192<p>CloneImageList() returns a duplicate of the image list.</p></ol>
193
194<p>The format of the CloneImageList method is:</p>
195
196<pre class="code">
197 Image *CloneImageList(const Image *images,ExceptionInfo *exception)
198</pre>
199
200<p>A description of each parameter follows:</p></ol>
201
202<h5>images</h5>
203<ol><p>the image list.</p></ol>
204
205<h5>exception</h5>
206<ol><p>return any errors or warnings in this structure.</p></ol>
207
208 </div>
209<h2><a href="http://www.imagemagick.org/api/MagickCore/list
210_8c.html" target="source" name="CloneImages">CloneImages</a></h2>
211<div class="doc-section">
212
213<p>CloneImages() clones one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p></ol>
214
215<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></ol>
216
217<p>Images referenced may be reversed, and results in a clone of those images also being made with a reversed order.</p></ol>
218
219<p>The format of the CloneImages method is:</p>
220
221<pre class="code">
222 Image *CloneImages(const Image *images,const char *scenes,
223 ExceptionInfo *exception)
224</pre>
225
226<p>A description of each parameter follows:</p></ol>
227
228<h5>images</h5>
229<ol><p>the image sequence.</p></ol>
230
231<h5>scenes</h5>
232<ol><p>This character string specifies which scenes to clone (e.g. 1,3-5,7-3,2).</p></ol>
233
234<h5>exception</h5>
235<ol><p>return any errors or warnings in this structure.</p></ol>
236
237 </div>
238<h2><a href="http://www.imagemagick.org/api/MagickCore/list
239_8c.html" target="source" name="DeleteImageFromList">DeleteImageFromList</a></h2>
240<div class="doc-section">
241
242<p>DeleteImageFromList() deletes an image from the list. List pointer is moved to the next image, if one is present. See RemoveImageFromList().</p></ol>
243
244<p>The format of the DeleteImageFromList method is:</p>
245
246<pre class="code">
247 DeleteImageFromList(Image **images)
248</pre>
249
250<p>A description of each parameter follows:</p></ol>
251
252<h5>images</h5>
253<ol><p>the image list.</p></ol>
254
255 </div>
256<h2><a href="http://www.imagemagick.org/api/MagickCore/list
257_8c.html" target="source" name="DeleteImages">DeleteImages</a></h2>
258<div class="doc-section">
259
260<p>DeleteImages() deletes one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p></ol>
261
262<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></ol>
263
264<p>If the referenced images are in the reverse order, that range will be completely ignored. Unlike CloneImages().</p></ol>
265
266<p>The format of the DeleteImages method is:</p>
267
268<pre class="code">
269 DeleteImages(Image **images,const char *scenes,ExceptionInfo *exception)
270</pre>
271
272<p>A description of each parameter follows:</p></ol>
273
274<h5>images</h5>
275<ol><p>the image sequence.</p></ol>
276
277<h5>scenes</h5>
278<ol><p>This character string specifies which scenes to delete (e.g. 1,3-5,-2-6,2).</p></ol>
279
280<h5>exception</h5>
281<ol><p>return any errors or warnings in this structure.</p></ol>
282
283 </div>
284<h2><a href="http://www.imagemagick.org/api/MagickCore/list
285_8c.html" target="source" name="DestroyImageList">DestroyImageList</a></h2>
286<div class="doc-section">
287
288<p>DestroyImageList() destroys an image list.</p></ol>
289
290<p>The format of the DestroyImageList method is:</p>
291
292<pre class="code">
293 Image *DestroyImageList(Image *image)
294</pre>
295
296<p>A description of each parameter follows:</p></ol>
297
298<h5>image</h5>
299<ol><p>the image sequence.</p></ol>
300
301 </div>
302<h2><a href="http://www.imagemagick.org/api/MagickCore/list
303_8c.html" target="source" name="GetFirstImageInList">GetFirstImageInList</a></h2>
304<div class="doc-section">
305
306<p>GetFirstImageInList() returns a pointer to the first image in the list.</p></ol>
307
308<p>The format of the GetFirstImageInList method is:</p>
309
310<pre class="code">
311 Image *GetFirstImageInList(const Image *images)
312</pre>
313
314<p>A description of each parameter follows:</p></ol>
315
316<h5>images</h5>
317<ol><p>the image list.</p></ol>
318
319 </div>
320<h2><a href="http://www.imagemagick.org/api/MagickCore/list
321_8c.html" target="source" name="GetImageFromList">GetImageFromList</a></h2>
322<div class="doc-section">
323
324<p>GetImageFromList() returns an image at the specified offset from the list.</p></ol>
325
326<p>The format of the GetImageFromList method is:</p>
327
328<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]329 Image *GetImageFromList(const Image *images,const ssize_t index)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>index</h5>
338<ol><p>the position within the list.</p></ol>
339
340 </div>
341<h2><a href="http://www.imagemagick.org/api/MagickCore/list
342_8c.html" target="source" name="GetImageIndexInList">GetImageIndexInList</a></h2>
343<div class="doc-section">
344
345<p>GetImageIndexInList() returns the offset in the list of the specified image.</p></ol>
346
347<p>The format of the GetImageIndexInList method is:</p>
348
349<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]350 ssize_t GetImageIndexInList(const Image *images)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]351</pre>
352
353<p>A description of each parameter follows:</p></ol>
354
355<h5>images</h5>
356<ol><p>the image list.</p></ol>
357
358 </div>
359<h2><a href="http://www.imagemagick.org/api/MagickCore/list
360_8c.html" target="source" name="GetImageListLength">GetImageListLength</a></h2>
361<div class="doc-section">
362
363<p>GetImageListLength() returns the length of the list (the number of images in the list).</p></ol>
364
365<p>The format of the GetImageListLength method is:</p>
366
367<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]368 size_t GetImageListLength(const Image *images)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]369</pre>
370
371<p>A description of each parameter follows:</p></ol>
372
373<h5>images</h5>
374<ol><p>the image list.</p></ol>
375
376 </div>
377<h2><a href="http://www.imagemagick.org/api/MagickCore/list
378_8c.html" target="source" name="GetLastImageInList">GetLastImageInList</a></h2>
379<div class="doc-section">
380
381<p>GetLastImageInList() returns a pointer to the last image in the list.</p></ol>
382
383<p>The format of the GetLastImageInList method is:</p>
384
385<pre class="code">
386 Image *GetLastImageInList(const Image *images)
387</pre>
388
389<p>A description of each parameter follows:</p></ol>
390
391<h5>images</h5>
392<ol><p>the image list.</p></ol>
393
394 </div>
395<h2><a href="http://www.imagemagick.org/api/MagickCore/list
396_8c.html" target="source" name="GetNextImageInList">GetNextImageInList</a></h2>
397<div class="doc-section">
398
399<p>GetNextImageInList() returns the next image in the list.</p></ol>
400
401<p>The format of the GetNextImageInList method is:</p>
402
403<pre class="code">
404 Image *GetNextImageInList(const Image *images)
405</pre>
406
407<p>A description of each parameter follows:</p></ol>
408
409<h5>images</h5>
410<ol><p>the image list.</p></ol>
411
412 </div>
413<h2><a href="http://www.imagemagick.org/api/MagickCore/list
414_8c.html" target="source" name="GetPreviousImageInList">GetPreviousImageInList</a></h2>
415<div class="doc-section">
416
417<p>GetPreviousImageInList() returns the previous image in the list.</p></ol>
418
419<p>The format of the GetPreviousImageInList method is:</p>
420
421<pre class="code">
422 Image *GetPreviousImageInList(const Image *images)
423</pre>
424
425<p>A description of each parameter follows:</p></ol>
426
427<h5>images</h5>
428<ol><p>the image list.</p></ol>
429
430 </div>
431<h2><a href="http://www.imagemagick.org/api/MagickCore/list
432_8c.html" target="source" name="ImageListToArray">ImageListToArray</a></h2>
433<div class="doc-section">
434
435<p>ImageListToArray() is a convenience method that converts an image list to a sequential array. For example,</p></ol>
436
437<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></ol>
438
439<p>The format of the ImageListToArray method is:</p>
440
441<pre class="code">
442 Image **ImageListToArray(const Image *images,ExceptionInfo *exception)
443</pre>
444
445<p>A description of each parameter follows:</p></ol>
446
447<h5>image</h5>
448<ol><p>the image list.</p></ol>
449
450<h5>exception</h5>
451<ol><p>return any errors or warnings in this structure.</p></ol>
452
453 </div>
454<h2><a href="http://www.imagemagick.org/api/MagickCore/list
455_8c.html" target="source" name="InsertImageInList">InsertImageInList</a></h2>
456<div class="doc-section">
457
458<p>InsertImageInList() inserts the second image or image list into the first image list immediatally after the image pointed to. The given image list pointer is unchanged unless previously empty.</p></ol>
459
460<p>The format of the InsertImageInList method is:</p>
461
462<pre class="code">
463 InsertImageInList(Image **images,Image *image)
464</pre>
465
466<p>A description of each parameter follows:</p></ol>
467
468<h5>images</h5>
469<ol><p>the image list to insert into.</p></ol>
470
471<h5>image</h5>
472<ol><p>the image list to insert.</p></ol>
473
474 </div>
475<h2><a href="http://www.imagemagick.org/api/MagickCore/list
476_8c.html" target="source" name="NewImageList">NewImageList</a></h2>
477<div class="doc-section">
478
479<p>NewImageList() creates an empty image list.</p></ol>
480
481<p>The format of the NewImageList method is:</p>
482
483<pre class="code">
484 Image *NewImageList(void)
485</pre>
486
487 </div>
488<h2><a href="http://www.imagemagick.org/api/MagickCore/list
489_8c.html" target="source" name="PrependImageToList">PrependImageToList</a></h2>
490<div class="doc-section">
491
492<p>PrependImageToList() prepends the image to the beginning of the list.</p></ol>
493
494<p>The format of the PrependImageToList method is:</p>
495
496<pre class="code">
497 PrependImageToList(Image *images,Image *image)
498</pre>
499
500<p>A description of each parameter follows:</p></ol>
501
502<h5>images</h5>
503<ol><p>the image list.</p></ol>
504
505<h5>image</h5>
506<ol><p>the image.</p></ol>
507
508 </div>
509<h2><a href="http://www.imagemagick.org/api/MagickCore/list
510_8c.html" target="source" name="RemoveImageFromList">RemoveImageFromList</a></h2>
511<div class="doc-section">
512
513<p>RemoveImageFromList() removes and returns the image pointed to.</p></ol>
514
515<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></ol>
516
517<p>The format of the RemoveImageFromList method is:</p>
518
519<pre class="code">
520 Image *RemoveImageFromList(Image **images)
521</pre>
522
523<p>A description of each parameter follows:</p></ol>
524
525<h5>images</h5>
526<ol><p>the image list.</p></ol>
527
528 </div>
529<h2><a href="http://www.imagemagick.org/api/MagickCore/list
530_8c.html" target="source" name="RemoveFirstImageFromList">RemoveFirstImageFromList</a></h2>
531<div class="doc-section">
532
533<p>RemoveFirstImageFromList() removes and returns the first image in the list.</p></ol>
534
535<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></ol>
536
537<p>The format of the RemoveFirstImageFromList method is:</p>
538
539<pre class="code">
540 Image *RemoveFirstImageFromList(Image **images)
541</pre>
542
543<p>A description of each parameter follows:</p></ol>
544
545<h5>images</h5>
546<ol><p>the image list.</p></ol>
547
548 </div>
549<h2><a href="http://www.imagemagick.org/api/MagickCore/list
550_8c.html" target="source" name="RemoveLastImageFromList">RemoveLastImageFromList</a></h2>
551<div class="doc-section">
552
553<p>RemoveLastImageFromList() removes and returns the last image from the list.</p></ol>
554
555<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></ol>
556
557<p>The format of the RemoveLastImageFromList method is:</p>
558
559<pre class="code">
560 Image *RemoveLastImageFromList(Image **images)
561</pre>
562
563<p>A description of each parameter follows:</p></ol>
564
565<h5>images</h5>
566<ol><p>the image list.</p></ol>
567
568 </div>
569<h2><a href="http://www.imagemagick.org/api/MagickCore/list
570_8c.html" target="source" name="ReplaceImageInList">ReplaceImageInList</a></h2>
571<div class="doc-section">
572
573<p>ReplaceImageInList() replaces an image in the list. Old image is destroyed. The given image list pointer is set to point to the just inserted image.</p></ol>
574
575<p>The format of the ReplaceImageInList method is:</p>
576
577<pre class="code">
578 ReplaceImageInList(Image **images,Image *image)
579</pre>
580
581<p>A description of each parameter follows:</p></ol>
582
583<h5>images</h5>
584<ol><p>the image list.</p></ol>
585
586<h5>image</h5>
587<ol><p>the image.</p></ol>
588
589 </div>
590<h2><a href="http://www.imagemagick.org/api/MagickCore/list
591_8c.html" target="source" name="ReverseImageList">ReverseImageList</a></h2>
592<div class="doc-section">
593
594<p>ReverseImageList() reverses the order of an image list. The list pointer is reset to that start of the re-ordered list.</p></ol>
595
596<p>The format of the ReverseImageList method is:</p>
597
598<pre class="code">
599 void ReverseImageList(Image **images)
600</pre>
601
602<p>A description of each parameter follows:</p></ol>
603
604<h5>images</h5>
605<ol><p>the image list.</p></ol>
606
607 </div>
608<h2><a href="http://www.imagemagick.org/api/MagickCore/list
609_8c.html" target="source" name="SpliceImageIntoList">SpliceImageIntoList</a></h2>
610<div class="doc-section">
611
612<p>SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice. Removed images are returned.</p></ol>
613
614<p>The format of the SpliceImageIntoList method is:</p>
615
616<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]617 SpliceImageIntoList(Image **images,const size_t,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]618 const Image *splice)
619</pre>
620
621<p>A description of each parameter follows:</p></ol>
622
623<h5>images</h5>
624<ol><p>the image list.</p></ol>
625
626<h5>length</h5>
627<ol><p>the length of the image list to remove.</p></ol>
628
629<h5>splice</h5>
630<ol><p>Replace the removed image list with this list.</p></ol>
631
632 </div>
633<h2><a href="http://www.imagemagick.org/api/MagickCore/list
634_8c.html" target="source" name="SplitImageList">SplitImageList</a></h2>
635<div class="doc-section">
636
637<p>SplitImageList() splits an image into two lists, after given image The list that was split off is returned, which may be empty.</p></ol>
638
639<p>The format of the SplitImageList method is:</p>
640
641<pre class="code">
642 Image *SplitImageList(Image *images)
643</pre>
644
645<p>A description of each parameter follows:</p></ol>
646
647<h5>images</h5>
648<ol><p>the image list.</p></ol>
649
650 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]651
652</div>
653
654<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]655 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]656 <span id="linkbar-center">
657 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristyc3ebda22010-06-27 17:11:57 +0000[diff] [blame]658 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]659 </span>
660 <span id="linkbar-east">&nbsp;</span>
661 </div>
662 <div class="footer">
663 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
664 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
665 </div>
666 <div style="clear: both; margin: 0; width: 100%; "></div>
667</body>
668</html>