Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 2f563d40f243624a54236cb1ff8566bceadb04c5 / . / www / api / list.html
blob: 434555e50cabcda756ca1b1455a021fef48947b4 [file] [log] [blame]
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html lang="en">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]3<head>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Working with Image Lists</title>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]8 <meta http-equiv="content-language" content="en-US">
9 <meta http-equiv="content-type" content="text/html; charset=utf-8">
10 <meta http-equiv="reply-to" content="magick-users@imagemagick.org">
11 <meta name="application-name" content="ImageMagick">
12 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
13 <meta name="application-url" content="http://www.imagemagick.org">
14 <meta name="generator" content="PHP">
15 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, working, with, image, lists, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
16 <meta name="rating" content="GENERAL">
17 <meta name="robots" content="INDEX, FOLLOW">
18 <meta name="generator" content="ImageMagick Studio LLC">
19 <meta name="author" content="ImageMagick Studio LLC">
20 <meta name="revisit-after" content="2 DAYS">
21 <meta name="resource-type" content="document">
22 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC">
23 <meta name="distribution" content="Global">
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame^]25 <link rel="icon" href="../images/wand.png">
26 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon">
27 <link rel="stylesheet" href="../css/bootstrap.min.css">
28 <link rel="stylesheet" href="../css/magick.css">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]29</head>
30
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]31<body>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]32<div class="main">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]33<div class="magick-masthead">
34 <div class="container">
35 <script type="text/javascript">
36 <!--
37 google_ad_client = "pub-3129977114552745";
38 google_ad_slot = "5439289906";
39 google_ad_width = 728;
40 google_ad_height = 90;
41 //-->
42 </script>
43 <center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
44 </script></center>
45 <nav class="magick-nav">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame^]46 <a class="magick-nav-item " href="../index.html">Home</a>
47 <a class="magick-nav-item " href="../www/binary-releases.html">Downloads</a>
48 <a class="magick-nav-item " href="../www/command-line-tools.html">Tools</a>
49 <a class="magick-nav-item " href="../www/command-line-options.html">Options</a>
50 <a class="magick-nav-item " href="../www/api.html">Development</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]51 <a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristyabed55c2015-05-06 17:07:00 +0000[diff] [blame]52 <a class="magick-nav-item navbar-right " href="http://www.imagemagick.org/script/search.php">Search</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]53 </nav>
54 </div>
55</div>
56<div class="container">
57<p class="text-center"><a href="list.html#AppendImageToList">AppendImageToList</a> • <a href="list.html#CloneImageList">CloneImageList</a> • <a href="list.html#CloneImages">CloneImages</a> • <a href="list.html#DeleteImageFromList">DeleteImageFromList</a> • <a href="list.html#DeleteImages">DeleteImages</a> • <a href="list.html#DestroyImageList">DestroyImageList</a> • <a href="list.html#DuplicateImages">DuplicateImages</a> • <a href="list.html#GetFirstImageInList">GetFirstImageInList</a> • <a href="list.html#GetImageFromList">GetImageFromList</a> • <a href="list.html#GetImageIndexInList">GetImageIndexInList</a> • <a href="list.html#GetImageListLength">GetImageListLength</a> • <a href="list.html#GetLastImageInList">GetLastImageInList</a> • <a href="list.html#GetNextImageInList">GetNextImageInList</a> • <a href="list.html#GetPreviousImageInList">GetPreviousImageInList</a> • <a href="list.html#ImageListToArray">ImageListToArray</a> • <a href="list.html#InsertImageInList">InsertImageInList</a> • <a href="list.html#NewImageList">NewImageList</a> • <a href="list.html#PrependImageToList">PrependImageToList</a> • <a href="list.html#RemoveImageFromList">RemoveImageFromList</a> • <a href="list.html#RemoveFirstImageFromList">RemoveFirstImageFromList</a> • <a href="list.html#RemoveLastImageFromList">RemoveLastImageFromList</a> • <a href="list.html#ReplaceImageInList">ReplaceImageInList</a> • <a href="list.html#ReplaceImageInListReturnLast">ReplaceImageInListReturnLast</a> • <a href="list.html#ReverseImageList">ReverseImageList</a> • <a href="list.html#SpliceImageIntoList">SpliceImageIntoList</a> • <a href="list.html#SplitImageList">SplitImageList</a></p>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]58
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]59<div class="magick-header">
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]60<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="AppendImageToList">AppendImageToList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]61
62<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>
63
64<p>The format of the AppendImageToList method is:</p>
65
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]66<pre class="text">
67AppendImageToList(Image *images,const Image *image)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]68</pre>
69
70<p>A description of each parameter follows:</p>
71
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]72<dd>
73</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]74
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]75<dd> </dd>
76<dl class="dl-horizontal">
77<dt>images</dt>
78<dd>the image list to be appended to. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]79
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]80<dd> </dd>
81<dt>image</dt>
82<dd>the appended image or image list. </dd>
83
84<dd> </dd>
85</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]86<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="CloneImageList">CloneImageList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]87
88<p>CloneImageList() returns a duplicate of the image list.</p>
89
90<p>The format of the CloneImageList method is:</p>
91
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]92<pre class="text">
93Image *CloneImageList(const Image *images,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]94</pre>
95
96<p>A description of each parameter follows:</p>
97
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]98<dd>
99</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]100
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]101<dd> </dd>
102<dl class="dl-horizontal">
103<dt>images</dt>
104<dd>the image list. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]105
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]106<dd> </dd>
107<dt>exception</dt>
108<dd>return any errors or warnings in this structure. </dd>
109
110<dd> </dd>
111</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]112<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="CloneImages">CloneImages</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]113
114<p>CloneImages() clones one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
115
116<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>
117
118<p>Images referenced may be reversed, and results in a clone of those images also being made with a reversed order.</p>
119
120<p>The format of the CloneImages method is:</p>
121
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]122<pre class="text">
123Image *CloneImages(const Image *images,const char *scenes,
124 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]125</pre>
126
127<p>A description of each parameter follows:</p>
128
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]129<dd>
130</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]131
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]132<dd> </dd>
133<dl class="dl-horizontal">
134<dt>images</dt>
135<dd>the image sequence. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]136
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]137<dd> </dd>
138<dt>scenes</dt>
139<dd>This character string specifies which scenes to clone (e.g. 1,3-5,7-3,2). </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]140
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]141<dd> </dd>
142<dt>exception</dt>
143<dd>return any errors or warnings in this structure. </dd>
144
145<dd> </dd>
146</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]147<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DeleteImageFromList">DeleteImageFromList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]148
149<p>DeleteImageFromList() deletes an image from the list. List pointer is moved to the next image, if one is present. See RemoveImageFromList().</p>
150
151<p>The format of the DeleteImageFromList method is:</p>
152
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]153<pre class="text">
154DeleteImageFromList(Image **images)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]155</pre>
156
157<p>A description of each parameter follows:</p>
158
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]159<dd>
160</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]161
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]162<dd> </dd>
163<dl class="dl-horizontal">
164<dt>images</dt>
165<dd>the image list. </dd>
166
167<dd> </dd>
168</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]169<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DeleteImages">DeleteImages</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]170
171<p>DeleteImages() deletes one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
172
173<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>
174
175<p>If the referenced images are in the reverse order, that range will be completely ignored, unlike CloneImages().</p>
176
177<p>The format of the DeleteImages method is:</p>
178
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]179<pre class="text">
180DeleteImages(Image **images,const char *scenes,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]181</pre>
182
183<p>A description of each parameter follows:</p>
184
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]185<dd>
186</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]187
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]188<dd> </dd>
189<dl class="dl-horizontal">
190<dt>images</dt>
191<dd>the image sequence. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]192
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]193<dd> </dd>
194<dt>scenes</dt>
195<dd>This character string specifies which scenes to delete (e.g. 1,3-5,-2-6,2). </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]196
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]197<dd> </dd>
198<dt>exception</dt>
199<dd>return any errors or warnings in this structure. </dd>
200
201<dd> </dd>
202</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]203<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DestroyImageList">DestroyImageList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]204
205<p>DestroyImageList() destroys an image list.</p>
206
207<p>The format of the DestroyImageList method is:</p>
208
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]209<pre class="text">
210Image *DestroyImageList(Image *image)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]211</pre>
212
213<p>A description of each parameter follows:</p>
214
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]215<dd>
216</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]217
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]218<dd> </dd>
219<dl class="dl-horizontal">
220<dt>image</dt>
221<dd>the image sequence. </dd>
222
223<dd> </dd>
224</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]225<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DuplicateImages">DuplicateImages</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]226
227<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>
228
229<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>
230
231<p>The format of the DuplicateImages method is:</p>
232
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]233<pre class="text">
234Image *DuplicateImages(Image *images,const size_t number_duplicates,
235 const char *scenes,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]236</pre>
237
238<p>A description of each parameter follows:</p>
239
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]240<dd>
241</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]242
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]243<dd> </dd>
244<dl class="dl-horizontal">
245<dt>images</dt>
246<dd>the image sequence. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]247
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]248<dd> </dd>
249<dt>number_duplicates</dt>
250<dd>duplicate the image sequence this number of times. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]251
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]252<dd> </dd>
253<dt>scenes</dt>
254<dd>This character string specifies which scenes to duplicate (e.g. 1,3-5,-2-6,2). </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]255
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]256<dd> </dd>
257<dt>exception</dt>
258<dd>return any errors or warnings in this structure. </dd>
259
260<dd> </dd>
261</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]262<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetFirstImageInList">GetFirstImageInList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]263
264<p>GetFirstImageInList() returns a pointer to the first image in the list.</p>
265
266<p>The format of the GetFirstImageInList method is:</p>
267
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]268<pre class="text">
269Image *GetFirstImageInList(const Image *images)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]270</pre>
271
272<p>A description of each parameter follows:</p>
273
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]274<dd>
275</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]276
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]277<dd> </dd>
278<dl class="dl-horizontal">
279<dt>images</dt>
280<dd>the image list. </dd>
281
282<dd> </dd>
283</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]284<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageFromList">GetImageFromList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]285
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]286<p>GetImageFromList() returns an image at the specified index from the image list. Starting with 0 as the first image in the list.</p>
287
288<p>A negative offset will return the image from the end of the list, such that an index of -1 is the last image.</p>
289
290<p>If no such image exists at the specified offset a NULL image pointer is returned. This will only happen if index is less that the negative of the list length, or larger than list length -1. EG: ( -N to N-1 )</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]291
292<p>The format of the GetImageFromList method is:</p>
293
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]294<pre class="text">
295Image *GetImageFromList(const Image *images,const ssize_t index)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]296</pre>
297
298<p>A description of each parameter follows:</p>
299
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]300<dd>
301</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]302
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]303<dd> </dd>
304<dl class="dl-horizontal">
305<dt>images</dt>
306<dd>the image list. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]307
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]308<dd> </dd>
309<dt>index</dt>
310<dd>the position within the list. </dd>
311
312<dd> </dd>
313</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]314<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageIndexInList">GetImageIndexInList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]315
316<p>GetImageIndexInList() returns the offset in the list of the specified image.</p>
317
318<p>The format of the GetImageIndexInList method is:</p>
319
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]320<pre class="text">
321ssize_t GetImageIndexInList(const Image *images)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]322</pre>
323
324<p>A description of each parameter follows:</p>
325
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]326<dd>
327</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]328
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]329<dd> </dd>
330<dl class="dl-horizontal">
331<dt>images</dt>
332<dd>the image list. </dd>
333
334<dd> </dd>
335</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]336<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageListLength">GetImageListLength</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]337
338<p>GetImageListLength() returns the length of the list (the number of images in the list).</p>
339
340<p>The format of the GetImageListLength method is:</p>
341
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]342<pre class="text">
343size_t GetImageListLength(const Image *images)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]344</pre>
345
346<p>A description of each parameter follows:</p>
347
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]348<dd>
349</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]350
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]351<dd> </dd>
352<dl class="dl-horizontal">
353<dt>images</dt>
354<dd>the image list. </dd>
355
356<dd> </dd>
357</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]358<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetLastImageInList">GetLastImageInList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]359
360<p>GetLastImageInList() returns a pointer to the last image in the list.</p>
361
362<p>The format of the GetLastImageInList method is:</p>
363
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]364<pre class="text">
365Image *GetLastImageInList(const Image *images)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]366</pre>
367
368<p>A description of each parameter follows:</p>
369
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]370<dd>
371</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]372
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]373<dd> </dd>
374<dl class="dl-horizontal">
375<dt>images</dt>
376<dd>the image list. </dd>
377
378<dd> </dd>
379</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]380<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetNextImageInList">GetNextImageInList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]381
382<p>GetNextImageInList() returns the next image in the list.</p>
383
384<p>The format of the GetNextImageInList method is:</p>
385
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]386<pre class="text">
387Image *GetNextImageInList(const Image *images)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]388</pre>
389
390<p>A description of each parameter follows:</p>
391
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]392<dd>
393</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]394
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]395<dd> </dd>
396<dl class="dl-horizontal">
397<dt>images</dt>
398<dd>the image list. </dd>
399
400<dd> </dd>
401</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]402<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetPreviousImageInList">GetPreviousImageInList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]403
404<p>GetPreviousImageInList() returns the previous image in the list.</p>
405
406<p>The format of the GetPreviousImageInList method is:</p>
407
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]408<pre class="text">
409Image *GetPreviousImageInList(const Image *images)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]410</pre>
411
412<p>A description of each parameter follows:</p>
413
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]414<dd>
415</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]416
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]417<dd> </dd>
418<dl class="dl-horizontal">
419<dt>images</dt>
420<dd>the image list. </dd>
421
422<dd> </dd>
423</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]424<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ImageListToArray">ImageListToArray</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]425
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]426<p>ImageListToArray() is a convenience method that converts an image list to a sequential array, with a NULL image pointer at the end of the array.</p>
427
428<p>The images remain part of the original image list, with the array providing an alternative means of indexing the image array.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]429
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]430<p>group = ImageListToArray(images, exception); while (i = 0; group[i] != (Image *) NULL; i++) printf("s\n", group[i]-&gt;filename); printf("d images\n", i); group = RelinquishMagickMemory(group);</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]431
432<p>The format of the ImageListToArray method is:</p>
433
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]434<pre class="text">
435Image **ImageListToArray(const Image *images,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]436</pre>
437
438<p>A description of each parameter follows:</p>
439
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]440<dd>
441</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]442
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]443<dd> </dd>
444<dl class="dl-horizontal">
445<dt>image</dt>
446<dd>the image list. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]447
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]448<dd> </dd>
449<dt>exception</dt>
450<dd>return any errors or warnings in this structure. </dd>
451
452<dd> </dd>
453</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]454<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="InsertImageInList">InsertImageInList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]455
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]456<p>InsertImageInList() insert the given image or image list, into the first image list, immediately AFTER the image pointed to. The given image list pointer is left unchanged unless previously empty.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]457
458<p>The format of the InsertImageInList method is:</p>
459
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]460<pre class="text">
461InsertImageInList(Image **images,Image *insert)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]462</pre>
463
464<p>A description of each parameter follows:</p>
465
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]466<dd>
467</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]468
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]469<dd> </dd>
470<dl class="dl-horizontal">
471<dt>images</dt>
472<dd>the image list to insert into. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]473
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]474<dd> </dd>
475<dt>insert</dt>
476<dd>the image list to insert. </dd>
477
478<dd> </dd>
479</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]480<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="NewImageList">NewImageList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]481
482<p>NewImageList() creates an empty image list.</p>
483
484<p>The format of the NewImageList method is:</p>
485
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]486<pre class="text">
487Image *NewImageList(void)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]488</pre>
489
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]490<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="PrependImageToList">PrependImageToList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]491
492<p>PrependImageToList() prepends the image to the beginning of the list.</p>
493
494<p>The format of the PrependImageToList method is:</p>
495
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]496<pre class="text">
497PrependImageToList(Image *images,Image *image)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]498</pre>
499
500<p>A description of each parameter follows:</p>
501
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]502<dd>
503</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]504
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]505<dd> </dd>
506<dl class="dl-horizontal">
507<dt>images</dt>
508<dd>the image list. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]509
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]510<dd> </dd>
511<dt>image</dt>
512<dd>the image. </dd>
513
514<dd> </dd>
515</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]516<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveImageFromList">RemoveImageFromList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]517
518<p>RemoveImageFromList() removes and returns the image pointed to.</p>
519
520<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>
521
522<p>The format of the RemoveImageFromList method is:</p>
523
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]524<pre class="text">
525Image *RemoveImageFromList(Image **images)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]526</pre>
527
528<p>A description of each parameter follows:</p>
529
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]530<dd>
531</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]532
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]533<dd> </dd>
534<dl class="dl-horizontal">
535<dt>images</dt>
536<dd>the image list. </dd>
537
538<dd> </dd>
539</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]540<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveFirstImageFromList">RemoveFirstImageFromList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]541
542<p>RemoveFirstImageFromList() removes and returns the first image in the list.</p>
543
544<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>
545
546<p>The format of the RemoveFirstImageFromList method is:</p>
547
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]548<pre class="text">
549Image *RemoveFirstImageFromList(Image **images)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]550</pre>
551
552<p>A description of each parameter follows:</p>
553
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]554<dd>
555</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]556
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]557<dd> </dd>
558<dl class="dl-horizontal">
559<dt>images</dt>
560<dd>the image list. </dd>
561
562<dd> </dd>
563</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]564<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveLastImageFromList">RemoveLastImageFromList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]565
566<p>RemoveLastImageFromList() removes and returns the last image from the list.</p>
567
568<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>
569
570<p>The format of the RemoveLastImageFromList method is:</p>
571
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]572<pre class="text">
573Image *RemoveLastImageFromList(Image **images)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]574</pre>
575
576<p>A description of each parameter follows:</p>
577
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]578<dd>
579</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]580
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]581<dd> </dd>
582<dl class="dl-horizontal">
583<dt>images</dt>
584<dd>the image list. </dd>
585
586<dd> </dd>
587</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]588<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReplaceImageInList">ReplaceImageInList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]589
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]590<p>ReplaceImageInList() replaces an image in the list with the given image, or list of images. Old image is destroyed.</p>
591
592<p>The images list pointer is set to point to the first image of the inserted list of images.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]593
594<p>The format of the ReplaceImageInList method is:</p>
595
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]596<pre class="text">
597ReplaceImageInList(Image **images,Image *replace)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]598</pre>
599
600<p>A description of each parameter follows:</p>
601
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]602<dd>
603</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]604
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]605<dd> </dd>
606<dl class="dl-horizontal">
607<dt>images</dt>
608<dd>the list and pointer to image to replace </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]609
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]610<dd> </dd>
611<dt>replace</dt>
612<dd>the image or image list replacing the original </dd>
613
614<dd> </dd>
615</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]616<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReplaceImageInListReturnLast">ReplaceImageInListReturnLast</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]617
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]618<p>ReplaceImageInListReturnLast() is exactly as ReplaceImageInList() except the images pointer is set to the last image in the list of replacemen images.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]619
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]620<p>This allows you to simply use GetNextImageInList() to go to the image that follows the just replaced image, even if a list of replacement images was inserted.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]621
622<p>The format of the ReplaceImageInList method is:</p>
623
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]624<pre class="text">
625ReplaceImageInListReturnLast(Image **images,Image *replace)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]626</pre>
627
628<p>A description of each parameter follows:</p>
629
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]630<dd>
631</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]632
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]633<dd> </dd>
634<dl class="dl-horizontal">
635<dt>images</dt>
636<dd>the list and pointer to image to replace </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]637
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]638<dd> </dd>
639<dt>replace</dt>
640<dd>the image or image list replacing the original </dd>
641
642<dd> </dd>
643</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]644<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReverseImageList">ReverseImageList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]645
646<p>ReverseImageList() reverses the order of an image list. The list pointer is reset to that start of the re-ordered list.</p>
647
648<p>The format of the ReverseImageList method is:</p>
649
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]650<pre class="text">
651void ReverseImageList(Image **images)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]652</pre>
653
654<p>A description of each parameter follows:</p>
655
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]656<dd>
657</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]658
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]659<dd> </dd>
660<dl class="dl-horizontal">
661<dt>images</dt>
662<dd>the image list. </dd>
663
664<dd> </dd>
665</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]666<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="SpliceImageIntoList">SpliceImageIntoList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]667
668<p>SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice. Removed images are returned.</p>
669
670<p>The format of the SpliceImageIntoList method is:</p>
671
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]672<pre class="text">
673SpliceImageIntoList(Image **images,const size_t,
674 const Image *splice)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]675</pre>
676
677<p>A description of each parameter follows:</p>
678
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]679<dd>
680</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]681
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]682<dd> </dd>
683<dl class="dl-horizontal">
684<dt>images</dt>
685<dd>the image list. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]686
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]687<dd> </dd>
688<dt>length</dt>
689<dd>the length of the image list to remove. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]690
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]691<dd> </dd>
692<dt>splice</dt>
693<dd>Replace the removed image list with this list. </dd>
694
695<dd> </dd>
696</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]697<h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="SplitImageList">SplitImageList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]698
699<p>SplitImageList() splits an image into two lists, after given image The list that was split off is returned, which may be empty.</p>
700
701<p>The format of the SplitImageList method is:</p>
702
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]703<pre class="text">
704Image *SplitImageList(Image *images)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]705</pre>
706
707<p>A description of each parameter follows:</p>
708
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]709<dd>
710</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]711
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]712<dd> </dd>
713<dl class="dl-horizontal">
714<dt>images</dt>
715<dd>the image list. </dd>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]716
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]717<dd> </dd>
718</dl>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]719</div>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]720 <footer class="magick-footer">
721 <div class="magick-nav-item navbar-left">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame^]722 <a href="../www/support.html">Donate</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]723 </div>
724 <div class="magick-nav-item navbar-right">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame^]725 <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../index.html"></a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]726 <noscript>
727 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
728 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>
729 </noscript>
730 </div>
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame^]731 <p><a href="../www/sitemap.html">Sitemap</a> •
732 <a href="../www/links.html">Related</a> •
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]733 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> •
734 <a href="http://jqmagick.imagemagick.org/">JqMagick</a> •
735 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
736</p>
737 <p><a href="list.html#">Back to top</a> •
cristyabed55c2015-05-06 17:07:00 +0000[diff] [blame]738 <a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]739 </footer>
740</div><!-- /.container -->
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]741
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]742 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame^]743 <script src="../js/bootstrap.min.js"></script>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]744 <script type="text/javascript">
745 /* */
746 (function() {
747 var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
748 s.type = 'text/javascript';
749 s.async = true;
750 s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
751 t.parentNode.insertBefore(s, t);
752 })();
753 /* */
754 </script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]755</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]756</body>
cristy5a367e42015-05-05 12:39:18 +0000[diff] [blame]757</html>