Class: Magick::ImageList

Inherits:
Object
  • Object
show all
Includes:
Comparable, Enumerable
Defined in:
lib/rmagick_internal.rb,
ext/RMagick/rmmain.c

Overview

class Magick::Image

Defined Under Namespace

Classes: Montage

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*filenames, &block) ⇒ ImageList

Initialize new instances



1593
1594
1595
1596
1597
1598
1599
1600
1601
 
# File 'lib/rmagick_internal.rb', line 1593

def initialize(*filenames, &block)
  @images = []
  @scene = nil
  filenames.each do |f|
    Magick::Image.read(f, &block).each { |n| @images << n }
  end

  @scene = length - 1 if length > 0 # last image in array
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(meth_id, *args, &block) ⇒ Object

The ImageList class supports the Magick::Image class methods by simply sending the method to the current image. If the method isn’t explicitly supported, send it to the current image in the array. If there are no images, send it up the line. Catch a NameError and emit a useful message.



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
 
# File 'lib/rmagick_internal.rb', line 1655

def method_missing(meth_id, *args, &block)
  if @scene
    @images[@scene].send(meth_id, *args, &block)
  else
    super
  end
rescue NoMethodError
  Kernel.raise NoMethodError, "undefined method `#{meth_id.id2name}' for #{self.class}"
rescue Exception
  $ERROR_POSITION.delete_if { |s| /:in `send'$/.match(s) || /:in `method_missing'$/.match(s) }
  Kernel.raise
end

Instance Attribute Details

#scene ⇒ Object

Returns the value of attribute scene.



1287
1288
1289
 
# File 'lib/rmagick_internal.rb', line 1287

def scene
  @scene
end

Instance Method Details

#*(other) ⇒ Object 



1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/rmagick_internal.rb', line 1370

def *(other)
  Kernel.raise ArgumentError, "Integer required (#{other.class} given)" unless other.is_a? Integer
  current = get_current
  ilist = self.class.new
  (@images * other).each { |image| ilist << image }
  ilist.set_current current
  ilist
end

#<<(obj) ⇒ Object 



1379
1380
1381
1382
1383
1384
 
# File 'lib/rmagick_internal.rb', line 1379

def <<(obj)
  assert_image obj
  @images << obj
  @scene = @images.length - 1
  self
end

#<=>(other) ⇒ Object

Compare ImageLists Compare each image in turn until the result of a comparison is not 0. If all comparisons return 0, then

return if A.scene != B.scene
return A.length <=> B.length



1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
 
# File 'lib/rmagick_internal.rb', line 1391

def <=>(other)
  Kernel.raise TypeError, "#{self.class} required (#{other.class} given)" unless other.is_a? self.class
  size = [length, other.length].min
  size.times do |x|
    r = self[x] <=> other[x]
    return r unless r.zero?
  end
  return 0 if @scene.nil? && other.scene.nil?

  Kernel.raise TypeError, "cannot convert nil into #{other.scene.class}" if @scene.nil? && !other.scene.nil?
  Kernel.raise TypeError, "cannot convert nil into #{scene.class}" if !@scene.nil? && other.scene.nil?
  r = scene <=> other.scene
  return r unless r.zero?

  length <=> other.length
end

#[](*args) ⇒ Object 



1408
1409
1410
1411
1412
1413
1414
1415
1416
 
# File 'lib/rmagick_internal.rb', line 1408

def [](*args)
  a = @images[*args]
  if a.respond_to?(:each)
    ilist = self.class.new
    a.each { |image| ilist << image }
    a = ilist
  end
  a
end

#[]=(*args) ⇒ Object 



1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
 
# File 'lib/rmagick_internal.rb', line 1418

def []=(*args)
  obj = @images.[]=(*args)
  if obj && obj.respond_to?(:each)
    assert_image_array(obj)
    set_current obj.last.__id__
  elsif obj
    assert_image(obj)
    set_current obj.__id__
  else
    set_current nil
  end
end

#__respond_to__? ⇒ Object

Ensure respond_to? answers correctly when we are delegating to Image



1749
 
# File 'lib/rmagick_internal.rb', line 1749

alias __respond_to__? respond_to?

#animate ⇒ Magick::ImageList #animate(delay) ⇒ Magick::ImageList

Repeatedly display the images in the images array to an XWindow screen. The delay argument is the number of 1/100ths of a second (0 to 65535) to delay between images.

Overloads:

  • #animate(delay) ⇒ Magick::ImageList

    Parameters:

    • delay (Numeric) —

      the length of time between each image in an animation

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'ext/RMagick/rmilist.c', line 39

VALUE
ImageList_animate(int argc, VALUE *argv, VALUE self)
{
    Image *images;
    Info *info;
    VALUE info_obj;
    unsigned int delay;
#if defined(IMAGEMAGICK_7)
    ExceptionInfo *exception;
#endif

    if (argc == 1)
    {
        delay = NUM2UINT(argv[0]);
    }
    if (argc > 1)
    {
        rb_raise(rb_eArgError, "wrong number of arguments (%d for 0 or 1)", argc);
    }

    // Create a new Info object to use with this call
    info_obj = rm_info_new();

    // Convert the images array to an images sequence.
    images = images_from_imagelist(self);

    if (argc == 1)
    {
        Image *img;

        for (img = images; img; img = GetNextImageInList(img))
        {
            img->delay = delay;
        }
    }

    Data_Get_Struct(info_obj, Info, info);
#if defined(IMAGEMAGICK_7)
    exception = AcquireExceptionInfo();
    AnimateImages(info, images, exception);
    rm_split(images);
    CHECK_EXCEPTION();
    DestroyExceptionInfo(exception);
#else
    AnimateImages(info, images);
    rm_split(images);
    rm_check_image_exception(images, RetainOnError);
#endif

    RB_GC_GUARD(info_obj);

    return self;
}

#append(stack_arg) ⇒ Magick::Image

Append all the images

Parameters:

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'ext/RMagick/rmilist.c', line 100

VALUE
ImageList_append(VALUE self, VALUE stack_arg)
{
    Image *images, *new_image;
    unsigned int stack;
    ExceptionInfo *exception;

    // Convert the image array to an image sequence.
    images = images_from_imagelist(self);

    // If stack == true, stack rectangular images top-to-bottom,
    // otherwise left-to-right.
    stack = RTEST(stack_arg);

    exception = AcquireExceptionInfo();
    new_image = AppendImages(images, stack, exception);
    rm_split(images);
    rm_check_exception(exception, new_image, DestroyOnError);
    DestroyExceptionInfo(exception);

    return rm_image_new(new_image);
}

#average ⇒ Magick::Image

Average all images together

Returns:



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'ext/RMagick/rmilist.c', line 129

VALUE
ImageList_average(VALUE self)
{
    Image *images, *new_image;
    ExceptionInfo *exception;

    // Convert the images array to an images sequence.
    images = images_from_imagelist(self);

    exception = AcquireExceptionInfo();
    new_image = EvaluateImages(images, MeanEvaluateOperator, exception);

    rm_split(images);
    rm_check_exception(exception, new_image, DestroyOnError);
    DestroyExceptionInfo(exception);

    return rm_image_new(new_image);
}

#clear ⇒ Object 



1443
1444
1445
1446
 
# File 'lib/rmagick_internal.rb', line 1443

def clear
  @scene = nil
  @images.clear
end

#clone ⇒ Object 



1448
1449
1450
1451
1452
 
# File 'lib/rmagick_internal.rb', line 1448

def clone
  ditto = dup
  ditto.freeze if frozen?
  ditto
end

#coalesce ⇒ Magick::ImageList

Composites a set of images while respecting any page offsets and disposal methods.

  • Respects the delay, matte, and start_loop fields in each image.

Returns:

  • (Magick::ImageList) —

    a new image with the coalesced image sequence return stored in the images array



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'ext/RMagick/rmilist.c', line 157

VALUE
ImageList_coalesce(VALUE self)
{
    Image *images, *new_images;
    ExceptionInfo *exception;

    // Convert the image array to an image sequence.
    images = images_from_imagelist(self);

    exception = AcquireExceptionInfo();
    new_images = CoalesceImages(images, exception);
    rm_split(images);
    rm_check_exception(exception, new_images, DestroyOnError);
    DestroyExceptionInfo(exception);

    return rm_imagelist_from_images(new_images);
}

#collect(&block) ⇒ Object Also known as: map, __map__

override Enumerable#collect



1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'lib/rmagick_internal.rb', line 1455

def collect(&block)
  current = get_current
  a = @images.map(&block)
  ilist = self.class.new
  a.each { |image| ilist << image }
  ilist.set_current current
  ilist
end

#collect!(&block) ⇒ Object Also known as: map!, __map__! 



1464
1465
1466
1467
1468
 
# File 'lib/rmagick_internal.rb', line 1464

def collect!(&block)
  @images.map!(&block)
  assert_image_array @images
  self
end

#combine ⇒ Magick::Image #combine(colorspace) ⇒ Magick::Image

Combines the images using the specified colorspace.

Overloads:

  • #combine(colorspace) ⇒ Magick::Image

    Parameters:

    • colorspace (Magick::ColorspaceType) —

      the colorspace

Returns:



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'ext/RMagick/rmilist.c', line 186

VALUE ImageList_combine(int argc, VALUE *argv, VALUE self)
{
#if defined(IMAGEMAGICK_6)
    ChannelType channel;
    ColorspaceType old_colorspace;
#endif
    ColorspaceType colorspace;
    long len;
    Image *images, *new_image;
    ExceptionInfo *exception;

    len = check_imagelist_length(self);

    switch (argc)
    {
        case 1:
            VALUE_TO_ENUM(argv[0], colorspace, ColorspaceType);
            break;
        case 0:
            colorspace = sRGBColorspace;
            break;
        default:
            rb_raise(rb_eArgError, "wrong number of arguments (expected 1, got %d)", argc);
            break;
    }

#if defined(IMAGEMAGICK_7)
    if (len > 5)
    {
        rb_raise(rb_eArgError, "invalid number of images in this image list");
    }
    if (len == 5 && colorspace != CMYKColorspace)
    {
        rb_raise(rb_eArgError, "invalid number of images in this image list");
    }
#else
    channel = RedChannel;
    switch (len)
    {
        case 5:
            if (colorspace == CMYKColorspace)
                channel |= AlphaChannel;
            else
                rb_raise(rb_eArgError, "invalid number of images in this image list");
        case 4:
            if (colorspace == CMYKColorspace)
                channel |= IndexChannel;
            else
                channel |= AlphaChannel;
        case 3:
            channel |= GreenChannel;
            channel |= BlueChannel;
            break;
        case 2:
            channel |= AlphaChannel;
            break;
        case 1:
            break;
        default:
            rb_raise(rb_eArgError, "invalid number of images in this image list");
            break;
    }
#endif

    images = images_from_imagelist(self);
    exception = AcquireExceptionInfo();
#if defined(IMAGEMAGICK_6)
    old_colorspace = images->colorspace;
    SetImageColorspace(images, colorspace);
    new_image = CombineImages(images, channel, exception);
#else
    new_image = CombineImages(images, colorspace, exception);
#endif

    rm_split(images);
#if defined(IMAGEMAGICK_6)
    images->colorspace = old_colorspace;
#endif
    rm_check_exception(exception, new_image, DestroyOnError);
    DestroyExceptionInfo(exception);

    return rm_image_new(new_image);
}

#compact ⇒ Object 



1493
1494
1495
1496
1497
1498
1499
1500
 
# File 'lib/rmagick_internal.rb', line 1493

def compact
  current = get_current
  ilist = self.class.new
  a = @images.compact
  a.each { |image| ilist << image }
  ilist.set_current current
  ilist
end

#compact! ⇒ Object 



1502
1503
1504
1505
1506
1507
 
# File 'lib/rmagick_internal.rb', line 1502

def compact!
  current = get_current
  a = @images.compact! # returns nil if no changes were made
  set_current current
  a.nil? ? nil : self
end

#composite_layers(images) ⇒ Magick::ImageList #composite_layers(images, operator) ⇒ Magick::ImageList

An image from source images is composited over an image from receiver’s list until one list is finished.

Overloads:

Returns:



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'ext/RMagick/rmilist.c', line 284

VALUE
ImageList_composite_layers(int argc, VALUE *argv, VALUE self)
{
    VALUE source_images;
    Image *dest, *source, *new_images;
    RectangleInfo geometry;
    CompositeOperator operator = OverCompositeOp;
    ExceptionInfo *exception;

    switch (argc)
    {
        case 2:
            VALUE_TO_ENUM(argv[1], operator, CompositeOperator);
        case 1:
            source_images = argv[0];
            break;
        default:
            rb_raise(rb_eArgError, "wrong number of arguments (expected 1 or 2, got %d)", argc);
            break;
    }

    // Convert ImageLists to image sequences.
    dest = images_from_imagelist(self);
    new_images = clone_imagelist(dest);
    rm_split(dest);

    source = images_from_imagelist(source_images);

    SetGeometry(new_images, &geometry);
    ParseAbsoluteGeometry(new_images->geometry, &geometry);

    geometry.width  = source->page.width != 0 ? source->page.width : source->columns;
    geometry.height = source->page.height != 0 ? source->page.height : source->rows;
    GravityAdjustGeometry(new_images->page.width  != 0 ? new_images->page.width  : new_images->columns,
                          new_images->page.height != 0 ? new_images->page.height : new_images->rows,
                          new_images->gravity, &geometry);

    exception = AcquireExceptionInfo();
    CompositeLayers(new_images, operator, source, geometry.x, geometry.y, exception);
    rm_split(source);
    rm_check_exception(exception, new_images, DestroyOnError);
    DestroyExceptionInfo(exception);

    RB_GC_GUARD(source_images);

    return rm_imagelist_from_images(new_images);
}

#concat(other) ⇒ Object 



1509
1510
1511
1512
1513
1514
 
# File 'lib/rmagick_internal.rb', line 1509

def concat(other)
  assert_image_array other
  other.each { |image| @images << image }
  @scene = length - 1
  self
end

#copy ⇒ Object

Make a deep copy



1471
1472
1473
1474
1475
1476
 
# File 'lib/rmagick_internal.rb', line 1471

def copy
  ditto = self.class.new
  @images.each { |f| ditto << f.copy }
  ditto.scene = @scene
  ditto
end

#cur_image ⇒ Object

Return the current image



1479
1480
1481
1482
 
# File 'lib/rmagick_internal.rb', line 1479

def cur_image
  Kernel.raise IndexError, 'no images in this list' unless @scene
  @images[@scene]
end

#deconstruct ⇒ Magick::ImageList

Compare each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers.

Returns:



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'ext/RMagick/rmilist.c', line 339

VALUE
ImageList_deconstruct(VALUE self)
{
    Image *new_images, *images;
    ExceptionInfo *exception;

    images = images_from_imagelist(self);
    exception = AcquireExceptionInfo();
#if defined(IMAGEMAGICK_7)
    new_images = CompareImagesLayers(images, CompareAnyLayer, exception);
#else
    new_images = DeconstructImages(images, exception);
#endif
    rm_split(images);
    rm_check_exception(exception, new_images, DestroyOnError);
    DestroyExceptionInfo(exception);

    return rm_imagelist_from_images(new_images);
}

#delay=(d) ⇒ Object

Set same delay for all images

Raises:

  • (ArgumentError) 


1517
1518
1519
1520
1521
 
# File 'lib/rmagick_internal.rb', line 1517

def delay=(d)
  raise ArgumentError, 'delay must be greater than or equal to 0' if Integer(d) < 0

  @images.each { |f| f.delay = Integer(d) }
end

#delete(obj, &block) ⇒ Object 



1523
1524
1525
1526
1527
1528
1529
 
# File 'lib/rmagick_internal.rb', line 1523

def delete(obj, &block)
  assert_image obj
  current = get_current
  a = @images.delete(obj, &block)
  set_current current
  a
end

#delete_at(ndx) ⇒ Object 



1531
1532
1533
1534
1535
1536
 
# File 'lib/rmagick_internal.rb', line 1531

def delete_at(ndx)
  current = get_current
  a = @images.delete_at(ndx)
  set_current current
  a
end

#delete_if(&block) ⇒ Object 



1538
1539
1540
1541
1542
1543
 
# File 'lib/rmagick_internal.rb', line 1538

def delete_if(&block)
  current = get_current
  @images.delete_if(&block)
  set_current current
  self
end

#display ⇒ Magick::ImageList Also known as: __display__

Display all the images to an X window screen.

Returns:



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'ext/RMagick/rmilist.c', line 365

VALUE
ImageList_display(VALUE self)
{
    Image *images;
    Info *info;
    VALUE info_obj;
#if defined(IMAGEMAGICK_7)
    ExceptionInfo *exception;
#endif

    // Create a new Info object to use with this call
    info_obj = rm_info_new();
    Data_Get_Struct(info_obj, Info, info);

    // Convert the images array to an images sequence.
    images = images_from_imagelist(self);
#if defined(IMAGEMAGICK_7)
    exception = AcquireExceptionInfo();
    DisplayImages(info, images, exception);
    rm_split(images);
    CHECK_EXCEPTION();
    DestroyExceptionInfo(exception);
#else
    DisplayImages(info, images);
    rm_split(images);
    rm_check_image_exception(images, RetainOnError);
#endif

    RB_GC_GUARD(info_obj);

    return self;
}

#dup ⇒ Object 



1545
1546
1547
1548
1549
1550
 
# File 'lib/rmagick_internal.rb', line 1545

def dup
  ditto = self.class.new
  @images.each { |img| ditto << img }
  ditto.scene = @scene
  ditto
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
 
# File 'lib/rmagick_internal.rb', line 1552

def eql?(other)
  assert_image_array other
  eql = other.eql?(@images)
  begin # "other" is another ImageList
    eql &&= @scene == other.scene
  rescue NoMethodError
    # "other" is a plain Array
  end
  eql
end

#fill(*args, &block) ⇒ Object 



1563
1564
1565
1566
1567
1568
1569
1570
 
# File 'lib/rmagick_internal.rb', line 1563

def fill(*args, &block)
  assert_image args[0] unless block_given?
  current = get_current
  @images.fill(*args, &block)
  assert_image_array self
  set_current current
  self
end

#find_all(&block) ⇒ Object Also known as: select

Override Enumerable’s find_all



1573
1574
1575
1576
1577
1578
1579
1580
 
# File 'lib/rmagick_internal.rb', line 1573

def find_all(&block)
  current = get_current
  a = @images.select(&block)
  ilist = self.class.new
  a.each { |image| ilist << image }
  ilist.set_current current
  ilist
end

#flatten_images ⇒ Magick::ImageList

Merge all the images into a single image.

Returns:



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'ext/RMagick/rmilist.c', line 404

VALUE
ImageList_flatten_images(VALUE self)
{
    Image *images, *new_image;
    ExceptionInfo *exception;

    images = images_from_imagelist(self);
    exception = AcquireExceptionInfo();

    new_image = MergeImageLayers(images, FlattenLayer, exception);

    rm_split(images);
    rm_check_exception(exception, new_image, DestroyOnError);
    DestroyExceptionInfo(exception);

    return rm_image_new(new_image);
}

#from_blob(*blobs, &block) ⇒ Object 



1583
1584
1585
1586
1587
1588
1589
1590
 
# File 'lib/rmagick_internal.rb', line 1583

def from_blob(*blobs, &block)
  Kernel.raise ArgumentError, 'no blobs given' if blobs.length.zero?
  blobs.each do |b|
    Magick::Image.from_blob(b, &block).each { |n| @images << n }
  end
  @scene = length - 1
  self
end

#insert(index, *args) ⇒ Object 



1603
1604
1605
1606
1607
1608
1609
 
# File 'lib/rmagick_internal.rb', line 1603

def insert(index, *args)
  args.each { |image| assert_image image }
  current = get_current
  @images.insert(index, *args)
  set_current current
  self
end

#inspect ⇒ Object

Call inspect for all the images



1612
1613
1614
1615
1616
 
# File 'lib/rmagick_internal.rb', line 1612

def inspect
  img = []
  @images.each { |image| img << image.inspect }
  img = '[' + img.join(",\n") + "]\nscene=#{@scene}"
end

#iterations=(n) ⇒ Object

Set the number of iterations of an animated GIF



1619
1620
1621
1622
1623
 
# File 'lib/rmagick_internal.rb', line 1619

def iterations=(n)
  n = Integer(n)
  Kernel.raise ArgumentError, 'iterations must be between 0 and 65535' if n < 0 || n > 65_535
  @images.each { |f| f.iterations = n }
end

#last(*args) ⇒ Object 



1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
 
# File 'lib/rmagick_internal.rb', line 1625

def last(*args)
  if args.length.zero?
    a = @images.last
  else
    a = @images.last(*args)
    ilist = self.class.new
    a.each { |img| ilist << img }
    @scene = a.length - 1
    a = ilist
  end
  a
end

#marshal_dump ⇒ Object

Custom marshal/unmarshal for Ruby 1.8.



1639
1640
1641
1642
1643
 
# File 'lib/rmagick_internal.rb', line 1639

def marshal_dump
  ary = [@scene]
  @images.each { |i| ary << Marshal.dump(i) }
  ary
end

#marshal_load(ary) ⇒ Object 



1645
1646
1647
1648
1649
 
# File 'lib/rmagick_internal.rb', line 1645

def marshal_load(ary)
  @scene = ary.shift
  @images = []
  ary.each { |a| @images << Marshal.load(a) }
end

#montage ⇒ Magick::ImageList #montage {|Magick::ImageList::Montage| ... } ⇒ Magick::ImageList

Tile one or more thumbnails across an image canvas.

Overloads:

Returns:



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'ext/RMagick/rmilist.c', line 435

VALUE
ImageList_montage(VALUE self)
{
    VALUE montage_obj;
    Montage *montage;
    Image *new_images, *images;
    ExceptionInfo *exception;

    // Create a new instance of the Magick::ImageList::Montage class
    montage_obj = rm_montage_new();
    if (rb_block_given_p())
    {
        // Run the block in the instance's context, allowing the app to modify the
        // object's attributes.
        if (rb_proc_arity(rb_block_proc()) == 0)
        {
            rb_warn("passing a block without an image argument is deprecated");
            rb_obj_instance_eval(0, NULL, montage_obj);
        }
        else
        {
            rb_yield(montage_obj);
        }
    }

    Data_Get_Struct(montage_obj, Montage, montage);

    images = images_from_imagelist(self);

    for (Image *image = images; image; image = GetNextImageInList(image))
    {
        if (montage->compose != UndefinedCompositeOp)
        {
            image->compose = montage->compose;
        }
        image->background_color = montage->info->background_color;
        image->border_color = montage->info->border_color;
        image->matte_color = montage->info->matte_color;
        image->gravity = montage->info->gravity;
    }

    exception = AcquireExceptionInfo();

    // MontageImage can return more than one image.
    new_images = MontageImages(images, montage->info, exception);
    rm_split(images);
    rm_check_exception(exception, new_images, DestroyOnError);
    DestroyExceptionInfo(exception);

    RB_GC_GUARD(montage_obj);

    return rm_imagelist_from_images(new_images);
}

#morph(nimages) ⇒ Magick::ImageList

Note:

Sets @scenes to 0

Requires a minimum of two images. The first image is transformed into the second by a number of intervening images as specified by “nimages”.

Parameters:

  • nimages (Numeric) —

    the number of images

Returns:

  • (Magick::ImageList) —

    a new image list with the images array set to the morph sequence.



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'ext/RMagick/rmilist.c', line 498

VALUE
ImageList_morph(VALUE self, VALUE nimages)
{
    Image *images, *new_images;
    ExceptionInfo *exception;
    long number_images;


    // Use a signed long so we can test for a negative argument.
    number_images = NUM2LONG(nimages);
    if (number_images <= 0)
    {
        rb_raise(rb_eArgError, "number of intervening images must be > 0");
    }

    images = images_from_imagelist(self);
    exception = AcquireExceptionInfo();
    new_images = MorphImages(images, (unsigned long)number_images, exception);
    rm_split(images);
    rm_check_exception(exception, new_images, DestroyOnError);
    DestroyExceptionInfo(exception);

    return rm_imagelist_from_images(new_images);
}

#mosaic ⇒ Magick::Image

Merge all the images into a single image.

Returns:



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'ext/RMagick/rmilist.c', line 529

VALUE
ImageList_mosaic(VALUE self)
{
    Image *images, *new_image;
    ExceptionInfo *exception;

    images = images_from_imagelist(self);

    exception = AcquireExceptionInfo();
    new_image = MergeImageLayers(images, MosaicLayer, exception);

    rm_split(images);
    rm_check_exception(exception, new_image, DestroyOnError);
    DestroyExceptionInfo(exception);

    return rm_image_new(new_image);
}

#new_image(cols, rows, *fill, &info_blk) ⇒ Object

Create a new image and add it to the end



1669
1670
1671
 
# File 'lib/rmagick_internal.rb', line 1669

def new_image(cols, rows, *fill, &info_blk)
  self << Magick::Image.new(cols, rows, *fill, &info_blk)
end

#optimize_layers(method) ⇒ Magick::ImageList

Optimizes or compares the images in the list. Equivalent to the -layers option in ImageMagick’s mogrify command.

Parameters:

  • method (Magick::LayerMethod) —

    the method to use

Returns:



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'ext/RMagick/rmilist.c', line 555

VALUE
ImageList_optimize_layers(VALUE self, VALUE method)
{
    Image *images, *new_images, *new_images2;
    LayerMethod mthd;
    ExceptionInfo *exception;
    QuantizeInfo quantize_info;

    new_images2 = NULL;     // defeat "unused variable" message

    VALUE_TO_ENUM(method, mthd, LayerMethod);
    images = images_from_imagelist(self);

    exception = AcquireExceptionInfo();
    switch (mthd)
    {
        case CoalesceLayer:
            new_images = CoalesceImages(images, exception);
            break;
        case DisposeLayer:
            new_images = DisposeImages(images, exception);
            break;
        case OptimizeTransLayer:
            new_images = clone_imagelist(images);
            OptimizeImageTransparency(new_images, exception);
            break;
        case RemoveDupsLayer:
            new_images = clone_imagelist(images);
            RemoveDuplicateLayers(&new_images, exception);
            break;
        case RemoveZeroLayer:
            new_images = clone_imagelist(images);
            RemoveZeroDelayLayers(&new_images, exception);
            break;
        case CompositeLayer:
            rm_split(images);
            DestroyExceptionInfo(exception);
            rb_raise(rb_eNotImpError, "Magick::CompositeLayer is not supported. Use the composite_layers method instead.");
            break;
            // In 6.3.4-ish, OptimizeImageLayer replaced OptimizeLayer
        case OptimizeImageLayer:
            new_images = OptimizeImageLayers(images, exception);
            break;
            // and OptimizeLayer became a "General Purpose, GIF Animation Optimizer" (ref. mogrify.c)
        case OptimizeLayer:
            new_images = CoalesceImages(images, exception);
            rm_split(images);
            rm_check_exception(exception, new_images, DestroyOnError);
            new_images2 = OptimizeImageLayers(new_images, exception);
            DestroyImageList(new_images);
            rm_check_exception(exception, new_images2, DestroyOnError);
            new_images = new_images2;
            OptimizeImageTransparency(new_images, exception);
            rm_check_exception(exception, new_images, DestroyOnError);
            // mogrify supports -dither here. We don't.
            GetQuantizeInfo(&quantize_info);
#if defined(IMAGEMAGICK_7)
            RemapImages(&quantize_info, new_images, NULL, exception);
#else
            RemapImages(&quantize_info, new_images, NULL);
#endif
            break;
        case OptimizePlusLayer:
            new_images = OptimizePlusImageLayers(images, exception);
            break;
        case CompareAnyLayer:
        case CompareClearLayer:
        case CompareOverlayLayer:
#if defined(IMAGEMAGICK_7)
            new_images = CompareImagesLayers(images, mthd, exception);
#else
            new_images = CompareImageLayers(images, mthd, exception);
#endif
            break;
        case MosaicLayer:
            new_images = MergeImageLayers(images, mthd, exception);
            break;
        case FlattenLayer:
            new_images = MergeImageLayers(images, mthd, exception);
            break;
        case MergeLayer:
            new_images = MergeImageLayers(images, mthd, exception);
            break;
        case TrimBoundsLayer:
            new_images = MergeImageLayers(images, mthd, exception);
            break;
        default:
            rm_split(images);
            DestroyExceptionInfo(exception);
            rb_raise(rb_eArgError, "undefined layer method");
            break;
    }

    rm_split(images);
    rm_check_exception(exception, new_images, DestroyOnError);
    DestroyExceptionInfo(exception);

    return rm_imagelist_from_images(new_images);
}

#partition(&block) ⇒ Object 



1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
 
# File 'lib/rmagick_internal.rb', line 1673

def partition(&block)
  a = @images.partition(&block)
  t = self.class.new
  a[0].each { |img| t << img }
  t.set_current nil
  f = self.class.new
  a[1].each { |img| f << img }
  f.set_current nil
  [t, f]
end

#ping(*files, &block) ⇒ Object

Ping files and concatenate the new images



1685
1686
1687
1688
1689
1690
1691
1692
 
# File 'lib/rmagick_internal.rb', line 1685

def ping(*files, &block)
  Kernel.raise ArgumentError, 'no files given' if files.length.zero?
  files.each do |f|
    Magick::Image.ping(f, &block).each { |n| @images << n }
  end
  @scene = length - 1
  self
end

#pop ⇒ Object 



1694
1695
1696
1697
1698
1699
 
# File 'lib/rmagick_internal.rb', line 1694

def pop
  current = get_current
  a = @images.pop # can return nil
  set_current current
  a
end

#push(*objs) ⇒ Object 



1701
1702
1703
1704
1705
1706
1707
1708
 
# File 'lib/rmagick_internal.rb', line 1701

def push(*objs)
  objs.each do |image|
    assert_image image
    @images << image
  end
  @scene = length - 1
  self
end

#quantize(number_colors = 256, colorspace = Magick::RGBColorsapce, dither = true, tree_depth = 0, measure_error = false) ⇒ Magick::ImageList

Analyzes the colors within a set of reference images and chooses a fixed number of colors to represent the set. The goal of the algorithm is to minimize the difference between the input and output images while minimizing the processing time.

Note:

Sets @scene to the same value as self.scene

Returns a new ImageList with quantized images.

Parameters:

  • number_colors (Numeric) (defaults to: 256) —

    the maximum number of colors to use in the output images.

  • colorspace (Magick::ColorspaceType) (defaults to: Magick::RGBColorsapce) —

    the colorspace to quantize in.

  • dither (Magick::DitherMethod, Boolean) (defaults to: true) —

    a DitherMethod value or true if you want apply dither.

  • tree_depth (Numeric) (defaults to: 0) —

    specify the tree depth to use while quantizing.

  • measure_error (Boolean) (defaults to: false) —

    calculate quantization errors when quantizing the image.

Returns:



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'ext/RMagick/rmilist.c', line 861

VALUE
ImageList_quantize(int argc, VALUE *argv, VALUE self)
{
    Image *images, *new_images;
    Image *new_image;
    QuantizeInfo quantize_info;
    ExceptionInfo *exception;
    VALUE new_imagelist, scene;

    GetQuantizeInfo(&quantize_info);

    switch (argc)
    {
        case 5:
            quantize_info.measure_error = (MagickBooleanType) RTEST(argv[4]);
        case 4:
            quantize_info.tree_depth = (unsigned long)NUM2INT(argv[3]);
        case 3:
#if defined(IMAGEMAGICK_7)
            if (rb_obj_is_kind_of(argv[2], Class_DitherMethod))
            {
                VALUE_TO_ENUM(argv[2], quantize_info.dither_method, DitherMethod);
            }
            else
            {
                quantize_info.dither_method = RTEST(argv[2]) ? UndefinedDitherMethod : NoDitherMethod;
            }
#else
            if (rb_obj_is_kind_of(argv[2], Class_DitherMethod))
            {
                VALUE_TO_ENUM(argv[2], quantize_info.dither_method, DitherMethod);
                quantize_info.dither = quantize_info.dither_method != NoDitherMethod;
            }
            else
            {
                quantize_info.dither = (MagickBooleanType) RTEST(argv[2]);
            }
#endif
        case 2:
            VALUE_TO_ENUM(argv[1], quantize_info.colorspace, ColorspaceType);
        case 1:
            quantize_info.number_colors = NUM2ULONG(argv[0]);
        case 0:
            break;
        default:
            rb_raise(rb_eArgError, "wrong number of arguments (%d for 0 to 5)", argc);
            break;
    }


    // Convert image array to image sequence, clone image sequence.
    images = images_from_imagelist(self);
    exception = AcquireExceptionInfo();
    new_images = CloneImageList(images, exception);
    rm_split(images);
    rm_check_exception(exception, new_images, DestroyOnError);

    rm_ensure_result(new_images);

#if defined(IMAGEMAGICK_7)
    QuantizeImages(&quantize_info, new_images, exception);
#else
    QuantizeImages(&quantize_info, new_images);
#endif
    rm_check_exception(exception, new_images, DestroyOnError);
    DestroyExceptionInfo(exception);

    // Create new ImageList object, convert mapped image sequence to images,
    // append to images array.
    new_imagelist = ImageList_new();
    while ((new_image = RemoveFirstImageFromList(&new_images)))
    {
        imagelist_push(new_imagelist, rm_image_new(new_image));
    }

    // Set @scene in new ImageList object to same value as in self.
    scene = rb_iv_get(self, "@scene");
    rb_iv_set(new_imagelist, "@scene", scene);

    RB_GC_GUARD(new_imagelist);
    RB_GC_GUARD(scene);

    return new_imagelist;
}

#read(*files, &block) ⇒ Object

Read files and concatenate the new images



1711
1712
1713
1714
1715
1716
1717
1718
 
# File 'lib/rmagick_internal.rb', line 1711

def read(*files, &block)
  Kernel.raise ArgumentError, 'no files given' if files.length.zero?
  files.each do |f|
    Magick::Image.read(f, &block).each { |n| @images << n }
  end
  @scene = length - 1
  self
end

#reject(&block) ⇒ Object

override Enumerable’s reject



1721
1722
1723
1724
1725
1726
1727
1728
 
# File 'lib/rmagick_internal.rb', line 1721

def reject(&block)
  current = get_current
  ilist = self.class.new
  a = @images.reject(&block)
  a.each { |image| ilist << image }
  ilist.set_current current
  ilist
end

#reject!(&block) ⇒ Object 



1730
1731
1732
1733
1734
1735
1736
 
# File 'lib/rmagick_internal.rb', line 1730

def reject!(&block)
  current = get_current
  a = @images.reject!(&block)
  @images = a unless a.nil?
  set_current current
  a.nil? ? nil : self
end

#remap(remap_image = nil, dither_method = Magick::RiemersmaDitherMethod) ⇒ Magick::ImageList Also known as: affinity

Reduce the colors used in the image list to the set of colors in remap_image.

Note:

Modifies images in-place.

Returns self.

Parameters:

  • remap_image (Magick::Image, Magick::ImageList) (defaults to: nil) —

    Either an imagelist or an image. If an imagelist, uses the current image.

  • dither_method (Magick::DitherMethod) (defaults to: Magick::RiemersmaDitherMethod) —

    a DitherMethod value.

Returns:



957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
 
# File 'ext/RMagick/rmilist.c', line 957

VALUE
ImageList_remap(int argc, VALUE *argv, VALUE self)
{
    Image *images, *remap_image = NULL;
    QuantizeInfo quantize_info;
#if defined(IMAGEMAGICK_7)
    ExceptionInfo *exception;
#endif

    if (argc > 0 && argv[0] != Qnil)
    {
        VALUE t = rm_cur_image(argv[0]);
        remap_image = rm_check_destroyed(t);
        RB_GC_GUARD(t);
    }

    GetQuantizeInfo(&quantize_info);

    if (argc > 1)
    {
        VALUE_TO_ENUM(argv[1], quantize_info.dither_method, DitherMethod);
#if defined(IMAGEMAGICK_6)
        quantize_info.dither = MagickTrue;
#endif
    }
    if (argc > 2)
    {
        rb_raise(rb_eArgError, "wrong number of arguments (%d for 1 or 2)", argc);
    }

    images = images_from_imagelist(self);

#if defined(IMAGEMAGICK_7)
    exception = AcquireExceptionInfo();
    RemapImages(&quantize_info, images, remap_image, exception);
    rm_split(images);
    CHECK_EXCEPTION();
    DestroyExceptionInfo(exception);
#else
    RemapImages(&quantize_info, images, remap_image);
    rm_split(images);
    rm_check_image_exception(images, RetainOnError);
#endif

    return self;
}

#replace(other) ⇒ Object 



1738
1739
1740
1741
1742
1743
1744
1745
1746
 
# File 'lib/rmagick_internal.rb', line 1738

def replace(other)
  assert_image_array other
  current = get_current
  @images.clear
  other.each { |image| @images << image }
  @scene = length.zero? ? nil : 0
  set_current current
  self
end

#respond_to?(meth_id, priv = false) ⇒ Boolean

Returns:

  • (Boolean) 


1750
1751
1752
1753
1754
1755
1756
1757
1758
 
# File 'lib/rmagick_internal.rb', line 1750

def respond_to?(meth_id, priv = false)
  return true if __respond_to__?(meth_id, priv)

  if @scene
    @images[@scene].respond_to?(meth_id, priv)
  else
    super
  end
end

#reverse ⇒ Object 



1760
1761
1762
1763
1764
1765
1766
 
# File 'lib/rmagick_internal.rb', line 1760

def reverse
  current = get_current
  a = self.class.new
  @images.reverse_each { |image| a << image }
  a.set_current current
  a
end

#reverse! ⇒ Object 



1768
1769
1770
1771
1772
1773
 
# File 'lib/rmagick_internal.rb', line 1768

def reverse!
  current = get_current
  @images.reverse!
  set_current current
  self
end

#reverse_each ⇒ Object 



1775
1776
1777
1778
 
# File 'lib/rmagick_internal.rb', line 1775

def reverse_each
  @images.reverse_each { |image| yield(image) }
  self
end

#shift ⇒ Object 



1780
1781
1782
1783
1784
1785
 
# File 'lib/rmagick_internal.rb', line 1780

def shift
  current = get_current
  a = @images.shift
  set_current current
  a
end

#slice(*args) ⇒ Object 



1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
 
# File 'lib/rmagick_internal.rb', line 1787

def slice(*args)
  slice = @images.slice(*args)
  if slice
    ilist = self.class.new
    if slice.respond_to?(:each)
      slice.each { |image| ilist << image }
    else
      ilist << slice
    end
  else
    ilist = nil
  end
  ilist
end

#slice!(*args) ⇒ Object 



1802
1803
1804
1805
1806
1807
 
# File 'lib/rmagick_internal.rb', line 1802

def slice!(*args)
  current = get_current
  a = @images.slice!(*args)
  set_current current
  a
end

#ticks_per_second=(t) ⇒ Object 



1809
1810
1811
1812
 
# File 'lib/rmagick_internal.rb', line 1809

def ticks_per_second=(t)
  Kernel.raise ArgumentError, 'ticks_per_second must be greater than or equal to 0' if Integer(t) < 0
  @images.each { |f| f.ticks_per_second = Integer(t) }
end

#to_a ⇒ Object 



1814
1815
1816
1817
1818
 
# File 'lib/rmagick_internal.rb', line 1814

def to_a
  a = []
  @images.each { |image| a << image }
  a
end

#to_blob ⇒ String #to_blob {|Magick::Image::Info| ... } ⇒ String

Return the imagelist as a blob (a String).

Overloads:

  • #to_blob {|Magick::Image::Info| ... } ⇒ String

    Runs an info parm block if present - the user can specify the image format and depth

    Yields:

Returns:

  • (String) —

    the blob



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'ext/RMagick/rmilist.c', line 1016

VALUE
ImageList_to_blob(VALUE self)
{
    Image *images, *image;
    Info *info;
    VALUE info_obj;
    VALUE blob_str;
    void *blob = NULL;
    size_t length = 0;
    ExceptionInfo *exception;

    info_obj = rm_info_new();
    Data_Get_Struct(info_obj, Info, info);

    // Convert the images array to an images sequence.
    images = images_from_imagelist(self);

    exception = AcquireExceptionInfo();
    SetImageInfo(info, MagickTrue, exception);
    rm_check_exception(exception, images, RetainOnError);

    if (*info->magick != '\0')
    {
        Image *img;
        for (img = images; img; img = GetNextImageInList(img))
        {
            strlcpy(img->magick, info->magick, sizeof(img->magick));
        }
    }

    for (image = images; image; image = GetNextImageInList(image))
    {
        rm_sync_image_options(image, info);
    }

    // Unconditionally request multi-images support. The worst that
    // can happen is that there's only one image or the format
    // doesn't support multi-image files.
    info->adjoin = MagickTrue;
    blob = ImagesToBlob(info, images, &length, exception);
    if (blob && exception->severity >= ErrorException)
    {
        magick_free((void*)blob);
        blob = NULL;
        length = 0;
    }
    rm_split(images);
    CHECK_EXCEPTION();
    DestroyExceptionInfo(exception);


    if (length == 0 || !blob)
    {
        return Qnil;
    }

    blob_str = rb_str_new(blob, (long)length);
    magick_free((void*)blob);

    RB_GC_GUARD(info_obj);
    RB_GC_GUARD(blob_str);

    return blob_str;
}

#uniq ⇒ Object 



1820
1821
1822
1823
1824
1825
1826
 
# File 'lib/rmagick_internal.rb', line 1820

def uniq
  current = get_current
  a = self.class.new
  @images.uniq.each { |image| a << image }
  a.set_current current
  a
end

#uniq!(*_args) ⇒ Object 



1828
1829
1830
1831
1832
1833
 
# File 'lib/rmagick_internal.rb', line 1828

def uniq!(*_args)
  current = get_current
  a = @images.uniq!
  set_current current
  a.nil? ? nil : self
end

#unshift(obj) ⇒ Object 



1836
1837
1838
1839
1840
1841
 
# File 'lib/rmagick_internal.rb', line 1836

def unshift(obj)
  assert_image obj
  @images.unshift(obj)
  @scene = 0
  self
end

#values_at(*args) ⇒ Object Also known as: indexes, indices 



1843
1844
1845
1846
1847
1848
1849
 
# File 'lib/rmagick_internal.rb', line 1843

def values_at(*args)
  a = @images.values_at(*args)
  a = self.class.new
  @images.values_at(*args).each { |image| a << image }
  a.scene = a.length - 1
  a
end

#write(file) ⇒ Object

Write all the images to the specified file. If the file format supports multi-image files, and the ‘images’ array contains more than one image, then the images will be written as a single multi-image file. Otherwise each image will be written to a separate file.

Parameters:

  • file (File, String) —

    the file



1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'ext/RMagick/rmilist.c', line 1090

VALUE
ImageList_write(VALUE self, VALUE file)
{
    Image *images, *img;
    Info *info;
    const MagickInfo *m;
    VALUE info_obj;
    unsigned long scene;
    ExceptionInfo *exception;

    info_obj = rm_info_new();
    Data_Get_Struct(info_obj, Info, info);


    if (TYPE(file) == T_FILE)
    {
        rb_io_t *fptr;

        // Ensure file is open - raise error if not
        GetOpenFile(file, fptr);
#if defined(_WIN32)
        add_format_prefix(info, fptr->pathv);
        SetImageInfoFile(info, NULL);
#else
        SetImageInfoFile(info, rb_io_stdio_file(fptr));
#endif
    }
    else
    {
        add_format_prefix(info, file);
        SetImageInfoFile(info, NULL);
    }

    // Convert the images array to an images sequence.
    images = images_from_imagelist(self);

    // Copy the filename into each image. Set a scene number to be used if
    // writing multiple files. (Ref: ImageMagick's utilities/convert.c
    for (scene = 0, img = images; img; img = GetNextImageInList(img))
    {
        img->scene = scene++;
        strlcpy(img->filename, info->filename, sizeof(img->filename));
    }

    // Find out if the format supports multi-images files.
    exception = AcquireExceptionInfo();
    SetImageInfo(info, MagickTrue, exception);
    rm_check_exception(exception, images, RetainOnError);

    m = GetMagickInfo(info->magick, exception);
    rm_check_exception(exception, images, RetainOnError);
#if defined(IMAGEMAGICK_6)
    DestroyExceptionInfo(exception);
#endif

    // Tell WriteImage if we want a multi-images file.
    if (imagelist_length(self) > 1L && GetMagickAdjoin(m))
    {
        info->adjoin = MagickTrue;
    }

    for (img = images; img; img = GetNextImageInList(img))
    {
        rm_sync_image_options(img, info);
#if defined(IMAGEMAGICK_7)
        WriteImage(info, img, exception);
        rm_check_exception(exception, img, RetainOnError);
#else
        WriteImage(info, img);
        // images will be split before raising an exception
        rm_check_image_exception(images, RetainOnError);
#endif
        if (info->adjoin)
        {
            break;
        }
    }

#if defined(IMAGEMAGICK_7)
    DestroyExceptionInfo(exception);
#endif

    rm_split(images);

    RB_GC_GUARD(info_obj);

    return self;
}