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