ruby-vips 2.2.2 → 2.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/lib/vips/methods.rb CHANGED
@@ -18,6 +18,18 @@ module Vips
18
18
  # @param opts [Hash] Set of options
19
19
  # @return [Vips::Image] Output image
20
20
 
21
+ # @!method minpair(right, **opts)
22
+ # Minimum of a pair of images.
23
+ # @param right [Vips::Image] Right-hand image argument
24
+ # @param opts [Hash] Set of options
25
+ # @return [Vips::Image] Output image
26
+
27
+ # @!method maxpair(right, **opts)
28
+ # Maximum of a pair of images.
29
+ # @param right [Vips::Image] Right-hand image argument
30
+ # @param opts [Hash] Set of options
31
+ # @return [Vips::Image] Output image
32
+
21
33
  # @!method subtract(right, **opts)
22
34
  # Subtract two images.
23
35
  # @param right [Vips::Image] Right-hand image argument
@@ -76,10 +88,11 @@ module Vips
76
88
  # @param opts [Hash] Set of options
77
89
  # @return [Vips::Image] Output image
78
90
 
79
- # @!method self.sum(im, **opts)
80
- # Sum an array of images.
81
- # @param im [Array<Image>] Array of input images
91
+ # @!method clamp(**opts)
92
+ # Clamp values of an image.
82
93
  # @param opts [Hash] Set of options
94
+ # @option opts [Float] :min Minimum value
95
+ # @option opts [Float] :max Maximum value
83
96
  # @return [Vips::Image] Output image
84
97
 
85
98
  # @!method invert(**opts)
@@ -156,6 +169,12 @@ module Vips
156
169
  # @param opts [Hash] Set of options
157
170
  # @return [Vips::Image] Output image
158
171
 
172
+ # @!method self.sum(im, **opts)
173
+ # Sum an array of images.
174
+ # @param im [Array<Image>] Array of input images
175
+ # @param opts [Hash] Set of options
176
+ # @return [Vips::Image] Output image
177
+
159
178
  # @!method avg(**opts)
160
179
  # Find image average.
161
180
  # @param opts [Hash] Set of options
@@ -253,6 +272,7 @@ module Vips
253
272
  # @param x [Integer] Point to read
254
273
  # @param y [Integer] Point to read
255
274
  # @param opts [Hash] Set of options
275
+ # @option opts [Boolean] :unpack_complex Complex pixels should be unpacked
256
276
  # @return [Array<Double>] Array of output values
257
277
 
258
278
  # @!method find_trim(**opts)
@@ -304,14 +324,6 @@ module Vips
304
324
  # @option opts [Integer] :tile_height Tile height in pixels
305
325
  # @return [Vips::Image] Output image
306
326
 
307
- # @!method cache(**opts)
308
- # Cache an image.
309
- # @param opts [Hash] Set of options
310
- # @option opts [Integer] :max_tiles Maximum number of tiles to cache
311
- # @option opts [Integer] :tile_height Tile height in pixels
312
- # @option opts [Integer] :tile_width Tile width in pixels
313
- # @return [Vips::Image] Output image
314
-
315
327
  # @!method embed(x, y, width, height, **opts)
316
328
  # Embed an image in a larger image.
317
329
  # @param x [Integer] Left edge of input in output
@@ -573,6 +585,11 @@ module Vips
573
585
  # @option opts [Boolean] :premultiplied Images have premultiplied alpha
574
586
  # @return [Vips::Image] Output image
575
587
 
588
+ # @!method addalpha(**opts)
589
+ # Append an alpha channel.
590
+ # @param opts [Hash] Set of options
591
+ # @return [Vips::Image] Output image
592
+
576
593
  # @!method self.black(width, height, **opts)
577
594
  # Make a black image.
578
595
  # @param width [Integer] Image width in pixels
@@ -636,6 +653,18 @@ module Vips
636
653
  # @option opts [Integer] :autofit_dpi Output DPI selected by autofit
637
654
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
638
655
 
656
+ # @!method self.sdf(width, height, shape, **opts)
657
+ # Create an sdf image.
658
+ # @param width [Integer] Image width in pixels
659
+ # @param height [Integer] Image height in pixels
660
+ # @param shape [Vips::SdfShape] SDF shape to create
661
+ # @param opts [Hash] Set of options
662
+ # @option opts [Float] :r Radius
663
+ # @option opts [Array<Double>] :a Point a
664
+ # @option opts [Array<Double>] :b Point b
665
+ # @option opts [Array<Double>] :corners Corner radii
666
+ # @return [Vips::Image] Output image
667
+
639
668
  # @!method self.eye(width, height, **opts)
640
669
  # Make an image showing the eye's spatial response.
641
670
  # @param width [Integer] Image width in pixels
@@ -989,8 +1018,19 @@ module Vips
989
1018
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
990
1019
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
991
1020
 
1021
+ # @!method self.ppmload_buffer(buffer, **opts)
1022
+ # Load ppm from buffer.
1023
+ # @param buffer [VipsBlob] Buffer to load from
1024
+ # @param opts [Hash] Set of options
1025
+ # @option opts [Boolean] :memory Force open via memory
1026
+ # @option opts [Vips::Access] :access Required access pattern for this file
1027
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1028
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1029
+ # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1030
+ # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1031
+
992
1032
  # @!method self.ppmload_source(source, **opts)
993
- # Load ppm base class.
1033
+ # Load ppm from source.
994
1034
  # @param source [Vips::Source] Source to load from
995
1035
  # @param opts [Hash] Set of options
996
1036
  # @option opts [Boolean] :memory Force open via memory
@@ -1040,6 +1080,8 @@ module Vips
1040
1080
  # @option opts [Float] :dpi Render at this DPI
1041
1081
  # @option opts [Float] :scale Scale output by this factor
1042
1082
  # @option opts [Boolean] :unlimited Allow SVG of any size
1083
+ # @option opts [String] :stylesheet Custom CSS
1084
+ # @option opts [Boolean] :high_bitdepth Enable scRGB 128-bit output (32-bit per channel)
1043
1085
  # @option opts [Boolean] :memory Force open via memory
1044
1086
  # @option opts [Vips::Access] :access Required access pattern for this file
1045
1087
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1054,6 +1096,8 @@ module Vips
1054
1096
  # @option opts [Float] :dpi Render at this DPI
1055
1097
  # @option opts [Float] :scale Scale output by this factor
1056
1098
  # @option opts [Boolean] :unlimited Allow SVG of any size
1099
+ # @option opts [String] :stylesheet Custom CSS
1100
+ # @option opts [Boolean] :high_bitdepth Enable scRGB 128-bit output (32-bit per channel)
1057
1101
  # @option opts [Boolean] :memory Force open via memory
1058
1102
  # @option opts [Vips::Access] :access Required access pattern for this file
1059
1103
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1068,6 +1112,8 @@ module Vips
1068
1112
  # @option opts [Float] :dpi Render at this DPI
1069
1113
  # @option opts [Float] :scale Scale output by this factor
1070
1114
  # @option opts [Boolean] :unlimited Allow SVG of any size
1115
+ # @option opts [String] :stylesheet Custom CSS
1116
+ # @option opts [Boolean] :high_bitdepth Enable scRGB 128-bit output (32-bit per channel)
1071
1117
  # @option opts [Boolean] :memory Force open via memory
1072
1118
  # @option opts [Vips::Access] :access Required access pattern for this file
1073
1119
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1080,6 +1126,7 @@ module Vips
1080
1126
  # @param filename [String] Filename to load from
1081
1127
  # @param opts [Hash] Set of options
1082
1128
  # @option opts [Integer] :page Load this page from the image
1129
+ # @option opts [Boolean] :oneshot Load images a frame at a time
1083
1130
  # @option opts [Boolean] :memory Force open via memory
1084
1131
  # @option opts [Vips::Access] :access Required access pattern for this file
1085
1132
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1092,6 +1139,7 @@ module Vips
1092
1139
  # @param buffer [VipsBlob] Buffer to load from
1093
1140
  # @param opts [Hash] Set of options
1094
1141
  # @option opts [Integer] :page Load this page from the image
1142
+ # @option opts [Boolean] :oneshot Load images a frame at a time
1095
1143
  # @option opts [Boolean] :memory Force open via memory
1096
1144
  # @option opts [Vips::Access] :access Required access pattern for this file
1097
1145
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1104,6 +1152,7 @@ module Vips
1104
1152
  # @param source [Vips::Source] Source to load from
1105
1153
  # @param opts [Hash] Set of options
1106
1154
  # @option opts [Integer] :page Load this page from the image
1155
+ # @option opts [Boolean] :oneshot Load images a frame at a time
1107
1156
  # @option opts [Boolean] :memory Force open via memory
1108
1157
  # @option opts [Vips::Access] :access Required access pattern for this file
1109
1158
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1286,9 +1335,10 @@ module Vips
1286
1335
  # @param filename [String] Filename to load from
1287
1336
  # @param opts [Hash] Set of options
1288
1337
  # @option opts [Integer] :page First page to load
1289
- # @option opts [Integer] :subifd Subifd index
1290
1338
  # @option opts [Integer] :n Number of pages to load, -1 for all
1291
1339
  # @option opts [Boolean] :autorotate Rotate image using orientation tag
1340
+ # @option opts [Integer] :subifd Subifd index
1341
+ # @option opts [Boolean] :unlimited Remove all denial of service limits
1292
1342
  # @option opts [Boolean] :memory Force open via memory
1293
1343
  # @option opts [Vips::Access] :access Required access pattern for this file
1294
1344
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1301,9 +1351,10 @@ module Vips
1301
1351
  # @param buffer [VipsBlob] Buffer to load from
1302
1352
  # @param opts [Hash] Set of options
1303
1353
  # @option opts [Integer] :page First page to load
1304
- # @option opts [Integer] :subifd Subifd index
1305
1354
  # @option opts [Integer] :n Number of pages to load, -1 for all
1306
1355
  # @option opts [Boolean] :autorotate Rotate image using orientation tag
1356
+ # @option opts [Integer] :subifd Subifd index
1357
+ # @option opts [Boolean] :unlimited Remove all denial of service limits
1307
1358
  # @option opts [Boolean] :memory Force open via memory
1308
1359
  # @option opts [Vips::Access] :access Required access pattern for this file
1309
1360
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1316,9 +1367,10 @@ module Vips
1316
1367
  # @param source [Vips::Source] Source to load from
1317
1368
  # @param opts [Hash] Set of options
1318
1369
  # @option opts [Integer] :page First page to load
1319
- # @option opts [Integer] :subifd Subifd index
1320
1370
  # @option opts [Integer] :n Number of pages to load, -1 for all
1321
1371
  # @option opts [Boolean] :autorotate Rotate image using orientation tag
1372
+ # @option opts [Integer] :subifd Subifd index
1373
+ # @option opts [Boolean] :unlimited Remove all denial of service limits
1322
1374
  # @option opts [Boolean] :memory Force open via memory
1323
1375
  # @option opts [Vips::Access] :access Required access pattern for this file
1324
1376
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1462,6 +1514,8 @@ module Vips
1462
1514
  # Load jpeg-xl image.
1463
1515
  # @param filename [String] Filename to load from
1464
1516
  # @param opts [Hash] Set of options
1517
+ # @option opts [Integer] :page First page to load
1518
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1465
1519
  # @option opts [Boolean] :memory Force open via memory
1466
1520
  # @option opts [Vips::Access] :access Required access pattern for this file
1467
1521
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1473,6 +1527,8 @@ module Vips
1473
1527
  # Load jpeg-xl image.
1474
1528
  # @param buffer [VipsBlob] Buffer to load from
1475
1529
  # @param opts [Hash] Set of options
1530
+ # @option opts [Integer] :page First page to load
1531
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1476
1532
  # @option opts [Boolean] :memory Force open via memory
1477
1533
  # @option opts [Vips::Access] :access Required access pattern for this file
1478
1534
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1484,6 +1540,8 @@ module Vips
1484
1540
  # Load jpeg-xl image.
1485
1541
  # @param source [Vips::Source] Source to load from
1486
1542
  # @param opts [Hash] Set of options
1543
+ # @option opts [Integer] :page First page to load
1544
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1487
1545
  # @option opts [Boolean] :memory Force open via memory
1488
1546
  # @option opts [Vips::Access] :access Required access pattern for this file
1489
1547
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1543,7 +1601,7 @@ module Vips
1543
1601
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1544
1602
 
1545
1603
  # @!method self.magickload(filename, **opts)
1546
- # Load file with imagemagick.
1604
+ # Load file with imagemagick7.
1547
1605
  # @param filename [String] Filename to load from
1548
1606
  # @param opts [Hash] Set of options
1549
1607
  # @option opts [String] :density Canvas resolution for rendering vector formats like SVG
@@ -1557,7 +1615,7 @@ module Vips
1557
1615
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1558
1616
 
1559
1617
  # @!method self.magickload_buffer(buffer, **opts)
1560
- # Load buffer with imagemagick.
1618
+ # Load buffer with imagemagick7.
1561
1619
  # @param buffer [VipsBlob] Buffer to load from
1562
1620
  # @param opts [Hash] Set of options
1563
1621
  # @option opts [String] :density Canvas resolution for rendering vector formats like SVG
@@ -1574,91 +1632,100 @@ module Vips
1574
1632
  # Save image to csv.
1575
1633
  # @param filename [String] Filename to save to
1576
1634
  # @param opts [Hash] Set of options
1577
- # @option opts [String] :profile Filename of ICC profile to embed
1578
1635
  # @option opts [String] :separator Separator characters
1579
1636
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1580
1637
  # @option opts [Array<Double>] :background Background value
1581
1638
  # @option opts [Integer] :page_height Set page height for multipage save
1639
+ # @option opts [String] :profile Filename of ICC profile to embed
1582
1640
  # @return [nil]
1583
1641
 
1584
1642
  # @!method csvsave_target(target, **opts)
1585
1643
  # Save image to csv.
1586
1644
  # @param target [Vips::Target] Target to save to
1587
1645
  # @param opts [Hash] Set of options
1588
- # @option opts [String] :profile Filename of ICC profile to embed
1589
1646
  # @option opts [String] :separator Separator characters
1590
1647
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1591
1648
  # @option opts [Array<Double>] :background Background value
1592
1649
  # @option opts [Integer] :page_height Set page height for multipage save
1650
+ # @option opts [String] :profile Filename of ICC profile to embed
1593
1651
  # @return [nil]
1594
1652
 
1595
1653
  # @!method matrixsave(filename, **opts)
1596
1654
  # Save image to matrix.
1597
1655
  # @param filename [String] Filename to save to
1598
1656
  # @param opts [Hash] Set of options
1599
- # @option opts [String] :profile Filename of ICC profile to embed
1600
1657
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1601
1658
  # @option opts [Array<Double>] :background Background value
1602
1659
  # @option opts [Integer] :page_height Set page height for multipage save
1660
+ # @option opts [String] :profile Filename of ICC profile to embed
1603
1661
  # @return [nil]
1604
1662
 
1605
1663
  # @!method matrixsave_target(target, **opts)
1606
1664
  # Save image to matrix.
1607
1665
  # @param target [Vips::Target] Target to save to
1608
1666
  # @param opts [Hash] Set of options
1609
- # @option opts [String] :profile Filename of ICC profile to embed
1610
1667
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1611
1668
  # @option opts [Array<Double>] :background Background value
1612
1669
  # @option opts [Integer] :page_height Set page height for multipage save
1670
+ # @option opts [String] :profile Filename of ICC profile to embed
1613
1671
  # @return [nil]
1614
1672
 
1615
1673
  # @!method matrixprint(**opts)
1616
1674
  # Print matrix.
1617
1675
  # @param opts [Hash] Set of options
1618
- # @option opts [String] :profile Filename of ICC profile to embed
1619
1676
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1620
1677
  # @option opts [Array<Double>] :background Background value
1621
1678
  # @option opts [Integer] :page_height Set page height for multipage save
1679
+ # @option opts [String] :profile Filename of ICC profile to embed
1622
1680
  # @return [nil]
1623
1681
 
1624
1682
  # @!method rawsave(filename, **opts)
1625
1683
  # Save image to raw file.
1626
1684
  # @param filename [String] Filename to save to
1627
1685
  # @param opts [Hash] Set of options
1628
- # @option opts [String] :profile Filename of ICC profile to embed
1629
1686
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1630
1687
  # @option opts [Array<Double>] :background Background value
1631
1688
  # @option opts [Integer] :page_height Set page height for multipage save
1689
+ # @option opts [String] :profile Filename of ICC profile to embed
1632
1690
  # @return [nil]
1633
1691
 
1634
- # @!method rawsave_fd(fd, **opts)
1635
- # Write raw image to file descriptor.
1636
- # @param fd [Integer] File descriptor to write to
1692
+ # @!method rawsave_buffer(**opts)
1693
+ # Write raw image to buffer.
1637
1694
  # @param opts [Hash] Set of options
1695
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1696
+ # @option opts [Array<Double>] :background Background value
1697
+ # @option opts [Integer] :page_height Set page height for multipage save
1638
1698
  # @option opts [String] :profile Filename of ICC profile to embed
1699
+ # @return [VipsBlob] Buffer to save to
1700
+
1701
+ # @!method rawsave_target(target, **opts)
1702
+ # Write raw image to target.
1703
+ # @param target [Vips::Target] Target to save to
1704
+ # @param opts [Hash] Set of options
1639
1705
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1640
1706
  # @option opts [Array<Double>] :background Background value
1641
1707
  # @option opts [Integer] :page_height Set page height for multipage save
1708
+ # @option opts [String] :profile Filename of ICC profile to embed
1642
1709
  # @return [nil]
1643
1710
 
1644
1711
  # @!method vipssave(filename, **opts)
1645
1712
  # Save image to file in vips format.
1646
1713
  # @param filename [String] Filename to save to
1647
1714
  # @param opts [Hash] Set of options
1648
- # @option opts [String] :profile Filename of ICC profile to embed
1649
1715
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1650
1716
  # @option opts [Array<Double>] :background Background value
1651
1717
  # @option opts [Integer] :page_height Set page height for multipage save
1718
+ # @option opts [String] :profile Filename of ICC profile to embed
1652
1719
  # @return [nil]
1653
1720
 
1654
1721
  # @!method vipssave_target(target, **opts)
1655
1722
  # Save image to target in vips format.
1656
1723
  # @param target [Vips::Target] Target to save to
1657
1724
  # @param opts [Hash] Set of options
1658
- # @option opts [String] :profile Filename of ICC profile to embed
1659
1725
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1660
1726
  # @option opts [Array<Double>] :background Background value
1661
1727
  # @option opts [Integer] :page_height Set page height for multipage save
1728
+ # @option opts [String] :profile Filename of ICC profile to embed
1662
1729
  # @return [nil]
1663
1730
 
1664
1731
  # @!method ppmsave(filename, **opts)
@@ -1667,11 +1734,11 @@ module Vips
1667
1734
  # @param opts [Hash] Set of options
1668
1735
  # @option opts [Vips::ForeignPpmFormat] :format Format to save in
1669
1736
  # @option opts [Boolean] :ascii Save as ascii
1670
- # @option opts [String] :profile Filename of ICC profile to embed
1671
1737
  # @option opts [Integer] :bitdepth Set to 1 to write as a 1 bit image
1672
1738
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1673
1739
  # @option opts [Array<Double>] :background Background value
1674
1740
  # @option opts [Integer] :page_height Set page height for multipage save
1741
+ # @option opts [String] :profile Filename of ICC profile to embed
1675
1742
  # @return [nil]
1676
1743
 
1677
1744
  # @!method ppmsave_target(target, **opts)
@@ -1680,48 +1747,47 @@ module Vips
1680
1747
  # @param opts [Hash] Set of options
1681
1748
  # @option opts [Vips::ForeignPpmFormat] :format Format to save in
1682
1749
  # @option opts [Boolean] :ascii Save as ascii
1683
- # @option opts [String] :profile Filename of ICC profile to embed
1684
1750
  # @option opts [Integer] :bitdepth Set to 1 to write as a 1 bit image
1685
1751
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1686
1752
  # @option opts [Array<Double>] :background Background value
1687
1753
  # @option opts [Integer] :page_height Set page height for multipage save
1754
+ # @option opts [String] :profile Filename of ICC profile to embed
1688
1755
  # @return [nil]
1689
1756
 
1690
1757
  # @!method radsave(filename, **opts)
1691
1758
  # Save image to radiance file.
1692
1759
  # @param filename [String] Filename to save to
1693
1760
  # @param opts [Hash] Set of options
1694
- # @option opts [String] :profile Filename of ICC profile to embed
1695
1761
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1696
1762
  # @option opts [Array<Double>] :background Background value
1697
1763
  # @option opts [Integer] :page_height Set page height for multipage save
1764
+ # @option opts [String] :profile Filename of ICC profile to embed
1698
1765
  # @return [nil]
1699
1766
 
1700
1767
  # @!method radsave_buffer(**opts)
1701
1768
  # Save image to radiance buffer.
1702
1769
  # @param opts [Hash] Set of options
1703
- # @option opts [String] :profile Filename of ICC profile to embed
1704
1770
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1705
1771
  # @option opts [Array<Double>] :background Background value
1706
1772
  # @option opts [Integer] :page_height Set page height for multipage save
1773
+ # @option opts [String] :profile Filename of ICC profile to embed
1707
1774
  # @return [VipsBlob] Buffer to save to
1708
1775
 
1709
1776
  # @!method radsave_target(target, **opts)
1710
1777
  # Save image to radiance target.
1711
1778
  # @param target [Vips::Target] Target to save to
1712
1779
  # @param opts [Hash] Set of options
1713
- # @option opts [String] :profile Filename of ICC profile to embed
1714
1780
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1715
1781
  # @option opts [Array<Double>] :background Background value
1716
1782
  # @option opts [Integer] :page_height Set page height for multipage save
1783
+ # @option opts [String] :profile Filename of ICC profile to embed
1717
1784
  # @return [nil]
1718
1785
 
1719
1786
  # @!method jp2ksave(filename, **opts)
1720
1787
  # Save image in jpeg2000 format.
1721
- # @param filename [String] Filename to load from
1788
+ # @param filename [String] Filename to save to
1722
1789
  # @param opts [Hash] Set of options
1723
1790
  # @option opts [Integer] :tile_width Tile width in pixels
1724
- # @option opts [String] :profile Filename of ICC profile to embed
1725
1791
  # @option opts [Integer] :tile_height Tile height in pixels
1726
1792
  # @option opts [Boolean] :lossless Enable lossless compression
1727
1793
  # @option opts [Integer] :Q Q factor
@@ -1729,13 +1795,13 @@ module Vips
1729
1795
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1730
1796
  # @option opts [Array<Double>] :background Background value
1731
1797
  # @option opts [Integer] :page_height Set page height for multipage save
1798
+ # @option opts [String] :profile Filename of ICC profile to embed
1732
1799
  # @return [nil]
1733
1800
 
1734
1801
  # @!method jp2ksave_buffer(**opts)
1735
1802
  # Save image in jpeg2000 format.
1736
1803
  # @param opts [Hash] Set of options
1737
1804
  # @option opts [Integer] :tile_width Tile width in pixels
1738
- # @option opts [String] :profile Filename of ICC profile to embed
1739
1805
  # @option opts [Integer] :tile_height Tile height in pixels
1740
1806
  # @option opts [Boolean] :lossless Enable lossless compression
1741
1807
  # @option opts [Integer] :Q Q factor
@@ -1743,6 +1809,7 @@ module Vips
1743
1809
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1744
1810
  # @option opts [Array<Double>] :background Background value
1745
1811
  # @option opts [Integer] :page_height Set page height for multipage save
1812
+ # @option opts [String] :profile Filename of ICC profile to embed
1746
1813
  # @return [VipsBlob] Buffer to save to
1747
1814
 
1748
1815
  # @!method jp2ksave_target(target, **opts)
@@ -1750,7 +1817,6 @@ module Vips
1750
1817
  # @param target [Vips::Target] Target to save to
1751
1818
  # @param opts [Hash] Set of options
1752
1819
  # @option opts [Integer] :tile_width Tile width in pixels
1753
- # @option opts [String] :profile Filename of ICC profile to embed
1754
1820
  # @option opts [Integer] :tile_height Tile height in pixels
1755
1821
  # @option opts [Boolean] :lossless Enable lossless compression
1756
1822
  # @option opts [Integer] :Q Q factor
@@ -1758,6 +1824,7 @@ module Vips
1758
1824
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1759
1825
  # @option opts [Array<Double>] :background Background value
1760
1826
  # @option opts [Integer] :page_height Set page height for multipage save
1827
+ # @option opts [String] :profile Filename of ICC profile to embed
1761
1828
  # @return [nil]
1762
1829
 
1763
1830
  # @!method gifsave(filename, **opts)
@@ -1766,15 +1833,16 @@ module Vips
1766
1833
  # @param opts [Hash] Set of options
1767
1834
  # @option opts [Float] :dither Amount of dithering
1768
1835
  # @option opts [Integer] :effort Quantisation effort
1769
- # @option opts [String] :profile Filename of ICC profile to embed
1770
1836
  # @option opts [Integer] :bitdepth Number of bits per pixel
1771
1837
  # @option opts [Float] :interframe_maxerror Maximum inter-frame error for transparency
1772
1838
  # @option opts [Boolean] :reuse Reuse palette from input
1773
1839
  # @option opts [Float] :interpalette_maxerror Maximum inter-palette error for palette reusage
1774
1840
  # @option opts [Boolean] :interlace Generate an interlaced (progressive) GIF
1841
+ # @option opts [Boolean] :keep_duplicate_frames Keep duplicate frames in the output instead of combining them
1775
1842
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1776
1843
  # @option opts [Array<Double>] :background Background value
1777
1844
  # @option opts [Integer] :page_height Set page height for multipage save
1845
+ # @option opts [String] :profile Filename of ICC profile to embed
1778
1846
  # @return [nil]
1779
1847
 
1780
1848
  # @!method gifsave_buffer(**opts)
@@ -1782,15 +1850,16 @@ module Vips
1782
1850
  # @param opts [Hash] Set of options
1783
1851
  # @option opts [Float] :dither Amount of dithering
1784
1852
  # @option opts [Integer] :effort Quantisation effort
1785
- # @option opts [String] :profile Filename of ICC profile to embed
1786
1853
  # @option opts [Integer] :bitdepth Number of bits per pixel
1787
1854
  # @option opts [Float] :interframe_maxerror Maximum inter-frame error for transparency
1788
1855
  # @option opts [Boolean] :reuse Reuse palette from input
1789
1856
  # @option opts [Float] :interpalette_maxerror Maximum inter-palette error for palette reusage
1790
1857
  # @option opts [Boolean] :interlace Generate an interlaced (progressive) GIF
1858
+ # @option opts [Boolean] :keep_duplicate_frames Keep duplicate frames in the output instead of combining them
1791
1859
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1792
1860
  # @option opts [Array<Double>] :background Background value
1793
1861
  # @option opts [Integer] :page_height Set page height for multipage save
1862
+ # @option opts [String] :profile Filename of ICC profile to embed
1794
1863
  # @return [VipsBlob] Buffer to save to
1795
1864
 
1796
1865
  # @!method gifsave_target(target, **opts)
@@ -1799,15 +1868,16 @@ module Vips
1799
1868
  # @param opts [Hash] Set of options
1800
1869
  # @option opts [Float] :dither Amount of dithering
1801
1870
  # @option opts [Integer] :effort Quantisation effort
1802
- # @option opts [String] :profile Filename of ICC profile to embed
1803
1871
  # @option opts [Integer] :bitdepth Number of bits per pixel
1804
1872
  # @option opts [Float] :interframe_maxerror Maximum inter-frame error for transparency
1805
1873
  # @option opts [Boolean] :reuse Reuse palette from input
1806
1874
  # @option opts [Float] :interpalette_maxerror Maximum inter-palette error for palette reusage
1807
1875
  # @option opts [Boolean] :interlace Generate an interlaced (progressive) GIF
1876
+ # @option opts [Boolean] :keep_duplicate_frames Keep duplicate frames in the output instead of combining them
1808
1877
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1809
1878
  # @option opts [Array<Double>] :background Background value
1810
1879
  # @option opts [Integer] :page_height Set page height for multipage save
1880
+ # @option opts [String] :profile Filename of ICC profile to embed
1811
1881
  # @return [nil]
1812
1882
 
1813
1883
  # @!method dzsave(filename, **opts)
@@ -1819,7 +1889,6 @@ module Vips
1819
1889
  # @option opts [String] :suffix Filename suffix for tiles
1820
1890
  # @option opts [Integer] :overlap Tile overlap in pixels
1821
1891
  # @option opts [Integer] :tile_size Tile size in pixels
1822
- # @option opts [String] :profile Filename of ICC profile to embed
1823
1892
  # @option opts [Boolean] :centre Center image in tile
1824
1893
  # @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
1825
1894
  # @option opts [Vips::Angle] :angle Rotate image during save
@@ -1832,6 +1901,7 @@ module Vips
1832
1901
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1833
1902
  # @option opts [Array<Double>] :background Background value
1834
1903
  # @option opts [Integer] :page_height Set page height for multipage save
1904
+ # @option opts [String] :profile Filename of ICC profile to embed
1835
1905
  # @return [nil]
1836
1906
 
1837
1907
  # @!method dzsave_buffer(**opts)
@@ -1842,7 +1912,6 @@ module Vips
1842
1912
  # @option opts [String] :suffix Filename suffix for tiles
1843
1913
  # @option opts [Integer] :overlap Tile overlap in pixels
1844
1914
  # @option opts [Integer] :tile_size Tile size in pixels
1845
- # @option opts [String] :profile Filename of ICC profile to embed
1846
1915
  # @option opts [Boolean] :centre Center image in tile
1847
1916
  # @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
1848
1917
  # @option opts [Vips::Angle] :angle Rotate image during save
@@ -1855,6 +1924,7 @@ module Vips
1855
1924
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1856
1925
  # @option opts [Array<Double>] :background Background value
1857
1926
  # @option opts [Integer] :page_height Set page height for multipage save
1927
+ # @option opts [String] :profile Filename of ICC profile to embed
1858
1928
  # @return [VipsBlob] Buffer to save to
1859
1929
 
1860
1930
  # @!method dzsave_target(target, **opts)
@@ -1866,7 +1936,6 @@ module Vips
1866
1936
  # @option opts [String] :suffix Filename suffix for tiles
1867
1937
  # @option opts [Integer] :overlap Tile overlap in pixels
1868
1938
  # @option opts [Integer] :tile_size Tile size in pixels
1869
- # @option opts [String] :profile Filename of ICC profile to embed
1870
1939
  # @option opts [Boolean] :centre Center image in tile
1871
1940
  # @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
1872
1941
  # @option opts [Vips::Angle] :angle Rotate image during save
@@ -1879,16 +1948,16 @@ module Vips
1879
1948
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1880
1949
  # @option opts [Array<Double>] :background Background value
1881
1950
  # @option opts [Integer] :page_height Set page height for multipage save
1951
+ # @option opts [String] :profile Filename of ICC profile to embed
1882
1952
  # @return [nil]
1883
1953
 
1884
1954
  # @!method pngsave(filename, **opts)
1885
- # Save image to png file.
1955
+ # Save image to file as png.
1886
1956
  # @param filename [String] Filename to save to
1887
1957
  # @param opts [Hash] Set of options
1888
1958
  # @option opts [Integer] :compression Compression factor
1889
1959
  # @option opts [Boolean] :interlace Interlace image
1890
- # @option opts [String] :profile Filename of ICC profile to embed
1891
- # @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
1960
+ # @option opts [Vips::ForeignPngFilter] :filter libspng row filter flag(s)
1892
1961
  # @option opts [Boolean] :palette Quantise to 8bpp palette
1893
1962
  # @option opts [Integer] :Q Quantisation quality
1894
1963
  # @option opts [Float] :dither Amount of dithering
@@ -1897,15 +1966,15 @@ module Vips
1897
1966
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1898
1967
  # @option opts [Array<Double>] :background Background value
1899
1968
  # @option opts [Integer] :page_height Set page height for multipage save
1969
+ # @option opts [String] :profile Filename of ICC profile to embed
1900
1970
  # @return [nil]
1901
1971
 
1902
1972
  # @!method pngsave_buffer(**opts)
1903
- # Save image to png buffer.
1973
+ # Save image to buffer as png.
1904
1974
  # @param opts [Hash] Set of options
1905
1975
  # @option opts [Integer] :compression Compression factor
1906
1976
  # @option opts [Boolean] :interlace Interlace image
1907
- # @option opts [String] :profile Filename of ICC profile to embed
1908
- # @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
1977
+ # @option opts [Vips::ForeignPngFilter] :filter libspng row filter flag(s)
1909
1978
  # @option opts [Boolean] :palette Quantise to 8bpp palette
1910
1979
  # @option opts [Integer] :Q Quantisation quality
1911
1980
  # @option opts [Float] :dither Amount of dithering
@@ -1914,6 +1983,7 @@ module Vips
1914
1983
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1915
1984
  # @option opts [Array<Double>] :background Background value
1916
1985
  # @option opts [Integer] :page_height Set page height for multipage save
1986
+ # @option opts [String] :profile Filename of ICC profile to embed
1917
1987
  # @return [VipsBlob] Buffer to save to
1918
1988
 
1919
1989
  # @!method pngsave_target(target, **opts)
@@ -1922,8 +1992,7 @@ module Vips
1922
1992
  # @param opts [Hash] Set of options
1923
1993
  # @option opts [Integer] :compression Compression factor
1924
1994
  # @option opts [Boolean] :interlace Interlace image
1925
- # @option opts [String] :profile Filename of ICC profile to embed
1926
- # @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
1995
+ # @option opts [Vips::ForeignPngFilter] :filter libspng row filter flag(s)
1927
1996
  # @option opts [Boolean] :palette Quantise to 8bpp palette
1928
1997
  # @option opts [Integer] :Q Quantisation quality
1929
1998
  # @option opts [Float] :dither Amount of dithering
@@ -1932,6 +2001,7 @@ module Vips
1932
2001
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1933
2002
  # @option opts [Array<Double>] :background Background value
1934
2003
  # @option opts [Integer] :page_height Set page height for multipage save
2004
+ # @option opts [String] :profile Filename of ICC profile to embed
1935
2005
  # @return [nil]
1936
2006
 
1937
2007
  # @!method jpegsave(filename, **opts)
@@ -1939,7 +2009,6 @@ module Vips
1939
2009
  # @param filename [String] Filename to save to
1940
2010
  # @param opts [Hash] Set of options
1941
2011
  # @option opts [Integer] :Q Q factor
1942
- # @option opts [String] :profile Filename of ICC profile to embed
1943
2012
  # @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
1944
2013
  # @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
1945
2014
  # @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
@@ -1951,13 +2020,13 @@ module Vips
1951
2020
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1952
2021
  # @option opts [Array<Double>] :background Background value
1953
2022
  # @option opts [Integer] :page_height Set page height for multipage save
2023
+ # @option opts [String] :profile Filename of ICC profile to embed
1954
2024
  # @return [nil]
1955
2025
 
1956
2026
  # @!method jpegsave_buffer(**opts)
1957
2027
  # Save image to jpeg buffer.
1958
2028
  # @param opts [Hash] Set of options
1959
2029
  # @option opts [Integer] :Q Q factor
1960
- # @option opts [String] :profile Filename of ICC profile to embed
1961
2030
  # @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
1962
2031
  # @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
1963
2032
  # @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
@@ -1969,6 +2038,7 @@ module Vips
1969
2038
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1970
2039
  # @option opts [Array<Double>] :background Background value
1971
2040
  # @option opts [Integer] :page_height Set page height for multipage save
2041
+ # @option opts [String] :profile Filename of ICC profile to embed
1972
2042
  # @return [VipsBlob] Buffer to save to
1973
2043
 
1974
2044
  # @!method jpegsave_target(target, **opts)
@@ -1976,7 +2046,6 @@ module Vips
1976
2046
  # @param target [Vips::Target] Target to save to
1977
2047
  # @param opts [Hash] Set of options
1978
2048
  # @option opts [Integer] :Q Q factor
1979
- # @option opts [String] :profile Filename of ICC profile to embed
1980
2049
  # @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
1981
2050
  # @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
1982
2051
  # @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
@@ -1988,13 +2057,13 @@ module Vips
1988
2057
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1989
2058
  # @option opts [Array<Double>] :background Background value
1990
2059
  # @option opts [Integer] :page_height Set page height for multipage save
2060
+ # @option opts [String] :profile Filename of ICC profile to embed
1991
2061
  # @return [nil]
1992
2062
 
1993
2063
  # @!method jpegsave_mime(**opts)
1994
2064
  # Save image to jpeg mime.
1995
2065
  # @param opts [Hash] Set of options
1996
2066
  # @option opts [Integer] :Q Q factor
1997
- # @option opts [String] :profile Filename of ICC profile to embed
1998
2067
  # @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
1999
2068
  # @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
2000
2069
  # @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
@@ -2006,6 +2075,7 @@ module Vips
2006
2075
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2007
2076
  # @option opts [Array<Double>] :background Background value
2008
2077
  # @option opts [Integer] :page_height Set page height for multipage save
2078
+ # @option opts [String] :profile Filename of ICC profile to embed
2009
2079
  # @return [nil]
2010
2080
 
2011
2081
  # @!method webpsave(filename, **opts)
@@ -2014,7 +2084,6 @@ module Vips
2014
2084
  # @param opts [Hash] Set of options
2015
2085
  # @option opts [Integer] :Q Q factor
2016
2086
  # @option opts [Boolean] :lossless Enable lossless compression
2017
- # @option opts [String] :profile Filename of ICC profile to embed
2018
2087
  # @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
2019
2088
  # @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
2020
2089
  # @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
@@ -2023,10 +2092,14 @@ module Vips
2023
2092
  # @option opts [Integer] :kmin Minimum number of frames between key frames
2024
2093
  # @option opts [Integer] :kmax Maximum number of frames between key frames
2025
2094
  # @option opts [Integer] :effort Level of CPU effort to reduce file size
2095
+ # @option opts [Integer] :target_size Desired target size in bytes
2026
2096
  # @option opts [Boolean] :mixed Allow mixed encoding (might reduce file size)
2097
+ # @option opts [Boolean] :smart_deblock Enable auto-adjusting of the deblocking filter
2098
+ # @option opts [Integer] :passes Number of entropy-analysis passes (in [1..10])
2027
2099
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2028
2100
  # @option opts [Array<Double>] :background Background value
2029
2101
  # @option opts [Integer] :page_height Set page height for multipage save
2102
+ # @option opts [String] :profile Filename of ICC profile to embed
2030
2103
  # @return [nil]
2031
2104
 
2032
2105
  # @!method webpsave_buffer(**opts)
@@ -2034,7 +2107,6 @@ module Vips
2034
2107
  # @param opts [Hash] Set of options
2035
2108
  # @option opts [Integer] :Q Q factor
2036
2109
  # @option opts [Boolean] :lossless Enable lossless compression
2037
- # @option opts [String] :profile Filename of ICC profile to embed
2038
2110
  # @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
2039
2111
  # @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
2040
2112
  # @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
@@ -2043,10 +2115,14 @@ module Vips
2043
2115
  # @option opts [Integer] :kmin Minimum number of frames between key frames
2044
2116
  # @option opts [Integer] :kmax Maximum number of frames between key frames
2045
2117
  # @option opts [Integer] :effort Level of CPU effort to reduce file size
2118
+ # @option opts [Integer] :target_size Desired target size in bytes
2046
2119
  # @option opts [Boolean] :mixed Allow mixed encoding (might reduce file size)
2120
+ # @option opts [Boolean] :smart_deblock Enable auto-adjusting of the deblocking filter
2121
+ # @option opts [Integer] :passes Number of entropy-analysis passes (in [1..10])
2047
2122
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2048
2123
  # @option opts [Array<Double>] :background Background value
2049
2124
  # @option opts [Integer] :page_height Set page height for multipage save
2125
+ # @option opts [String] :profile Filename of ICC profile to embed
2050
2126
  # @return [VipsBlob] Buffer to save to
2051
2127
 
2052
2128
  # @!method webpsave_target(target, **opts)
@@ -2055,7 +2131,6 @@ module Vips
2055
2131
  # @param opts [Hash] Set of options
2056
2132
  # @option opts [Integer] :Q Q factor
2057
2133
  # @option opts [Boolean] :lossless Enable lossless compression
2058
- # @option opts [String] :profile Filename of ICC profile to embed
2059
2134
  # @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
2060
2135
  # @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
2061
2136
  # @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
@@ -2064,10 +2139,14 @@ module Vips
2064
2139
  # @option opts [Integer] :kmin Minimum number of frames between key frames
2065
2140
  # @option opts [Integer] :kmax Maximum number of frames between key frames
2066
2141
  # @option opts [Integer] :effort Level of CPU effort to reduce file size
2142
+ # @option opts [Integer] :target_size Desired target size in bytes
2067
2143
  # @option opts [Boolean] :mixed Allow mixed encoding (might reduce file size)
2144
+ # @option opts [Boolean] :smart_deblock Enable auto-adjusting of the deblocking filter
2145
+ # @option opts [Integer] :passes Number of entropy-analysis passes (in [1..10])
2068
2146
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2069
2147
  # @option opts [Array<Double>] :background Background value
2070
2148
  # @option opts [Integer] :page_height Set page height for multipage save
2149
+ # @option opts [String] :profile Filename of ICC profile to embed
2071
2150
  # @return [nil]
2072
2151
 
2073
2152
  # @!method webpsave_mime(**opts)
@@ -2075,7 +2154,6 @@ module Vips
2075
2154
  # @param opts [Hash] Set of options
2076
2155
  # @option opts [Integer] :Q Q factor
2077
2156
  # @option opts [Boolean] :lossless Enable lossless compression
2078
- # @option opts [String] :profile Filename of ICC profile to embed
2079
2157
  # @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
2080
2158
  # @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
2081
2159
  # @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
@@ -2084,10 +2162,14 @@ module Vips
2084
2162
  # @option opts [Integer] :kmin Minimum number of frames between key frames
2085
2163
  # @option opts [Integer] :kmax Maximum number of frames between key frames
2086
2164
  # @option opts [Integer] :effort Level of CPU effort to reduce file size
2165
+ # @option opts [Integer] :target_size Desired target size in bytes
2087
2166
  # @option opts [Boolean] :mixed Allow mixed encoding (might reduce file size)
2167
+ # @option opts [Boolean] :smart_deblock Enable auto-adjusting of the deblocking filter
2168
+ # @option opts [Integer] :passes Number of entropy-analysis passes (in [1..10])
2088
2169
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2089
2170
  # @option opts [Array<Double>] :background Background value
2090
2171
  # @option opts [Integer] :page_height Set page height for multipage save
2172
+ # @option opts [String] :profile Filename of ICC profile to embed
2091
2173
  # @return [nil]
2092
2174
 
2093
2175
  # @!method tiffsave(filename, **opts)
@@ -2099,7 +2181,6 @@ module Vips
2099
2181
  # @option opts [Vips::ForeignTiffPredictor] :predictor Compression prediction
2100
2182
  # @option opts [Boolean] :tile Write a tiled tiff
2101
2183
  # @option opts [Integer] :tile_width Tile width in pixels
2102
- # @option opts [String] :profile Filename of ICC profile to embed
2103
2184
  # @option opts [Integer] :tile_height Tile height in pixels
2104
2185
  # @option opts [Boolean] :pyramid Write a pyramidal tiff
2105
2186
  # @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
@@ -2110,7 +2191,7 @@ module Vips
2110
2191
  # @option opts [Boolean] :bigtiff Write a bigtiff image
2111
2192
  # @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
2112
2193
  # @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
2113
- # @option opts [Integer] :level ZSTD compression level
2194
+ # @option opts [Integer] :level Deflate (1-9, default 6) or ZSTD (1-22, default 9) compression level
2114
2195
  # @option opts [Boolean] :lossless Enable WEBP lossless mode
2115
2196
  # @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
2116
2197
  # @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
@@ -2118,6 +2199,7 @@ module Vips
2118
2199
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2119
2200
  # @option opts [Array<Double>] :background Background value
2120
2201
  # @option opts [Integer] :page_height Set page height for multipage save
2202
+ # @option opts [String] :profile Filename of ICC profile to embed
2121
2203
  # @return [nil]
2122
2204
 
2123
2205
  # @!method tiffsave_buffer(**opts)
@@ -2128,7 +2210,6 @@ module Vips
2128
2210
  # @option opts [Vips::ForeignTiffPredictor] :predictor Compression prediction
2129
2211
  # @option opts [Boolean] :tile Write a tiled tiff
2130
2212
  # @option opts [Integer] :tile_width Tile width in pixels
2131
- # @option opts [String] :profile Filename of ICC profile to embed
2132
2213
  # @option opts [Integer] :tile_height Tile height in pixels
2133
2214
  # @option opts [Boolean] :pyramid Write a pyramidal tiff
2134
2215
  # @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
@@ -2139,7 +2220,7 @@ module Vips
2139
2220
  # @option opts [Boolean] :bigtiff Write a bigtiff image
2140
2221
  # @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
2141
2222
  # @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
2142
- # @option opts [Integer] :level ZSTD compression level
2223
+ # @option opts [Integer] :level Deflate (1-9, default 6) or ZSTD (1-22, default 9) compression level
2143
2224
  # @option opts [Boolean] :lossless Enable WEBP lossless mode
2144
2225
  # @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
2145
2226
  # @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
@@ -2147,6 +2228,7 @@ module Vips
2147
2228
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2148
2229
  # @option opts [Array<Double>] :background Background value
2149
2230
  # @option opts [Integer] :page_height Set page height for multipage save
2231
+ # @option opts [String] :profile Filename of ICC profile to embed
2150
2232
  # @return [VipsBlob] Buffer to save to
2151
2233
 
2152
2234
  # @!method tiffsave_target(target, **opts)
@@ -2158,7 +2240,6 @@ module Vips
2158
2240
  # @option opts [Vips::ForeignTiffPredictor] :predictor Compression prediction
2159
2241
  # @option opts [Boolean] :tile Write a tiled tiff
2160
2242
  # @option opts [Integer] :tile_width Tile width in pixels
2161
- # @option opts [String] :profile Filename of ICC profile to embed
2162
2243
  # @option opts [Integer] :tile_height Tile height in pixels
2163
2244
  # @option opts [Boolean] :pyramid Write a pyramidal tiff
2164
2245
  # @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
@@ -2169,7 +2250,7 @@ module Vips
2169
2250
  # @option opts [Boolean] :bigtiff Write a bigtiff image
2170
2251
  # @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
2171
2252
  # @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
2172
- # @option opts [Integer] :level ZSTD compression level
2253
+ # @option opts [Integer] :level Deflate (1-9, default 6) or ZSTD (1-22, default 9) compression level
2173
2254
  # @option opts [Boolean] :lossless Enable WEBP lossless mode
2174
2255
  # @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
2175
2256
  # @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
@@ -2177,26 +2258,27 @@ module Vips
2177
2258
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2178
2259
  # @option opts [Array<Double>] :background Background value
2179
2260
  # @option opts [Integer] :page_height Set page height for multipage save
2261
+ # @option opts [String] :profile Filename of ICC profile to embed
2180
2262
  # @return [nil]
2181
2263
 
2182
2264
  # @!method fitssave(filename, **opts)
2183
2265
  # Save image to fits file.
2184
2266
  # @param filename [String] Filename to save to
2185
2267
  # @param opts [Hash] Set of options
2186
- # @option opts [String] :profile Filename of ICC profile to embed
2187
2268
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2188
2269
  # @option opts [Array<Double>] :background Background value
2189
2270
  # @option opts [Integer] :page_height Set page height for multipage save
2271
+ # @option opts [String] :profile Filename of ICC profile to embed
2190
2272
  # @return [nil]
2191
2273
 
2192
2274
  # @!method niftisave(filename, **opts)
2193
2275
  # Save image to nifti file.
2194
2276
  # @param filename [String] Filename to save to
2195
2277
  # @param opts [Hash] Set of options
2196
- # @option opts [String] :profile Filename of ICC profile to embed
2197
2278
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2198
2279
  # @option opts [Array<Double>] :background Background value
2199
2280
  # @option opts [Integer] :page_height Set page height for multipage save
2281
+ # @option opts [String] :profile Filename of ICC profile to embed
2200
2282
  # @return [nil]
2201
2283
 
2202
2284
  # @!method heifsave(filename, **opts)
@@ -2205,7 +2287,6 @@ module Vips
2205
2287
  # @param opts [Hash] Set of options
2206
2288
  # @option opts [Integer] :Q Q factor
2207
2289
  # @option opts [Integer] :bitdepth Number of bits per pixel
2208
- # @option opts [String] :profile Filename of ICC profile to embed
2209
2290
  # @option opts [Boolean] :lossless Enable lossless compression
2210
2291
  # @option opts [Vips::ForeignHeifCompression] :compression Compression format
2211
2292
  # @option opts [Integer] :effort CPU effort
@@ -2214,6 +2295,7 @@ module Vips
2214
2295
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2215
2296
  # @option opts [Array<Double>] :background Background value
2216
2297
  # @option opts [Integer] :page_height Set page height for multipage save
2298
+ # @option opts [String] :profile Filename of ICC profile to embed
2217
2299
  # @return [nil]
2218
2300
 
2219
2301
  # @!method heifsave_buffer(**opts)
@@ -2221,7 +2303,6 @@ module Vips
2221
2303
  # @param opts [Hash] Set of options
2222
2304
  # @option opts [Integer] :Q Q factor
2223
2305
  # @option opts [Integer] :bitdepth Number of bits per pixel
2224
- # @option opts [String] :profile Filename of ICC profile to embed
2225
2306
  # @option opts [Boolean] :lossless Enable lossless compression
2226
2307
  # @option opts [Vips::ForeignHeifCompression] :compression Compression format
2227
2308
  # @option opts [Integer] :effort CPU effort
@@ -2230,6 +2311,7 @@ module Vips
2230
2311
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2231
2312
  # @option opts [Array<Double>] :background Background value
2232
2313
  # @option opts [Integer] :page_height Set page height for multipage save
2314
+ # @option opts [String] :profile Filename of ICC profile to embed
2233
2315
  # @return [VipsBlob] Buffer to save to
2234
2316
 
2235
2317
  # @!method heifsave_target(target, **opts)
@@ -2238,7 +2320,6 @@ module Vips
2238
2320
  # @param opts [Hash] Set of options
2239
2321
  # @option opts [Integer] :Q Q factor
2240
2322
  # @option opts [Integer] :bitdepth Number of bits per pixel
2241
- # @option opts [String] :profile Filename of ICC profile to embed
2242
2323
  # @option opts [Boolean] :lossless Enable lossless compression
2243
2324
  # @option opts [Vips::ForeignHeifCompression] :compression Compression format
2244
2325
  # @option opts [Integer] :effort CPU effort
@@ -2247,21 +2328,22 @@ module Vips
2247
2328
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2248
2329
  # @option opts [Array<Double>] :background Background value
2249
2330
  # @option opts [Integer] :page_height Set page height for multipage save
2331
+ # @option opts [String] :profile Filename of ICC profile to embed
2250
2332
  # @return [nil]
2251
2333
 
2252
2334
  # @!method jxlsave(filename, **opts)
2253
2335
  # Save image in jpeg-xl format.
2254
- # @param filename [String] Filename to load from
2336
+ # @param filename [String] Filename to save to
2255
2337
  # @param opts [Hash] Set of options
2256
2338
  # @option opts [Integer] :tier Decode speed tier
2257
2339
  # @option opts [Float] :distance Target butteraugli distance
2258
- # @option opts [String] :profile Filename of ICC profile to embed
2259
2340
  # @option opts [Integer] :effort Encoding effort
2260
2341
  # @option opts [Boolean] :lossless Enable lossless compression
2261
2342
  # @option opts [Integer] :Q Quality factor
2262
2343
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2263
2344
  # @option opts [Array<Double>] :background Background value
2264
2345
  # @option opts [Integer] :page_height Set page height for multipage save
2346
+ # @option opts [String] :profile Filename of ICC profile to embed
2265
2347
  # @return [nil]
2266
2348
 
2267
2349
  # @!method jxlsave_buffer(**opts)
@@ -2269,13 +2351,13 @@ module Vips
2269
2351
  # @param opts [Hash] Set of options
2270
2352
  # @option opts [Integer] :tier Decode speed tier
2271
2353
  # @option opts [Float] :distance Target butteraugli distance
2272
- # @option opts [String] :profile Filename of ICC profile to embed
2273
2354
  # @option opts [Integer] :effort Encoding effort
2274
2355
  # @option opts [Boolean] :lossless Enable lossless compression
2275
2356
  # @option opts [Integer] :Q Quality factor
2276
2357
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2277
2358
  # @option opts [Array<Double>] :background Background value
2278
2359
  # @option opts [Integer] :page_height Set page height for multipage save
2360
+ # @option opts [String] :profile Filename of ICC profile to embed
2279
2361
  # @return [VipsBlob] Buffer to save to
2280
2362
 
2281
2363
  # @!method jxlsave_target(target, **opts)
@@ -2284,13 +2366,13 @@ module Vips
2284
2366
  # @param opts [Hash] Set of options
2285
2367
  # @option opts [Integer] :tier Decode speed tier
2286
2368
  # @option opts [Float] :distance Target butteraugli distance
2287
- # @option opts [String] :profile Filename of ICC profile to embed
2288
2369
  # @option opts [Integer] :effort Encoding effort
2289
2370
  # @option opts [Boolean] :lossless Enable lossless compression
2290
2371
  # @option opts [Integer] :Q Quality factor
2291
2372
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2292
2373
  # @option opts [Array<Double>] :background Background value
2293
2374
  # @option opts [Integer] :page_height Set page height for multipage save
2375
+ # @option opts [String] :profile Filename of ICC profile to embed
2294
2376
  # @return [nil]
2295
2377
 
2296
2378
  # @!method magicksave(filename, **opts)
@@ -2302,10 +2384,10 @@ module Vips
2302
2384
  # @option opts [Boolean] :optimize_gif_frames Apply GIF frames optimization
2303
2385
  # @option opts [Boolean] :optimize_gif_transparency Apply GIF transparency optimization
2304
2386
  # @option opts [Integer] :bitdepth Number of bits per pixel
2305
- # @option opts [String] :profile Filename of ICC profile to embed
2306
2387
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2307
2388
  # @option opts [Array<Double>] :background Background value
2308
2389
  # @option opts [Integer] :page_height Set page height for multipage save
2390
+ # @option opts [String] :profile Filename of ICC profile to embed
2309
2391
  # @return [nil]
2310
2392
 
2311
2393
  # @!method magicksave_buffer(**opts)
@@ -2316,10 +2398,10 @@ module Vips
2316
2398
  # @option opts [Boolean] :optimize_gif_frames Apply GIF frames optimization
2317
2399
  # @option opts [Boolean] :optimize_gif_transparency Apply GIF transparency optimization
2318
2400
  # @option opts [Integer] :bitdepth Number of bits per pixel
2319
- # @option opts [String] :profile Filename of ICC profile to embed
2320
2401
  # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2321
2402
  # @option opts [Array<Double>] :background Background value
2322
2403
  # @option opts [Integer] :page_height Set page height for multipage save
2404
+ # @option opts [String] :profile Filename of ICC profile to embed
2323
2405
  # @return [VipsBlob] Buffer to save to
2324
2406
 
2325
2407
  # @!method self.thumbnail(filename, width, **opts)
@@ -2332,8 +2414,8 @@ module Vips
2332
2414
  # @option opts [Boolean] :no_rotate Don't use orientation tags to rotate image upright
2333
2415
  # @option opts [Vips::Interesting] :crop Reduce to fill target rectangle, then crop
2334
2416
  # @option opts [Boolean] :linear Reduce in linear light
2335
- # @option opts [String] :import_profile Fallback import profile
2336
- # @option opts [String] :export_profile Fallback export profile
2417
+ # @option opts [String] :input_profile Fallback input profile
2418
+ # @option opts [String] :output_profile Fallback output profile
2337
2419
  # @option opts [Vips::Intent] :intent Rendering intent
2338
2420
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
2339
2421
  # @return [Vips::Image] Output image
@@ -2349,8 +2431,8 @@ module Vips
2349
2431
  # @option opts [Boolean] :no_rotate Don't use orientation tags to rotate image upright
2350
2432
  # @option opts [Vips::Interesting] :crop Reduce to fill target rectangle, then crop
2351
2433
  # @option opts [Boolean] :linear Reduce in linear light
2352
- # @option opts [String] :import_profile Fallback import profile
2353
- # @option opts [String] :export_profile Fallback export profile
2434
+ # @option opts [String] :input_profile Fallback input profile
2435
+ # @option opts [String] :output_profile Fallback output profile
2354
2436
  # @option opts [Vips::Intent] :intent Rendering intent
2355
2437
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
2356
2438
  # @return [Vips::Image] Output image
@@ -2364,8 +2446,8 @@ module Vips
2364
2446
  # @option opts [Boolean] :no_rotate Don't use orientation tags to rotate image upright
2365
2447
  # @option opts [Vips::Interesting] :crop Reduce to fill target rectangle, then crop
2366
2448
  # @option opts [Boolean] :linear Reduce in linear light
2367
- # @option opts [String] :import_profile Fallback import profile
2368
- # @option opts [String] :export_profile Fallback export profile
2449
+ # @option opts [String] :input_profile Fallback input profile
2450
+ # @option opts [String] :output_profile Fallback output profile
2369
2451
  # @option opts [Vips::Intent] :intent Rendering intent
2370
2452
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
2371
2453
  # @return [Vips::Image] Output image
@@ -2381,8 +2463,8 @@ module Vips
2381
2463
  # @option opts [Boolean] :no_rotate Don't use orientation tags to rotate image upright
2382
2464
  # @option opts [Vips::Interesting] :crop Reduce to fill target rectangle, then crop
2383
2465
  # @option opts [Boolean] :linear Reduce in linear light
2384
- # @option opts [String] :import_profile Fallback import profile
2385
- # @option opts [String] :export_profile Fallback export profile
2466
+ # @option opts [String] :input_profile Fallback input profile
2467
+ # @option opts [String] :output_profile Fallback output profile
2386
2468
  # @option opts [Vips::Intent] :intent Rendering intent
2387
2469
  # @option opts [Vips::FailOn] :fail_on Error level to fail on
2388
2470
  # @return [Vips::Image] Output image
@@ -2470,7 +2552,7 @@ module Vips
2470
2552
  # Similarity transform of an image.
2471
2553
  # @param opts [Hash] Set of options
2472
2554
  # @option opts [Float] :scale Scale by this factor
2473
- # @option opts [Float] :angle Rotate anticlockwise by this many degrees
2555
+ # @option opts [Float] :angle Rotate clockwise by this many degrees
2474
2556
  # @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
2475
2557
  # @option opts [Array<Double>] :background Background value
2476
2558
  # @option opts [Float] :odx Horizontal output displacement
@@ -2481,7 +2563,7 @@ module Vips
2481
2563
 
2482
2564
  # @!method rotate(angle, **opts)
2483
2565
  # Rotate an image by a number of degrees.
2484
- # @param angle [Float] Rotate anticlockwise by this many degrees
2566
+ # @param angle [Float] Rotate clockwise by this many degrees
2485
2567
  # @param opts [Hash] Set of options
2486
2568
  # @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
2487
2569
  # @option opts [Array<Double>] :background Background value
@@ -2549,6 +2631,16 @@ module Vips
2549
2631
  # @param opts [Hash] Set of options
2550
2632
  # @return [Vips::Image] Output image
2551
2633
 
2634
+ # @!method scRGB2XYZ(**opts)
2635
+ # Transform scrgb to xyz.
2636
+ # @param opts [Hash] Set of options
2637
+ # @return [Vips::Image] Output image
2638
+
2639
+ # @!method XYZ2scRGB(**opts)
2640
+ # Transform xyz to scrgb.
2641
+ # @param opts [Hash] Set of options
2642
+ # @return [Vips::Image] Output image
2643
+
2552
2644
  # @!method LabQ2Lab(**opts)
2553
2645
  # Unpack a labq image to float lab.
2554
2646
  # @param opts [Hash] Set of options
@@ -2594,6 +2686,17 @@ module Vips
2594
2686
  # @param opts [Hash] Set of options
2595
2687
  # @return [Vips::Image] Output image
2596
2688
 
2689
+ # @!method sRGB2scRGB(**opts)
2690
+ # Convert an srgb image to scrgb.
2691
+ # @param opts [Hash] Set of options
2692
+ # @return [Vips::Image] Output image
2693
+
2694
+ # @!method scRGB2BW(**opts)
2695
+ # Convert scrgb to bw.
2696
+ # @param opts [Hash] Set of options
2697
+ # @option opts [Integer] :depth Output device space depth in bits
2698
+ # @return [Vips::Image] Output image
2699
+
2597
2700
  # @!method sRGB2HSV(**opts)
2598
2701
  # Transform srgb to hsv.
2599
2702
  # @param opts [Hash] Set of options
@@ -2604,6 +2707,12 @@ module Vips
2604
2707
  # @param opts [Hash] Set of options
2605
2708
  # @return [Vips::Image] Output image
2606
2709
 
2710
+ # @!method scRGB2sRGB(**opts)
2711
+ # Convert scrgb to srgb.
2712
+ # @param opts [Hash] Set of options
2713
+ # @option opts [Integer] :depth Output device space depth in bits
2714
+ # @return [Vips::Image] Output image
2715
+
2607
2716
  # @!method icc_import(**opts)
2608
2717
  # Import from device with icc profile.
2609
2718
  # @param opts [Hash] Set of options
@@ -2654,33 +2763,6 @@ module Vips
2654
2763
  # @param opts [Hash] Set of options
2655
2764
  # @return [Vips::Image] Output image
2656
2765
 
2657
- # @!method sRGB2scRGB(**opts)
2658
- # Convert an srgb image to scrgb.
2659
- # @param opts [Hash] Set of options
2660
- # @return [Vips::Image] Output image
2661
-
2662
- # @!method scRGB2XYZ(**opts)
2663
- # Transform scrgb to xyz.
2664
- # @param opts [Hash] Set of options
2665
- # @return [Vips::Image] Output image
2666
-
2667
- # @!method scRGB2BW(**opts)
2668
- # Convert scrgb to bw.
2669
- # @param opts [Hash] Set of options
2670
- # @option opts [Integer] :depth Output device space depth in bits
2671
- # @return [Vips::Image] Output image
2672
-
2673
- # @!method XYZ2scRGB(**opts)
2674
- # Transform xyz to scrgb.
2675
- # @param opts [Hash] Set of options
2676
- # @return [Vips::Image] Output image
2677
-
2678
- # @!method scRGB2sRGB(**opts)
2679
- # Convert an scrgb image to srgb.
2680
- # @param opts [Hash] Set of options
2681
- # @option opts [Integer] :depth Output device space depth in bits
2682
- # @return [Vips::Image] Output image
2683
-
2684
2766
  # @!method CMYK2XYZ(**opts)
2685
2767
  # Transform cmyk to xyz.
2686
2768
  # @param opts [Hash] Set of options
@@ -3067,7 +3149,13 @@ module Vips
3067
3149
  # @return [Vips::Image] Output image
3068
3150
 
3069
3151
  # @!method matrixinvert(**opts)
3070
- # Invert an matrix.
3152
+ # Invert a matrix.
3153
+ # @param opts [Hash] Set of options
3154
+ # @return [Vips::Image] Output matrix
3155
+
3156
+ # @!method matrixmultiply(right, **opts)
3157
+ # Multiply two matrices.
3158
+ # @param right [Vips::Image] Second matrix to multiply
3071
3159
  # @param opts [Hash] Set of options
3072
3160
  # @return [Vips::Image] Output matrix
3073
3161
 
@@ -3094,6 +3182,13 @@ module Vips
3094
3182
  # @param opts [Hash] Set of options
3095
3183
  # @option opts [Float] :gamma Image gamma
3096
3184
  # @option opts [Boolean] :int_output Integer output
3185
+ # @return [Vips::Image] Output image
3186
+
3187
+ # @!method remosaic(old_str, new_str, **opts)
3188
+ # Rebuild an mosaiced image.
3189
+ # @param old_str [String] Search for this string
3190
+ # @param new_str [String] And swap for this string
3191
+ # @param opts [Hash] Set of options
3097
3192
  # @return [Vips::Image] Output image
3098
3193
 
3099
3194
  end