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