ruby-vips 2.1.3 → 2.2.0

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
@@ -39,7 +39,7 @@ module Vips
39
39
  # @!method relational(right, relational, **opts)
40
40
  # Relational operation on two images.
41
41
  # @param right [Vips::Image] Right-hand image argument
42
- # @param relational [Vips::OperationRelational] relational to perform
42
+ # @param relational [Vips::OperationRelational] Relational to perform
43
43
  # @param opts [Hash] Set of options
44
44
  # @return [Vips::Image] Output image
45
45
 
@@ -52,21 +52,21 @@ module Vips
52
52
  # @!method boolean(right, boolean, **opts)
53
53
  # Boolean operation on two images.
54
54
  # @param right [Vips::Image] Right-hand image argument
55
- # @param boolean [Vips::OperationBoolean] boolean to perform
55
+ # @param boolean [Vips::OperationBoolean] Boolean to perform
56
56
  # @param opts [Hash] Set of options
57
57
  # @return [Vips::Image] Output image
58
58
 
59
59
  # @!method math2(right, math2, **opts)
60
60
  # Binary math operations.
61
61
  # @param right [Vips::Image] Right-hand image argument
62
- # @param math2 [Vips::OperationMath2] math to perform
62
+ # @param math2 [Vips::OperationMath2] Math to perform
63
63
  # @param opts [Hash] Set of options
64
64
  # @return [Vips::Image] Output image
65
65
 
66
66
  # @!method complex2(right, cmplx, **opts)
67
67
  # Complex binary operations on two images.
68
68
  # @param right [Vips::Image] Right-hand image argument
69
- # @param cmplx [Vips::OperationComplex2] binary complex operation to perform
69
+ # @param cmplx [Vips::OperationComplex2] Binary complex operation to perform
70
70
  # @param opts [Hash] Set of options
71
71
  # @return [Vips::Image] Output image
72
72
 
@@ -97,7 +97,7 @@ module Vips
97
97
 
98
98
  # @!method math(math, **opts)
99
99
  # Apply a math operation to an image.
100
- # @param math [Vips::OperationMath] math to perform
100
+ # @param math [Vips::OperationMath] Math to perform
101
101
  # @param opts [Hash] Set of options
102
102
  # @return [Vips::Image] Output image
103
103
 
@@ -113,13 +113,13 @@ module Vips
113
113
 
114
114
  # @!method round(round, **opts)
115
115
  # Perform a round function on an image.
116
- # @param round [Vips::OperationRound] rounding operation to perform
116
+ # @param round [Vips::OperationRound] Rounding operation to perform
117
117
  # @param opts [Hash] Set of options
118
118
  # @return [Vips::Image] Output image
119
119
 
120
120
  # @!method relational_const(relational, c, **opts)
121
121
  # Relational operations against a constant.
122
- # @param relational [Vips::OperationRelational] relational to perform
122
+ # @param relational [Vips::OperationRelational] Relational to perform
123
123
  # @param c [Array<Double>] Array of constants
124
124
  # @param opts [Hash] Set of options
125
125
  # @return [Vips::Image] Output image
@@ -132,27 +132,27 @@ module Vips
132
132
 
133
133
  # @!method boolean_const(boolean, c, **opts)
134
134
  # Boolean operations against a constant.
135
- # @param boolean [Vips::OperationBoolean] boolean to perform
135
+ # @param boolean [Vips::OperationBoolean] Boolean to perform
136
136
  # @param c [Array<Double>] Array of constants
137
137
  # @param opts [Hash] Set of options
138
138
  # @return [Vips::Image] Output image
139
139
 
140
140
  # @!method math2_const(math2, c, **opts)
141
141
  # Binary math operations with a constant.
142
- # @param math2 [Vips::OperationMath2] math to perform
142
+ # @param math2 [Vips::OperationMath2] Math to perform
143
143
  # @param c [Array<Double>] Array of constants
144
144
  # @param opts [Hash] Set of options
145
145
  # @return [Vips::Image] Output image
146
146
 
147
147
  # @!method complex(cmplx, **opts)
148
148
  # Perform a complex operation on an image.
149
- # @param cmplx [Vips::OperationComplex] complex to perform
149
+ # @param cmplx [Vips::OperationComplex] Complex to perform
150
150
  # @param opts [Hash] Set of options
151
151
  # @return [Vips::Image] Output image
152
152
 
153
153
  # @!method complexget(get, **opts)
154
154
  # Get a component from a complex image.
155
- # @param get [Vips::OperationComplexget] complex to perform
155
+ # @param get [Vips::OperationComplexget] Complex to perform
156
156
  # @param opts [Hash] Set of options
157
157
  # @return [Vips::Image] Output image
158
158
 
@@ -215,7 +215,7 @@ module Vips
215
215
  # @!method hough_line(**opts)
216
216
  # Find hough line transform.
217
217
  # @param opts [Hash] Set of options
218
- # @option opts [Integer] :width horizontal size of parameter space
218
+ # @option opts [Integer] :width Horizontal size of parameter space
219
219
  # @option opts [Integer] :height Vertical size of parameter space
220
220
  # @return [Vips::Image] Output image
221
221
 
@@ -260,12 +260,12 @@ module Vips
260
260
  # @param opts [Hash] Set of options
261
261
  # @option opts [Float] :threshold Object threshold
262
262
  # @option opts [Array<Double>] :background Color for background pixels
263
+ # @option opts [Boolean] :line_art Enable line art mode
263
264
  # @return [Array<Integer, Integer, Integer, Integer>] Left edge of image, Top edge of extract area, Width of extract area, Height of extract area
264
265
 
265
266
  # @!method copy(**opts)
266
267
  # Copy an image.
267
268
  # @param opts [Hash] Set of options
268
- # @option opts [Boolean] :swap Swap bytes in image between little and big-endian
269
269
  # @option opts [Integer] :width Image width in pixels
270
270
  # @option opts [Integer] :height Image height in pixels
271
271
  # @option opts [Integer] :bands Number of bands in image
@@ -301,9 +301,7 @@ module Vips
301
301
  # @!method sequential(**opts)
302
302
  # Check sequential access.
303
303
  # @param opts [Hash] Set of options
304
- # @option opts [Boolean] :trace trace pixel requests
305
304
  # @option opts [Integer] :tile_height Tile height in pixels
306
- # @option opts [Vips::Access] :access Expected access pattern
307
305
  # @return [Vips::Image] Output image
308
306
 
309
307
  # @!method cache(**opts)
@@ -327,7 +325,7 @@ module Vips
327
325
 
328
326
  # @!method gravity(direction, width, height, **opts)
329
327
  # Place an image within a larger image with a certain gravity.
330
- # @param direction [Vips::CompassDirection] direction to place image within width/height
328
+ # @param direction [Vips::CompassDirection] Direction to place image within width/height
331
329
  # @param width [Integer] Image width in pixels
332
330
  # @param height [Integer] Image height in pixels
333
331
  # @param opts [Hash] Set of options
@@ -399,7 +397,10 @@ module Vips
399
397
  # @param height [Integer] Height of extract area
400
398
  # @param opts [Hash] Set of options
401
399
  # @option opts [Vips::Interesting] :interesting How to measure interestingness
402
- # @return [Vips::Image] Output image
400
+ # @option opts [Boolean] :premultiplied Input image already has premultiplied alpha
401
+ # @option opts [Integer] :attention_x Output Horizontal position of attention centre
402
+ # @option opts [Integer] :attention_y Output Vertical position of attention centre
403
+ # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
403
404
 
404
405
  # @!method extract_band(band, **opts)
405
406
  # Extract band from an image.
@@ -428,7 +429,7 @@ module Vips
428
429
 
429
430
  # @!method bandbool(boolean, **opts)
430
431
  # Boolean operation across image bands.
431
- # @param boolean [Vips::OperationBoolean] boolean to perform
432
+ # @param boolean [Vips::OperationBoolean] Boolean to perform
432
433
  # @param opts [Hash] Set of options
433
434
  # @return [Vips::Image] Output image
434
435
 
@@ -467,7 +468,7 @@ module Vips
467
468
 
468
469
  # @!method recomb(m, **opts)
469
470
  # Linear recombination with matrix.
470
- # @param m [Vips::Image] matrix of coefficients
471
+ # @param m [Vips::Image] Matrix of coefficients
471
472
  # @param opts [Hash] Set of options
472
473
  # @return [Vips::Image] Output image
473
474
 
@@ -505,9 +506,9 @@ module Vips
505
506
 
506
507
  # @!method grid(tile_height, across, down, **opts)
507
508
  # Grid an image.
508
- # @param tile_height [Integer] chop into tiles this high
509
- # @param across [Integer] number of tiles across
510
- # @param down [Integer] number of tiles down
509
+ # @param tile_height [Integer] Chop into tiles this high
510
+ # @param across [Integer] Number of tiles across
511
+ # @param down [Integer] Number of tiles down
511
512
  # @param opts [Hash] Set of options
512
513
  # @return [Vips::Image] Output image
513
514
 
@@ -606,17 +607,15 @@ module Vips
606
607
  # @param min_ampl [Float] Minimum amplitude of Gaussian
607
608
  # @param opts [Hash] Set of options
608
609
  # @option opts [Boolean] :separable Generate separable Gaussian
609
- # @option opts [Boolean] :integer Generate integer Gaussian
610
610
  # @option opts [Vips::Precision] :precision Generate with this precision
611
611
  # @return [Vips::Image] Output image
612
612
 
613
613
  # @!method self.logmat(sigma, min_ampl, **opts)
614
614
  # Make a laplacian of gaussian image.
615
- # @param sigma [Float] Radius of Logmatian
616
- # @param min_ampl [Float] Minimum amplitude of Logmatian
615
+ # @param sigma [Float] Radius of Gaussian
616
+ # @param min_ampl [Float] Minimum amplitude of Gaussian
617
617
  # @param opts [Hash] Set of options
618
- # @option opts [Boolean] :separable Generate separable Logmatian
619
- # @option opts [Boolean] :integer Generate integer Logmatian
618
+ # @option opts [Boolean] :separable Generate separable Gaussian
620
619
  # @option opts [Vips::Precision] :precision Generate with this precision
621
620
  # @return [Vips::Image] Output image
622
621
 
@@ -628,11 +627,12 @@ module Vips
628
627
  # @option opts [Integer] :width Maximum image width in pixels
629
628
  # @option opts [Integer] :height Maximum image height in pixels
630
629
  # @option opts [Vips::Align] :align Align on the low, centre or high edge
631
- # @option opts [Boolean] :rgba Enable RGBA output
632
- # @option opts [Integer] :dpi DPI to render at
633
630
  # @option opts [Boolean] :justify Justify lines
631
+ # @option opts [Integer] :dpi DPI to render at
634
632
  # @option opts [Integer] :spacing Line spacing
635
633
  # @option opts [String] :fontfile Load this font file
634
+ # @option opts [Boolean] :rgba Enable RGBA output
635
+ # @option opts [Vips::TextWrap] :wrap Wrap lines on word or character boundaries
636
636
  # @option opts [Integer] :autofit_dpi Output DPI selected by autofit
637
637
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
638
638
 
@@ -702,7 +702,7 @@ module Vips
702
702
  # @param height [Integer] Image height in pixels
703
703
  # @param frequency_cutoff_x [Float] Frequency cutoff x
704
704
  # @param frequency_cutoff_y [Float] Frequency cutoff y
705
- # @param radius [Float] radius of circle
705
+ # @param radius [Float] Radius of circle
706
706
  # @param opts [Hash] Set of options
707
707
  # @option opts [Boolean] :uchar Output an unsigned char image
708
708
  # @option opts [Boolean] :nodc Remove DC component
@@ -746,7 +746,7 @@ module Vips
746
746
  # @param order [Float] Filter order
747
747
  # @param frequency_cutoff_x [Float] Frequency cutoff x
748
748
  # @param frequency_cutoff_y [Float] Frequency cutoff y
749
- # @param radius [Float] radius of circle
749
+ # @param radius [Float] Radius of circle
750
750
  # @param amplitude_cutoff [Float] Amplitude cutoff
751
751
  # @param opts [Hash] Set of options
752
752
  # @option opts [Boolean] :uchar Output an unsigned char image
@@ -788,7 +788,7 @@ module Vips
788
788
  # @param height [Integer] Image height in pixels
789
789
  # @param frequency_cutoff_x [Float] Frequency cutoff x
790
790
  # @param frequency_cutoff_y [Float] Frequency cutoff y
791
- # @param radius [Float] radius of circle
791
+ # @param radius [Float] Radius of circle
792
792
  # @param amplitude_cutoff [Float] Amplitude cutoff
793
793
  # @param opts [Hash] Set of options
794
794
  # @option opts [Boolean] :uchar Output an unsigned char image
@@ -886,9 +886,8 @@ module Vips
886
886
  # @option opts [String] :separator Set of separator characters
887
887
  # @option opts [Boolean] :memory Force open via memory
888
888
  # @option opts [Vips::Access] :access Required access pattern for this file
889
- # @option opts [Boolean] :sequential Sequential read only
890
- # @option opts [Boolean] :fail Fail on first error
891
- # @option opts [Boolean] :disc Open to disc
889
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
890
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
892
891
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
893
892
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
894
893
 
@@ -902,9 +901,8 @@ module Vips
902
901
  # @option opts [String] :separator Set of separator characters
903
902
  # @option opts [Boolean] :memory Force open via memory
904
903
  # @option opts [Vips::Access] :access Required access pattern for this file
905
- # @option opts [Boolean] :sequential Sequential read only
906
- # @option opts [Boolean] :fail Fail on first error
907
- # @option opts [Boolean] :disc Open to disc
904
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
905
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
908
906
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
909
907
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
910
908
 
@@ -914,9 +912,8 @@ module Vips
914
912
  # @param opts [Hash] Set of options
915
913
  # @option opts [Boolean] :memory Force open via memory
916
914
  # @option opts [Vips::Access] :access Required access pattern for this file
917
- # @option opts [Boolean] :sequential Sequential read only
918
- # @option opts [Boolean] :fail Fail on first error
919
- # @option opts [Boolean] :disc Open to disc
915
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
916
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
920
917
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
921
918
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
922
919
 
@@ -926,9 +923,8 @@ module Vips
926
923
  # @param opts [Hash] Set of options
927
924
  # @option opts [Boolean] :memory Force open via memory
928
925
  # @option opts [Vips::Access] :access Required access pattern for this file
929
- # @option opts [Boolean] :sequential Sequential read only
930
- # @option opts [Boolean] :fail Fail on first error
931
- # @option opts [Boolean] :disc Open to disc
926
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
927
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
932
928
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
933
929
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
934
930
 
@@ -944,9 +940,8 @@ module Vips
944
940
  # @option opts [Vips::Interpretation] :interpretation Pixel interpretation
945
941
  # @option opts [Boolean] :memory Force open via memory
946
942
  # @option opts [Vips::Access] :access Required access pattern for this file
947
- # @option opts [Boolean] :sequential Sequential read only
948
- # @option opts [Boolean] :fail Fail on first error
949
- # @option opts [Boolean] :disc Open to disc
943
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
944
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
950
945
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
951
946
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
952
947
 
@@ -956,9 +951,8 @@ module Vips
956
951
  # @param opts [Hash] Set of options
957
952
  # @option opts [Boolean] :memory Force open via memory
958
953
  # @option opts [Vips::Access] :access Required access pattern for this file
959
- # @option opts [Boolean] :sequential Sequential read only
960
- # @option opts [Boolean] :fail Fail on first error
961
- # @option opts [Boolean] :disc Open to disc
954
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
955
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
962
956
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
963
957
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
964
958
 
@@ -968,9 +962,8 @@ module Vips
968
962
  # @param opts [Hash] Set of options
969
963
  # @option opts [Boolean] :memory Force open via memory
970
964
  # @option opts [Vips::Access] :access Required access pattern for this file
971
- # @option opts [Boolean] :sequential Sequential read only
972
- # @option opts [Boolean] :fail Fail on first error
973
- # @option opts [Boolean] :disc Open to disc
965
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
966
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
974
967
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
975
968
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
976
969
 
@@ -980,9 +973,8 @@ module Vips
980
973
  # @param opts [Hash] Set of options
981
974
  # @option opts [Boolean] :memory Force open via memory
982
975
  # @option opts [Vips::Access] :access Required access pattern for this file
983
- # @option opts [Boolean] :sequential Sequential read only
984
- # @option opts [Boolean] :fail Fail on first error
985
- # @option opts [Boolean] :disc Open to disc
976
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
977
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
986
978
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
987
979
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
988
980
 
@@ -992,9 +984,8 @@ module Vips
992
984
  # @param opts [Hash] Set of options
993
985
  # @option opts [Boolean] :memory Force open via memory
994
986
  # @option opts [Vips::Access] :access Required access pattern for this file
995
- # @option opts [Boolean] :sequential Sequential read only
996
- # @option opts [Boolean] :fail Fail on first error
997
- # @option opts [Boolean] :disc Open to disc
987
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
988
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
998
989
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
999
990
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1000
991
 
@@ -1004,9 +995,8 @@ module Vips
1004
995
  # @param opts [Hash] Set of options
1005
996
  # @option opts [Boolean] :memory Force open via memory
1006
997
  # @option opts [Vips::Access] :access Required access pattern for this file
1007
- # @option opts [Boolean] :sequential Sequential read only
1008
- # @option opts [Boolean] :fail Fail on first error
1009
- # @option opts [Boolean] :disc Open to disc
998
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
999
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1010
1000
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1011
1001
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1012
1002
 
@@ -1016,9 +1006,8 @@ module Vips
1016
1006
  # @param opts [Hash] Set of options
1017
1007
  # @option opts [Boolean] :memory Force open via memory
1018
1008
  # @option opts [Vips::Access] :access Required access pattern for this file
1019
- # @option opts [Boolean] :sequential Sequential read only
1020
- # @option opts [Boolean] :fail Fail on first error
1021
- # @option opts [Boolean] :disc Open to disc
1009
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1010
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1022
1011
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1023
1012
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1024
1013
 
@@ -1028,9 +1017,8 @@ module Vips
1028
1017
  # @param opts [Hash] Set of options
1029
1018
  # @option opts [Boolean] :memory Force open via memory
1030
1019
  # @option opts [Vips::Access] :access Required access pattern for this file
1031
- # @option opts [Boolean] :sequential Sequential read only
1032
- # @option opts [Boolean] :fail Fail on first error
1033
- # @option opts [Boolean] :disc Open to disc
1020
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1021
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1034
1022
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1035
1023
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1036
1024
 
@@ -1040,9 +1028,8 @@ module Vips
1040
1028
  # @param opts [Hash] Set of options
1041
1029
  # @option opts [Boolean] :memory Force open via memory
1042
1030
  # @option opts [Vips::Access] :access Required access pattern for this file
1043
- # @option opts [Boolean] :sequential Sequential read only
1044
- # @option opts [Boolean] :fail Fail on first error
1045
- # @option opts [Boolean] :disc Open to disc
1031
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1032
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1046
1033
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1047
1034
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1048
1035
 
@@ -1055,9 +1042,8 @@ module Vips
1055
1042
  # @option opts [Boolean] :unlimited Allow SVG of any size
1056
1043
  # @option opts [Boolean] :memory Force open via memory
1057
1044
  # @option opts [Vips::Access] :access Required access pattern for this file
1058
- # @option opts [Boolean] :sequential Sequential read only
1059
- # @option opts [Boolean] :fail Fail on first error
1060
- # @option opts [Boolean] :disc Open to disc
1045
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1046
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1061
1047
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1062
1048
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1063
1049
 
@@ -1070,9 +1056,8 @@ module Vips
1070
1056
  # @option opts [Boolean] :unlimited Allow SVG of any size
1071
1057
  # @option opts [Boolean] :memory Force open via memory
1072
1058
  # @option opts [Vips::Access] :access Required access pattern for this file
1073
- # @option opts [Boolean] :sequential Sequential read only
1074
- # @option opts [Boolean] :fail Fail on first error
1075
- # @option opts [Boolean] :disc Open to disc
1059
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1060
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1076
1061
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1077
1062
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1078
1063
 
@@ -1085,45 +1070,8 @@ module Vips
1085
1070
  # @option opts [Boolean] :unlimited Allow SVG of any size
1086
1071
  # @option opts [Boolean] :memory Force open via memory
1087
1072
  # @option opts [Vips::Access] :access Required access pattern for this file
1088
- # @option opts [Boolean] :sequential Sequential read only
1089
- # @option opts [Boolean] :fail Fail on first error
1090
- # @option opts [Boolean] :disc Open to disc
1091
- # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1092
- # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1093
-
1094
- # @!method self.jxlload(filename, **opts)
1095
- # Load jpeg-xl image.
1096
- # @param filename [String] Filename to load from
1097
- # @param opts [Hash] Set of options
1098
- # @option opts [Boolean] :memory Force open via memory
1099
- # @option opts [Vips::Access] :access Required access pattern for this file
1100
- # @option opts [Boolean] :sequential Sequential read only
1101
- # @option opts [Boolean] :fail Fail on first error
1102
- # @option opts [Boolean] :disc Open to disc
1103
- # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1104
- # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1105
-
1106
- # @!method self.jxlload_buffer(buffer, **opts)
1107
- # Load jpeg-xl image.
1108
- # @param buffer [VipsBlob] Buffer to load from
1109
- # @param opts [Hash] Set of options
1110
- # @option opts [Boolean] :memory Force open via memory
1111
- # @option opts [Vips::Access] :access Required access pattern for this file
1112
- # @option opts [Boolean] :sequential Sequential read only
1113
- # @option opts [Boolean] :fail Fail on first error
1114
- # @option opts [Boolean] :disc Open to disc
1115
- # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1116
- # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1117
-
1118
- # @!method self.jxlload_source(source, **opts)
1119
- # Load jpeg-xl image.
1120
- # @param source [Vips::Source] Source to load from
1121
- # @param opts [Hash] Set of options
1122
- # @option opts [Boolean] :memory Force open via memory
1123
- # @option opts [Vips::Access] :access Required access pattern for this file
1124
- # @option opts [Boolean] :sequential Sequential read only
1125
- # @option opts [Boolean] :fail Fail on first error
1126
- # @option opts [Boolean] :disc Open to disc
1073
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1074
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1127
1075
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1128
1076
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1129
1077
 
@@ -1134,9 +1082,8 @@ module Vips
1134
1082
  # @option opts [Integer] :page Load this page from the image
1135
1083
  # @option opts [Boolean] :memory Force open via memory
1136
1084
  # @option opts [Vips::Access] :access Required access pattern for this file
1137
- # @option opts [Boolean] :sequential Sequential read only
1138
- # @option opts [Boolean] :fail Fail on first error
1139
- # @option opts [Boolean] :disc Open to disc
1085
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1086
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1140
1087
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1141
1088
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1142
1089
 
@@ -1147,9 +1094,8 @@ module Vips
1147
1094
  # @option opts [Integer] :page Load this page from the image
1148
1095
  # @option opts [Boolean] :memory Force open via memory
1149
1096
  # @option opts [Vips::Access] :access Required access pattern for this file
1150
- # @option opts [Boolean] :sequential Sequential read only
1151
- # @option opts [Boolean] :fail Fail on first error
1152
- # @option opts [Boolean] :disc Open to disc
1097
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1098
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1153
1099
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1154
1100
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1155
1101
 
@@ -1160,9 +1106,8 @@ module Vips
1160
1106
  # @option opts [Integer] :page Load this page from the image
1161
1107
  # @option opts [Boolean] :memory Force open via memory
1162
1108
  # @option opts [Vips::Access] :access Required access pattern for this file
1163
- # @option opts [Boolean] :sequential Sequential read only
1164
- # @option opts [Boolean] :fail Fail on first error
1165
- # @option opts [Boolean] :disc Open to disc
1109
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1110
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1166
1111
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1167
1112
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1168
1113
 
@@ -1170,13 +1115,12 @@ module Vips
1170
1115
  # Load gif with libnsgif.
1171
1116
  # @param filename [String] Filename to load from
1172
1117
  # @param opts [Hash] Set of options
1173
- # @option opts [Integer] :n Load this many pages
1174
- # @option opts [Integer] :page Load this page from the file
1118
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1119
+ # @option opts [Integer] :page First page to load
1175
1120
  # @option opts [Boolean] :memory Force open via memory
1176
1121
  # @option opts [Vips::Access] :access Required access pattern for this file
1177
- # @option opts [Boolean] :sequential Sequential read only
1178
- # @option opts [Boolean] :fail Fail on first error
1179
- # @option opts [Boolean] :disc Open to disc
1122
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1123
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1180
1124
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1181
1125
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1182
1126
 
@@ -1184,13 +1128,12 @@ module Vips
1184
1128
  # Load gif with libnsgif.
1185
1129
  # @param buffer [VipsBlob] Buffer to load from
1186
1130
  # @param opts [Hash] Set of options
1187
- # @option opts [Integer] :n Load this many pages
1188
- # @option opts [Integer] :page Load this page from the file
1131
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1132
+ # @option opts [Integer] :page First page to load
1189
1133
  # @option opts [Boolean] :memory Force open via memory
1190
1134
  # @option opts [Vips::Access] :access Required access pattern for this file
1191
- # @option opts [Boolean] :sequential Sequential read only
1192
- # @option opts [Boolean] :fail Fail on first error
1193
- # @option opts [Boolean] :disc Open to disc
1135
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1136
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1194
1137
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1195
1138
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1196
1139
 
@@ -1198,13 +1141,12 @@ module Vips
1198
1141
  # Load gif from source.
1199
1142
  # @param source [Vips::Source] Source to load from
1200
1143
  # @param opts [Hash] Set of options
1201
- # @option opts [Integer] :n Load this many pages
1202
- # @option opts [Integer] :page Load this page from the file
1144
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1145
+ # @option opts [Integer] :page First page to load
1203
1146
  # @option opts [Boolean] :memory Force open via memory
1204
1147
  # @option opts [Vips::Access] :access Required access pattern for this file
1205
- # @option opts [Boolean] :sequential Sequential read only
1206
- # @option opts [Boolean] :fail Fail on first error
1207
- # @option opts [Boolean] :disc Open to disc
1148
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1149
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1208
1150
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1209
1151
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1210
1152
 
@@ -1212,11 +1154,11 @@ module Vips
1212
1154
  # Load png from file.
1213
1155
  # @param filename [String] Filename to load from
1214
1156
  # @param opts [Hash] Set of options
1157
+ # @option opts [Boolean] :unlimited Remove all denial of service limits
1215
1158
  # @option opts [Boolean] :memory Force open via memory
1216
1159
  # @option opts [Vips::Access] :access Required access pattern for this file
1217
- # @option opts [Boolean] :sequential Sequential read only
1218
- # @option opts [Boolean] :fail Fail on first error
1219
- # @option opts [Boolean] :disc Open to disc
1160
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1161
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1220
1162
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1221
1163
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1222
1164
 
@@ -1224,11 +1166,11 @@ module Vips
1224
1166
  # Load png from buffer.
1225
1167
  # @param buffer [VipsBlob] Buffer to load from
1226
1168
  # @param opts [Hash] Set of options
1169
+ # @option opts [Boolean] :unlimited Remove all denial of service limits
1227
1170
  # @option opts [Boolean] :memory Force open via memory
1228
1171
  # @option opts [Vips::Access] :access Required access pattern for this file
1229
- # @option opts [Boolean] :sequential Sequential read only
1230
- # @option opts [Boolean] :fail Fail on first error
1231
- # @option opts [Boolean] :disc Open to disc
1172
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1173
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1232
1174
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1233
1175
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1234
1176
 
@@ -1236,11 +1178,11 @@ module Vips
1236
1178
  # Load png from source.
1237
1179
  # @param source [Vips::Source] Source to load from
1238
1180
  # @param opts [Hash] Set of options
1181
+ # @option opts [Boolean] :unlimited Remove all denial of service limits
1239
1182
  # @option opts [Boolean] :memory Force open via memory
1240
1183
  # @option opts [Vips::Access] :access Required access pattern for this file
1241
- # @option opts [Boolean] :sequential Sequential read only
1242
- # @option opts [Boolean] :fail Fail on first error
1243
- # @option opts [Boolean] :disc Open to disc
1184
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1185
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1244
1186
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1245
1187
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1246
1188
 
@@ -1250,9 +1192,8 @@ module Vips
1250
1192
  # @param opts [Hash] Set of options
1251
1193
  # @option opts [Boolean] :memory Force open via memory
1252
1194
  # @option opts [Vips::Access] :access Required access pattern for this file
1253
- # @option opts [Boolean] :sequential Sequential read only
1254
- # @option opts [Boolean] :fail Fail on first error
1255
- # @option opts [Boolean] :disc Open to disc
1195
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1196
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1256
1197
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1257
1198
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1258
1199
 
@@ -1262,11 +1203,11 @@ module Vips
1262
1203
  # @param opts [Hash] Set of options
1263
1204
  # @option opts [Integer] :shrink Shrink factor on load
1264
1205
  # @option opts [Boolean] :autorotate Rotate image using exif orientation
1206
+ # @option opts [Boolean] :unlimited Remove all denial of service limits
1265
1207
  # @option opts [Boolean] :memory Force open via memory
1266
1208
  # @option opts [Vips::Access] :access Required access pattern for this file
1267
- # @option opts [Boolean] :sequential Sequential read only
1268
- # @option opts [Boolean] :fail Fail on first error
1269
- # @option opts [Boolean] :disc Open to disc
1209
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1210
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1270
1211
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1271
1212
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1272
1213
 
@@ -1276,11 +1217,11 @@ module Vips
1276
1217
  # @param opts [Hash] Set of options
1277
1218
  # @option opts [Integer] :shrink Shrink factor on load
1278
1219
  # @option opts [Boolean] :autorotate Rotate image using exif orientation
1220
+ # @option opts [Boolean] :unlimited Remove all denial of service limits
1279
1221
  # @option opts [Boolean] :memory Force open via memory
1280
1222
  # @option opts [Vips::Access] :access Required access pattern for this file
1281
- # @option opts [Boolean] :sequential Sequential read only
1282
- # @option opts [Boolean] :fail Fail on first error
1283
- # @option opts [Boolean] :disc Open to disc
1223
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1224
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1284
1225
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1285
1226
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1286
1227
 
@@ -1290,11 +1231,11 @@ module Vips
1290
1231
  # @param opts [Hash] Set of options
1291
1232
  # @option opts [Integer] :shrink Shrink factor on load
1292
1233
  # @option opts [Boolean] :autorotate Rotate image using exif orientation
1234
+ # @option opts [Boolean] :unlimited Remove all denial of service limits
1293
1235
  # @option opts [Boolean] :memory Force open via memory
1294
1236
  # @option opts [Vips::Access] :access Required access pattern for this file
1295
- # @option opts [Boolean] :sequential Sequential read only
1296
- # @option opts [Boolean] :fail Fail on first error
1297
- # @option opts [Boolean] :disc Open to disc
1237
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1238
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1298
1239
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1299
1240
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1300
1241
 
@@ -1302,15 +1243,13 @@ module Vips
1302
1243
  # Load webp from file.
1303
1244
  # @param filename [String] Filename to load from
1304
1245
  # @param opts [Hash] Set of options
1305
- # @option opts [Integer] :page Load this page from the file
1306
- # @option opts [Integer] :n Load this many pages
1307
- # @option opts [Float] :scale Scale factor on load
1308
- # @option opts [Integer] :shrink Shrink factor on load
1246
+ # @option opts [Integer] :page First page to load
1247
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1248
+ # @option opts [Float] :scale Factor to scale by
1309
1249
  # @option opts [Boolean] :memory Force open via memory
1310
1250
  # @option opts [Vips::Access] :access Required access pattern for this file
1311
- # @option opts [Boolean] :sequential Sequential read only
1312
- # @option opts [Boolean] :fail Fail on first error
1313
- # @option opts [Boolean] :disc Open to disc
1251
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1252
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1314
1253
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1315
1254
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1316
1255
 
@@ -1318,15 +1257,13 @@ module Vips
1318
1257
  # Load webp from buffer.
1319
1258
  # @param buffer [VipsBlob] Buffer to load from
1320
1259
  # @param opts [Hash] Set of options
1321
- # @option opts [Integer] :page Load this page from the file
1322
- # @option opts [Integer] :n Load this many pages
1323
- # @option opts [Float] :scale Scale factor on load
1324
- # @option opts [Integer] :shrink Shrink factor on load
1260
+ # @option opts [Integer] :page First page to load
1261
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1262
+ # @option opts [Float] :scale Factor to scale by
1325
1263
  # @option opts [Boolean] :memory Force open via memory
1326
1264
  # @option opts [Vips::Access] :access Required access pattern for this file
1327
- # @option opts [Boolean] :sequential Sequential read only
1328
- # @option opts [Boolean] :fail Fail on first error
1329
- # @option opts [Boolean] :disc Open to disc
1265
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1266
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1330
1267
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1331
1268
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1332
1269
 
@@ -1334,15 +1271,13 @@ module Vips
1334
1271
  # Load webp from source.
1335
1272
  # @param source [Vips::Source] Source to load from
1336
1273
  # @param opts [Hash] Set of options
1337
- # @option opts [Integer] :page Load this page from the file
1338
- # @option opts [Integer] :n Load this many pages
1339
- # @option opts [Float] :scale Scale factor on load
1340
- # @option opts [Integer] :shrink Shrink factor on load
1274
+ # @option opts [Integer] :page First page to load
1275
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1276
+ # @option opts [Float] :scale Factor to scale by
1341
1277
  # @option opts [Boolean] :memory Force open via memory
1342
1278
  # @option opts [Vips::Access] :access Required access pattern for this file
1343
- # @option opts [Boolean] :sequential Sequential read only
1344
- # @option opts [Boolean] :fail Fail on first error
1345
- # @option opts [Boolean] :disc Open to disc
1279
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1280
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1346
1281
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1347
1282
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1348
1283
 
@@ -1350,15 +1285,14 @@ module Vips
1350
1285
  # Load tiff from file.
1351
1286
  # @param filename [String] Filename to load from
1352
1287
  # @param opts [Hash] Set of options
1353
- # @option opts [Integer] :page Load this page from the image
1354
- # @option opts [Integer] :subifd Select subifd index
1355
- # @option opts [Integer] :n Load this many pages
1288
+ # @option opts [Integer] :page First page to load
1289
+ # @option opts [Integer] :subifd Subifd index
1290
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1356
1291
  # @option opts [Boolean] :autorotate Rotate image using orientation tag
1357
1292
  # @option opts [Boolean] :memory Force open via memory
1358
1293
  # @option opts [Vips::Access] :access Required access pattern for this file
1359
- # @option opts [Boolean] :sequential Sequential read only
1360
- # @option opts [Boolean] :fail Fail on first error
1361
- # @option opts [Boolean] :disc Open to disc
1294
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1295
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1362
1296
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1363
1297
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1364
1298
 
@@ -1366,15 +1300,14 @@ module Vips
1366
1300
  # Load tiff from buffer.
1367
1301
  # @param buffer [VipsBlob] Buffer to load from
1368
1302
  # @param opts [Hash] Set of options
1369
- # @option opts [Integer] :page Load this page from the image
1370
- # @option opts [Integer] :subifd Select subifd index
1371
- # @option opts [Integer] :n Load this many pages
1303
+ # @option opts [Integer] :page First page to load
1304
+ # @option opts [Integer] :subifd Subifd index
1305
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1372
1306
  # @option opts [Boolean] :autorotate Rotate image using orientation tag
1373
1307
  # @option opts [Boolean] :memory Force open via memory
1374
1308
  # @option opts [Vips::Access] :access Required access pattern for this file
1375
- # @option opts [Boolean] :sequential Sequential read only
1376
- # @option opts [Boolean] :fail Fail on first error
1377
- # @option opts [Boolean] :disc Open to disc
1309
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1310
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1378
1311
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1379
1312
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1380
1313
 
@@ -1382,15 +1315,14 @@ module Vips
1382
1315
  # Load tiff from source.
1383
1316
  # @param source [Vips::Source] Source to load from
1384
1317
  # @param opts [Hash] Set of options
1385
- # @option opts [Integer] :page Load this page from the image
1386
- # @option opts [Integer] :subifd Select subifd index
1387
- # @option opts [Integer] :n Load this many pages
1318
+ # @option opts [Integer] :page First page to load
1319
+ # @option opts [Integer] :subifd Subifd index
1320
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1388
1321
  # @option opts [Boolean] :autorotate Rotate image using orientation tag
1389
1322
  # @option opts [Boolean] :memory Force open via memory
1390
1323
  # @option opts [Vips::Access] :access Required access pattern for this file
1391
- # @option opts [Boolean] :sequential Sequential read only
1392
- # @option opts [Boolean] :fail Fail on first error
1393
- # @option opts [Boolean] :disc Open to disc
1324
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1325
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1394
1326
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1395
1327
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1396
1328
 
@@ -1400,9 +1332,8 @@ module Vips
1400
1332
  # @param opts [Hash] Set of options
1401
1333
  # @option opts [Boolean] :memory Force open via memory
1402
1334
  # @option opts [Vips::Access] :access Required access pattern for this file
1403
- # @option opts [Boolean] :sequential Sequential read only
1404
- # @option opts [Boolean] :fail Fail on first error
1405
- # @option opts [Boolean] :disc Open to disc
1335
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1336
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1406
1337
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1407
1338
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1408
1339
 
@@ -1412,9 +1343,8 @@ module Vips
1412
1343
  # @param opts [Hash] Set of options
1413
1344
  # @option opts [Boolean] :memory Force open via memory
1414
1345
  # @option opts [Vips::Access] :access Required access pattern for this file
1415
- # @option opts [Boolean] :sequential Sequential read only
1416
- # @option opts [Boolean] :fail Fail on first error
1417
- # @option opts [Boolean] :disc Open to disc
1346
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1347
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1418
1348
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1419
1349
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1420
1350
 
@@ -1424,9 +1354,8 @@ module Vips
1424
1354
  # @param opts [Hash] Set of options
1425
1355
  # @option opts [Boolean] :memory Force open via memory
1426
1356
  # @option opts [Vips::Access] :access Required access pattern for this file
1427
- # @option opts [Boolean] :sequential Sequential read only
1428
- # @option opts [Boolean] :fail Fail on first error
1429
- # @option opts [Boolean] :disc Open to disc
1357
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1358
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1430
1359
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1431
1360
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1432
1361
 
@@ -1436,9 +1365,8 @@ module Vips
1436
1365
  # @param opts [Hash] Set of options
1437
1366
  # @option opts [Boolean] :memory Force open via memory
1438
1367
  # @option opts [Vips::Access] :access Required access pattern for this file
1439
- # @option opts [Boolean] :sequential Sequential read only
1440
- # @option opts [Boolean] :fail Fail on first error
1441
- # @option opts [Boolean] :disc Open to disc
1368
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1369
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1442
1370
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1443
1371
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1444
1372
 
@@ -1448,9 +1376,8 @@ module Vips
1448
1376
  # @param opts [Hash] Set of options
1449
1377
  # @option opts [Boolean] :memory Force open via memory
1450
1378
  # @option opts [Vips::Access] :access Required access pattern for this file
1451
- # @option opts [Boolean] :sequential Sequential read only
1452
- # @option opts [Boolean] :fail Fail on first error
1453
- # @option opts [Boolean] :disc Open to disc
1379
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1380
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1454
1381
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1455
1382
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1456
1383
 
@@ -1458,15 +1385,15 @@ module Vips
1458
1385
  # Load file with openslide.
1459
1386
  # @param filename [String] Filename to load from
1460
1387
  # @param opts [Hash] Set of options
1461
- # @option opts [Boolean] :attach_associated Attach all associated images
1462
1388
  # @option opts [Integer] :level Load this level from the file
1463
1389
  # @option opts [Boolean] :autocrop Crop to image bounds
1464
1390
  # @option opts [String] :associated Load this associated image
1391
+ # @option opts [Boolean] :attach_associated Attach all associated images
1392
+ # @option opts [Boolean] :rgb Output RGB (not RGBA)
1465
1393
  # @option opts [Boolean] :memory Force open via memory
1466
1394
  # @option opts [Vips::Access] :access Required access pattern for this file
1467
- # @option opts [Boolean] :sequential Sequential read only
1468
- # @option opts [Boolean] :fail Fail on first error
1469
- # @option opts [Boolean] :disc Open to disc
1395
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1396
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1470
1397
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1471
1398
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1472
1399
 
@@ -1474,15 +1401,15 @@ module Vips
1474
1401
  # Load source with openslide.
1475
1402
  # @param source [Vips::Source] Source to load from
1476
1403
  # @param opts [Hash] Set of options
1477
- # @option opts [Boolean] :attach_associated Attach all associated images
1478
1404
  # @option opts [Integer] :level Load this level from the file
1479
1405
  # @option opts [Boolean] :autocrop Crop to image bounds
1480
1406
  # @option opts [String] :associated Load this associated image
1407
+ # @option opts [Boolean] :attach_associated Attach all associated images
1408
+ # @option opts [Boolean] :rgb Output RGB (not RGBA)
1481
1409
  # @option opts [Boolean] :memory Force open via memory
1482
1410
  # @option opts [Vips::Access] :access Required access pattern for this file
1483
- # @option opts [Boolean] :sequential Sequential read only
1484
- # @option opts [Boolean] :fail Fail on first error
1485
- # @option opts [Boolean] :disc Open to disc
1411
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1412
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1486
1413
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1487
1414
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1488
1415
 
@@ -1490,15 +1417,14 @@ module Vips
1490
1417
  # Load a heif image.
1491
1418
  # @param filename [String] Filename to load from
1492
1419
  # @param opts [Hash] Set of options
1493
- # @option opts [Integer] :page Load this page from the file
1494
- # @option opts [Integer] :n Load this many pages
1420
+ # @option opts [Integer] :page First page to load
1421
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1495
1422
  # @option opts [Boolean] :thumbnail Fetch thumbnail image
1496
- # @option opts [Boolean] :autorotate Rotate image using exif orientation
1423
+ # @option opts [Boolean] :unlimited Remove all denial of service limits
1497
1424
  # @option opts [Boolean] :memory Force open via memory
1498
1425
  # @option opts [Vips::Access] :access Required access pattern for this file
1499
- # @option opts [Boolean] :sequential Sequential read only
1500
- # @option opts [Boolean] :fail Fail on first error
1501
- # @option opts [Boolean] :disc Open to disc
1426
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1427
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1502
1428
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1503
1429
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1504
1430
 
@@ -1506,15 +1432,14 @@ module Vips
1506
1432
  # Load a heif image.
1507
1433
  # @param buffer [VipsBlob] Buffer to load from
1508
1434
  # @param opts [Hash] Set of options
1509
- # @option opts [Integer] :page Load this page from the file
1510
- # @option opts [Integer] :n Load this many pages
1435
+ # @option opts [Integer] :page First page to load
1436
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1511
1437
  # @option opts [Boolean] :thumbnail Fetch thumbnail image
1512
- # @option opts [Boolean] :autorotate Rotate image using exif orientation
1438
+ # @option opts [Boolean] :unlimited Remove all denial of service limits
1513
1439
  # @option opts [Boolean] :memory Force open via memory
1514
1440
  # @option opts [Vips::Access] :access Required access pattern for this file
1515
- # @option opts [Boolean] :sequential Sequential read only
1516
- # @option opts [Boolean] :fail Fail on first error
1517
- # @option opts [Boolean] :disc Open to disc
1441
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1442
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1518
1443
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1519
1444
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1520
1445
 
@@ -1522,15 +1447,47 @@ module Vips
1522
1447
  # Load a heif image.
1523
1448
  # @param source [Vips::Source] Source to load from
1524
1449
  # @param opts [Hash] Set of options
1525
- # @option opts [Integer] :page Load this page from the file
1526
- # @option opts [Integer] :n Load this many pages
1450
+ # @option opts [Integer] :page First page to load
1451
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1527
1452
  # @option opts [Boolean] :thumbnail Fetch thumbnail image
1528
- # @option opts [Boolean] :autorotate Rotate image using exif orientation
1453
+ # @option opts [Boolean] :unlimited Remove all denial of service limits
1529
1454
  # @option opts [Boolean] :memory Force open via memory
1530
1455
  # @option opts [Vips::Access] :access Required access pattern for this file
1531
- # @option opts [Boolean] :sequential Sequential read only
1532
- # @option opts [Boolean] :fail Fail on first error
1533
- # @option opts [Boolean] :disc Open to disc
1456
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1457
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1458
+ # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1459
+ # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1460
+
1461
+ # @!method self.jxlload(filename, **opts)
1462
+ # Load jpeg-xl image.
1463
+ # @param filename [String] Filename to load from
1464
+ # @param opts [Hash] Set of options
1465
+ # @option opts [Boolean] :memory Force open via memory
1466
+ # @option opts [Vips::Access] :access Required access pattern for this file
1467
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1468
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1469
+ # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1470
+ # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1471
+
1472
+ # @!method self.jxlload_buffer(buffer, **opts)
1473
+ # Load jpeg-xl image.
1474
+ # @param buffer [VipsBlob] Buffer to load from
1475
+ # @param opts [Hash] Set of options
1476
+ # @option opts [Boolean] :memory Force open via memory
1477
+ # @option opts [Vips::Access] :access Required access pattern for this file
1478
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1479
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1480
+ # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1481
+ # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1482
+
1483
+ # @!method self.jxlload_source(source, **opts)
1484
+ # Load jpeg-xl image.
1485
+ # @param source [Vips::Source] Source to load from
1486
+ # @param opts [Hash] Set of options
1487
+ # @option opts [Boolean] :memory Force open via memory
1488
+ # @option opts [Vips::Access] :access Required access pattern for this file
1489
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1490
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1534
1491
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1535
1492
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1536
1493
 
@@ -1538,16 +1495,16 @@ module Vips
1538
1495
  # Load pdf from file.
1539
1496
  # @param filename [String] Filename to load from
1540
1497
  # @param opts [Hash] Set of options
1541
- # @option opts [Integer] :page Load this page from the file
1542
- # @option opts [Integer] :n Load this many pages
1543
- # @option opts [Float] :dpi Render at this DPI
1544
- # @option opts [Float] :scale Scale output by this factor
1545
- # @option opts [Array<Double>] :background Background value
1498
+ # @option opts [Integer] :page First page to load
1499
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1500
+ # @option opts [Float] :dpi DPI to render at
1501
+ # @option opts [Float] :scale Factor to scale by
1502
+ # @option opts [Array<Double>] :background Background colour
1503
+ # @option opts [String] :password Password to decrypt with
1546
1504
  # @option opts [Boolean] :memory Force open via memory
1547
1505
  # @option opts [Vips::Access] :access Required access pattern for this file
1548
- # @option opts [Boolean] :sequential Sequential read only
1549
- # @option opts [Boolean] :fail Fail on first error
1550
- # @option opts [Boolean] :disc Open to disc
1506
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1507
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1551
1508
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1552
1509
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1553
1510
 
@@ -1555,16 +1512,16 @@ module Vips
1555
1512
  # Load pdf from buffer.
1556
1513
  # @param buffer [VipsBlob] Buffer to load from
1557
1514
  # @param opts [Hash] Set of options
1558
- # @option opts [Integer] :page Load this page from the file
1559
- # @option opts [Integer] :n Load this many pages
1560
- # @option opts [Float] :dpi Render at this DPI
1561
- # @option opts [Float] :scale Scale output by this factor
1562
- # @option opts [Array<Double>] :background Background value
1515
+ # @option opts [Integer] :page First page to load
1516
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1517
+ # @option opts [Float] :dpi DPI to render at
1518
+ # @option opts [Float] :scale Factor to scale by
1519
+ # @option opts [Array<Double>] :background Background colour
1520
+ # @option opts [String] :password Password to decrypt with
1563
1521
  # @option opts [Boolean] :memory Force open via memory
1564
1522
  # @option opts [Vips::Access] :access Required access pattern for this file
1565
- # @option opts [Boolean] :sequential Sequential read only
1566
- # @option opts [Boolean] :fail Fail on first error
1567
- # @option opts [Boolean] :disc Open to disc
1523
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1524
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1568
1525
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1569
1526
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1570
1527
 
@@ -1572,16 +1529,16 @@ module Vips
1572
1529
  # Load pdf from source.
1573
1530
  # @param source [Vips::Source] Source to load from
1574
1531
  # @param opts [Hash] Set of options
1575
- # @option opts [Integer] :page Load this page from the file
1576
- # @option opts [Integer] :n Load this many pages
1577
- # @option opts [Float] :dpi Render at this DPI
1578
- # @option opts [Float] :scale Scale output by this factor
1579
- # @option opts [Array<Double>] :background Background value
1532
+ # @option opts [Integer] :page First page to load
1533
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1534
+ # @option opts [Float] :dpi DPI to render at
1535
+ # @option opts [Float] :scale Factor to scale by
1536
+ # @option opts [Array<Double>] :background Background colour
1537
+ # @option opts [String] :password Password to decrypt with
1580
1538
  # @option opts [Boolean] :memory Force open via memory
1581
1539
  # @option opts [Vips::Access] :access Required access pattern for this file
1582
- # @option opts [Boolean] :sequential Sequential read only
1583
- # @option opts [Boolean] :fail Fail on first error
1584
- # @option opts [Boolean] :disc Open to disc
1540
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1541
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1585
1542
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1586
1543
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1587
1544
 
@@ -1589,15 +1546,13 @@ module Vips
1589
1546
  # Load file with imagemagick.
1590
1547
  # @param filename [String] Filename to load from
1591
1548
  # @param opts [Hash] Set of options
1592
- # @option opts [Boolean] :all_frames Read all frames from an image
1593
1549
  # @option opts [String] :density Canvas resolution for rendering vector formats like SVG
1594
- # @option opts [Integer] :page Load this page from the file
1595
- # @option opts [Integer] :n Load this many pages
1550
+ # @option opts [Integer] :page First page to load
1551
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1596
1552
  # @option opts [Boolean] :memory Force open via memory
1597
1553
  # @option opts [Vips::Access] :access Required access pattern for this file
1598
- # @option opts [Boolean] :sequential Sequential read only
1599
- # @option opts [Boolean] :fail Fail on first error
1600
- # @option opts [Boolean] :disc Open to disc
1554
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1555
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1601
1556
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1602
1557
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1603
1558
 
@@ -1605,15 +1560,13 @@ module Vips
1605
1560
  # Load buffer with imagemagick.
1606
1561
  # @param buffer [VipsBlob] Buffer to load from
1607
1562
  # @param opts [Hash] Set of options
1608
- # @option opts [Boolean] :all_frames Read all frames from an image
1609
1563
  # @option opts [String] :density Canvas resolution for rendering vector formats like SVG
1610
- # @option opts [Integer] :page Load this page from the file
1611
- # @option opts [Integer] :n Load this many pages
1564
+ # @option opts [Integer] :page First page to load
1565
+ # @option opts [Integer] :n Number of pages to load, -1 for all
1612
1566
  # @option opts [Boolean] :memory Force open via memory
1613
1567
  # @option opts [Vips::Access] :access Required access pattern for this file
1614
- # @option opts [Boolean] :sequential Sequential read only
1615
- # @option opts [Boolean] :fail Fail on first error
1616
- # @option opts [Boolean] :disc Open to disc
1568
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
1569
+ # @option opts [Boolean] :revalidate Don't use a cached result for this operation
1617
1570
  # @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1618
1571
  # @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1619
1572
 
@@ -1621,8 +1574,9 @@ module Vips
1621
1574
  # Save image to csv.
1622
1575
  # @param filename [String] Filename to save to
1623
1576
  # @param opts [Hash] Set of options
1577
+ # @option opts [String] :profile Filename of ICC profile to embed
1624
1578
  # @option opts [String] :separator Separator characters
1625
- # @option opts [Boolean] :strip Strip all metadata from image
1579
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1626
1580
  # @option opts [Array<Double>] :background Background value
1627
1581
  # @option opts [Integer] :page_height Set page height for multipage save
1628
1582
  # @return [nil]
@@ -1631,8 +1585,9 @@ module Vips
1631
1585
  # Save image to csv.
1632
1586
  # @param target [Vips::Target] Target to save to
1633
1587
  # @param opts [Hash] Set of options
1588
+ # @option opts [String] :profile Filename of ICC profile to embed
1634
1589
  # @option opts [String] :separator Separator characters
1635
- # @option opts [Boolean] :strip Strip all metadata from image
1590
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1636
1591
  # @option opts [Array<Double>] :background Background value
1637
1592
  # @option opts [Integer] :page_height Set page height for multipage save
1638
1593
  # @return [nil]
@@ -1641,7 +1596,8 @@ module Vips
1641
1596
  # Save image to matrix.
1642
1597
  # @param filename [String] Filename to save to
1643
1598
  # @param opts [Hash] Set of options
1644
- # @option opts [Boolean] :strip Strip all metadata from image
1599
+ # @option opts [String] :profile Filename of ICC profile to embed
1600
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1645
1601
  # @option opts [Array<Double>] :background Background value
1646
1602
  # @option opts [Integer] :page_height Set page height for multipage save
1647
1603
  # @return [nil]
@@ -1650,7 +1606,8 @@ module Vips
1650
1606
  # Save image to matrix.
1651
1607
  # @param target [Vips::Target] Target to save to
1652
1608
  # @param opts [Hash] Set of options
1653
- # @option opts [Boolean] :strip Strip all metadata from image
1609
+ # @option opts [String] :profile Filename of ICC profile to embed
1610
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1654
1611
  # @option opts [Array<Double>] :background Background value
1655
1612
  # @option opts [Integer] :page_height Set page height for multipage save
1656
1613
  # @return [nil]
@@ -1658,7 +1615,8 @@ module Vips
1658
1615
  # @!method matrixprint(**opts)
1659
1616
  # Print matrix.
1660
1617
  # @param opts [Hash] Set of options
1661
- # @option opts [Boolean] :strip Strip all metadata from image
1618
+ # @option opts [String] :profile Filename of ICC profile to embed
1619
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1662
1620
  # @option opts [Array<Double>] :background Background value
1663
1621
  # @option opts [Integer] :page_height Set page height for multipage save
1664
1622
  # @return [nil]
@@ -1667,7 +1625,8 @@ module Vips
1667
1625
  # Save image to raw file.
1668
1626
  # @param filename [String] Filename to save to
1669
1627
  # @param opts [Hash] Set of options
1670
- # @option opts [Boolean] :strip Strip all metadata from image
1628
+ # @option opts [String] :profile Filename of ICC profile to embed
1629
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1671
1630
  # @option opts [Array<Double>] :background Background value
1672
1631
  # @option opts [Integer] :page_height Set page height for multipage save
1673
1632
  # @return [nil]
@@ -1676,7 +1635,8 @@ module Vips
1676
1635
  # Write raw image to file descriptor.
1677
1636
  # @param fd [Integer] File descriptor to write to
1678
1637
  # @param opts [Hash] Set of options
1679
- # @option opts [Boolean] :strip Strip all metadata from image
1638
+ # @option opts [String] :profile Filename of ICC profile to embed
1639
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1680
1640
  # @option opts [Array<Double>] :background Background value
1681
1641
  # @option opts [Integer] :page_height Set page height for multipage save
1682
1642
  # @return [nil]
@@ -1685,7 +1645,8 @@ module Vips
1685
1645
  # Save image to file in vips format.
1686
1646
  # @param filename [String] Filename to save to
1687
1647
  # @param opts [Hash] Set of options
1688
- # @option opts [Boolean] :strip Strip all metadata from image
1648
+ # @option opts [String] :profile Filename of ICC profile to embed
1649
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1689
1650
  # @option opts [Array<Double>] :background Background value
1690
1651
  # @option opts [Integer] :page_height Set page height for multipage save
1691
1652
  # @return [nil]
@@ -1694,7 +1655,8 @@ module Vips
1694
1655
  # Save image to target in vips format.
1695
1656
  # @param target [Vips::Target] Target to save to
1696
1657
  # @param opts [Hash] Set of options
1697
- # @option opts [Boolean] :strip Strip all metadata from image
1658
+ # @option opts [String] :profile Filename of ICC profile to embed
1659
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1698
1660
  # @option opts [Array<Double>] :background Background value
1699
1661
  # @option opts [Integer] :page_height Set page height for multipage save
1700
1662
  # @return [nil]
@@ -1703,10 +1665,11 @@ module Vips
1703
1665
  # Save image to ppm file.
1704
1666
  # @param filename [String] Filename to save to
1705
1667
  # @param opts [Hash] Set of options
1706
- # @option opts [Boolean] :ascii save as ascii
1707
- # @option opts [Boolean] :squash save as one bit
1708
- # @option opts [Integer] :bitdepth set to 1 to write as a 1 bit image
1709
- # @option opts [Boolean] :strip Strip all metadata from image
1668
+ # @option opts [Vips::ForeignPpmFormat] :format Format to save in
1669
+ # @option opts [Boolean] :ascii Save as ascii
1670
+ # @option opts [String] :profile Filename of ICC profile to embed
1671
+ # @option opts [Integer] :bitdepth Set to 1 to write as a 1 bit image
1672
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1710
1673
  # @option opts [Array<Double>] :background Background value
1711
1674
  # @option opts [Integer] :page_height Set page height for multipage save
1712
1675
  # @return [nil]
@@ -1715,10 +1678,11 @@ module Vips
1715
1678
  # Save to ppm.
1716
1679
  # @param target [Vips::Target] Target to save to
1717
1680
  # @param opts [Hash] Set of options
1718
- # @option opts [Boolean] :ascii save as ascii
1719
- # @option opts [Boolean] :squash save as one bit
1720
- # @option opts [Integer] :bitdepth set to 1 to write as a 1 bit image
1721
- # @option opts [Boolean] :strip Strip all metadata from image
1681
+ # @option opts [Vips::ForeignPpmFormat] :format Format to save in
1682
+ # @option opts [Boolean] :ascii Save as ascii
1683
+ # @option opts [String] :profile Filename of ICC profile to embed
1684
+ # @option opts [Integer] :bitdepth Set to 1 to write as a 1 bit image
1685
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1722
1686
  # @option opts [Array<Double>] :background Background value
1723
1687
  # @option opts [Integer] :page_height Set page height for multipage save
1724
1688
  # @return [nil]
@@ -1727,7 +1691,8 @@ module Vips
1727
1691
  # Save image to radiance file.
1728
1692
  # @param filename [String] Filename to save to
1729
1693
  # @param opts [Hash] Set of options
1730
- # @option opts [Boolean] :strip Strip all metadata from image
1694
+ # @option opts [String] :profile Filename of ICC profile to embed
1695
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1731
1696
  # @option opts [Array<Double>] :background Background value
1732
1697
  # @option opts [Integer] :page_height Set page height for multipage save
1733
1698
  # @return [nil]
@@ -1735,7 +1700,8 @@ module Vips
1735
1700
  # @!method radsave_buffer(**opts)
1736
1701
  # Save image to radiance buffer.
1737
1702
  # @param opts [Hash] Set of options
1738
- # @option opts [Boolean] :strip Strip all metadata from image
1703
+ # @option opts [String] :profile Filename of ICC profile to embed
1704
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1739
1705
  # @option opts [Array<Double>] :background Background value
1740
1706
  # @option opts [Integer] :page_height Set page height for multipage save
1741
1707
  # @return [VipsBlob] Buffer to save to
@@ -1744,48 +1710,8 @@ module Vips
1744
1710
  # Save image to radiance target.
1745
1711
  # @param target [Vips::Target] Target to save to
1746
1712
  # @param opts [Hash] Set of options
1747
- # @option opts [Boolean] :strip Strip all metadata from image
1748
- # @option opts [Array<Double>] :background Background value
1749
- # @option opts [Integer] :page_height Set page height for multipage save
1750
- # @return [nil]
1751
-
1752
- # @!method jxlsave(filename, **opts)
1753
- # Save image in jpeg-xl format.
1754
- # @param filename [String] Filename to load from
1755
- # @param opts [Hash] Set of options
1756
- # @option opts [Integer] :tier Decode speed tier
1757
- # @option opts [Float] :distance Target butteraugli distance
1758
- # @option opts [Integer] :effort Encoding effort
1759
- # @option opts [Boolean] :lossless Enable lossless compression
1760
- # @option opts [Integer] :Q Quality factor
1761
- # @option opts [Boolean] :strip Strip all metadata from image
1762
- # @option opts [Array<Double>] :background Background value
1763
- # @option opts [Integer] :page_height Set page height for multipage save
1764
- # @return [nil]
1765
-
1766
- # @!method jxlsave_buffer(**opts)
1767
- # Save image in jpeg-xl format.
1768
- # @param opts [Hash] Set of options
1769
- # @option opts [Integer] :tier Decode speed tier
1770
- # @option opts [Float] :distance Target butteraugli distance
1771
- # @option opts [Integer] :effort Encoding effort
1772
- # @option opts [Boolean] :lossless Enable lossless compression
1773
- # @option opts [Integer] :Q Quality factor
1774
- # @option opts [Boolean] :strip Strip all metadata from image
1775
- # @option opts [Array<Double>] :background Background value
1776
- # @option opts [Integer] :page_height Set page height for multipage save
1777
- # @return [VipsBlob] Buffer to save to
1778
-
1779
- # @!method jxlsave_target(target, **opts)
1780
- # Save image in jpeg-xl format.
1781
- # @param target [Vips::Target] Target to save to
1782
- # @param opts [Hash] Set of options
1783
- # @option opts [Integer] :tier Decode speed tier
1784
- # @option opts [Float] :distance Target butteraugli distance
1785
- # @option opts [Integer] :effort Encoding effort
1786
- # @option opts [Boolean] :lossless Enable lossless compression
1787
- # @option opts [Integer] :Q Quality factor
1788
- # @option opts [Boolean] :strip Strip all metadata from image
1713
+ # @option opts [String] :profile Filename of ICC profile to embed
1714
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1789
1715
  # @option opts [Array<Double>] :background Background value
1790
1716
  # @option opts [Integer] :page_height Set page height for multipage save
1791
1717
  # @return [nil]
@@ -1795,11 +1721,12 @@ module Vips
1795
1721
  # @param filename [String] Filename to load from
1796
1722
  # @param opts [Hash] Set of options
1797
1723
  # @option opts [Integer] :tile_width Tile width in pixels
1724
+ # @option opts [String] :profile Filename of ICC profile to embed
1798
1725
  # @option opts [Integer] :tile_height Tile height in pixels
1799
1726
  # @option opts [Boolean] :lossless Enable lossless compression
1800
1727
  # @option opts [Integer] :Q Q factor
1801
1728
  # @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
1802
- # @option opts [Boolean] :strip Strip all metadata from image
1729
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1803
1730
  # @option opts [Array<Double>] :background Background value
1804
1731
  # @option opts [Integer] :page_height Set page height for multipage save
1805
1732
  # @return [nil]
@@ -1808,11 +1735,12 @@ module Vips
1808
1735
  # Save image in jpeg2000 format.
1809
1736
  # @param opts [Hash] Set of options
1810
1737
  # @option opts [Integer] :tile_width Tile width in pixels
1738
+ # @option opts [String] :profile Filename of ICC profile to embed
1811
1739
  # @option opts [Integer] :tile_height Tile height in pixels
1812
1740
  # @option opts [Boolean] :lossless Enable lossless compression
1813
1741
  # @option opts [Integer] :Q Q factor
1814
1742
  # @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
1815
- # @option opts [Boolean] :strip Strip all metadata from image
1743
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1816
1744
  # @option opts [Array<Double>] :background Background value
1817
1745
  # @option opts [Integer] :page_height Set page height for multipage save
1818
1746
  # @return [VipsBlob] Buffer to save to
@@ -1822,11 +1750,62 @@ module Vips
1822
1750
  # @param target [Vips::Target] Target to save to
1823
1751
  # @param opts [Hash] Set of options
1824
1752
  # @option opts [Integer] :tile_width Tile width in pixels
1753
+ # @option opts [String] :profile Filename of ICC profile to embed
1825
1754
  # @option opts [Integer] :tile_height Tile height in pixels
1826
1755
  # @option opts [Boolean] :lossless Enable lossless compression
1827
1756
  # @option opts [Integer] :Q Q factor
1828
1757
  # @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
1829
- # @option opts [Boolean] :strip Strip all metadata from image
1758
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1759
+ # @option opts [Array<Double>] :background Background value
1760
+ # @option opts [Integer] :page_height Set page height for multipage save
1761
+ # @return [nil]
1762
+
1763
+ # @!method gifsave(filename, **opts)
1764
+ # Save as gif.
1765
+ # @param filename [String] Filename to save to
1766
+ # @param opts [Hash] Set of options
1767
+ # @option opts [Float] :dither Amount of dithering
1768
+ # @option opts [Integer] :effort Quantisation effort
1769
+ # @option opts [String] :profile Filename of ICC profile to embed
1770
+ # @option opts [Integer] :bitdepth Number of bits per pixel
1771
+ # @option opts [Float] :interframe_maxerror Maximum inter-frame error for transparency
1772
+ # @option opts [Boolean] :reuse Reuse palette from input
1773
+ # @option opts [Float] :interpalette_maxerror Maximum inter-palette error for palette reusage
1774
+ # @option opts [Boolean] :interlace Generate an interlaced (progressive) GIF
1775
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1776
+ # @option opts [Array<Double>] :background Background value
1777
+ # @option opts [Integer] :page_height Set page height for multipage save
1778
+ # @return [nil]
1779
+
1780
+ # @!method gifsave_buffer(**opts)
1781
+ # Save as gif.
1782
+ # @param opts [Hash] Set of options
1783
+ # @option opts [Float] :dither Amount of dithering
1784
+ # @option opts [Integer] :effort Quantisation effort
1785
+ # @option opts [String] :profile Filename of ICC profile to embed
1786
+ # @option opts [Integer] :bitdepth Number of bits per pixel
1787
+ # @option opts [Float] :interframe_maxerror Maximum inter-frame error for transparency
1788
+ # @option opts [Boolean] :reuse Reuse palette from input
1789
+ # @option opts [Float] :interpalette_maxerror Maximum inter-palette error for palette reusage
1790
+ # @option opts [Boolean] :interlace Generate an interlaced (progressive) GIF
1791
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1792
+ # @option opts [Array<Double>] :background Background value
1793
+ # @option opts [Integer] :page_height Set page height for multipage save
1794
+ # @return [VipsBlob] Buffer to save to
1795
+
1796
+ # @!method gifsave_target(target, **opts)
1797
+ # Save as gif.
1798
+ # @param target [Vips::Target] Target to save to
1799
+ # @param opts [Hash] Set of options
1800
+ # @option opts [Float] :dither Amount of dithering
1801
+ # @option opts [Integer] :effort Quantisation effort
1802
+ # @option opts [String] :profile Filename of ICC profile to embed
1803
+ # @option opts [Integer] :bitdepth Number of bits per pixel
1804
+ # @option opts [Float] :interframe_maxerror Maximum inter-frame error for transparency
1805
+ # @option opts [Boolean] :reuse Reuse palette from input
1806
+ # @option opts [Float] :interpalette_maxerror Maximum inter-palette error for palette reusage
1807
+ # @option opts [Boolean] :interlace Generate an interlaced (progressive) GIF
1808
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1830
1809
  # @option opts [Array<Double>] :background Background value
1831
1810
  # @option opts [Integer] :page_height Set page height for multipage save
1832
1811
  # @return [nil]
@@ -1835,25 +1814,22 @@ module Vips
1835
1814
  # Save image to deepzoom file.
1836
1815
  # @param filename [String] Filename to save to
1837
1816
  # @param opts [Hash] Set of options
1838
- # @option opts [String] :dirname Directory name to save to
1839
- # @option opts [String] :basename Base name to save to
1817
+ # @option opts [String] :imagename Image name
1840
1818
  # @option opts [Vips::ForeignDzLayout] :layout Directory layout
1841
1819
  # @option opts [String] :suffix Filename suffix for tiles
1842
1820
  # @option opts [Integer] :overlap Tile overlap in pixels
1843
1821
  # @option opts [Integer] :tile_size Tile size in pixels
1844
- # @option opts [Integer] :tile_height Tile height in pixels
1845
- # @option opts [Integer] :tile_width Tile width in pixels
1822
+ # @option opts [String] :profile Filename of ICC profile to embed
1846
1823
  # @option opts [Boolean] :centre Center image in tile
1847
1824
  # @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
1848
1825
  # @option opts [Vips::Angle] :angle Rotate image during save
1849
1826
  # @option opts [Vips::ForeignDzContainer] :container Pyramid container type
1850
- # @option opts [Boolean] :properties Write a properties file to the output directory
1851
1827
  # @option opts [Integer] :compression ZIP deflate compression level
1852
1828
  # @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
1853
1829
  # @option opts [Integer] :skip_blanks Skip tiles which are nearly equal to the background
1854
- # @option opts [Boolean] :no_strip Don't strip tile metadata
1855
1830
  # @option opts [String] :id Resource ID
1856
- # @option opts [Boolean] :strip Strip all metadata from image
1831
+ # @option opts [Integer] :Q Q factor
1832
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1857
1833
  # @option opts [Array<Double>] :background Background value
1858
1834
  # @option opts [Integer] :page_height Set page height for multipage save
1859
1835
  # @return [nil]
@@ -1861,43 +1837,64 @@ module Vips
1861
1837
  # @!method dzsave_buffer(**opts)
1862
1838
  # Save image to dz buffer.
1863
1839
  # @param opts [Hash] Set of options
1864
- # @option opts [String] :dirname Directory name to save to
1865
- # @option opts [String] :basename Base name to save to
1840
+ # @option opts [String] :imagename Image name
1866
1841
  # @option opts [Vips::ForeignDzLayout] :layout Directory layout
1867
1842
  # @option opts [String] :suffix Filename suffix for tiles
1868
1843
  # @option opts [Integer] :overlap Tile overlap in pixels
1869
1844
  # @option opts [Integer] :tile_size Tile size in pixels
1870
- # @option opts [Integer] :tile_height Tile height in pixels
1871
- # @option opts [Integer] :tile_width Tile width in pixels
1845
+ # @option opts [String] :profile Filename of ICC profile to embed
1872
1846
  # @option opts [Boolean] :centre Center image in tile
1873
1847
  # @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
1874
1848
  # @option opts [Vips::Angle] :angle Rotate image during save
1875
1849
  # @option opts [Vips::ForeignDzContainer] :container Pyramid container type
1876
- # @option opts [Boolean] :properties Write a properties file to the output directory
1877
1850
  # @option opts [Integer] :compression ZIP deflate compression level
1878
1851
  # @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
1879
1852
  # @option opts [Integer] :skip_blanks Skip tiles which are nearly equal to the background
1880
- # @option opts [Boolean] :no_strip Don't strip tile metadata
1881
1853
  # @option opts [String] :id Resource ID
1882
- # @option opts [Boolean] :strip Strip all metadata from image
1854
+ # @option opts [Integer] :Q Q factor
1855
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1883
1856
  # @option opts [Array<Double>] :background Background value
1884
1857
  # @option opts [Integer] :page_height Set page height for multipage save
1885
1858
  # @return [VipsBlob] Buffer to save to
1886
1859
 
1860
+ # @!method dzsave_target(target, **opts)
1861
+ # Save image to deepzoom target.
1862
+ # @param target [Vips::Target] Target to save to
1863
+ # @param opts [Hash] Set of options
1864
+ # @option opts [String] :imagename Image name
1865
+ # @option opts [Vips::ForeignDzLayout] :layout Directory layout
1866
+ # @option opts [String] :suffix Filename suffix for tiles
1867
+ # @option opts [Integer] :overlap Tile overlap in pixels
1868
+ # @option opts [Integer] :tile_size Tile size in pixels
1869
+ # @option opts [String] :profile Filename of ICC profile to embed
1870
+ # @option opts [Boolean] :centre Center image in tile
1871
+ # @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
1872
+ # @option opts [Vips::Angle] :angle Rotate image during save
1873
+ # @option opts [Vips::ForeignDzContainer] :container Pyramid container type
1874
+ # @option opts [Integer] :compression ZIP deflate compression level
1875
+ # @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
1876
+ # @option opts [Integer] :skip_blanks Skip tiles which are nearly equal to the background
1877
+ # @option opts [String] :id Resource ID
1878
+ # @option opts [Integer] :Q Q factor
1879
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1880
+ # @option opts [Array<Double>] :background Background value
1881
+ # @option opts [Integer] :page_height Set page height for multipage save
1882
+ # @return [nil]
1883
+
1887
1884
  # @!method pngsave(filename, **opts)
1888
1885
  # Save image to png file.
1889
1886
  # @param filename [String] Filename to save to
1890
1887
  # @param opts [Hash] Set of options
1891
1888
  # @option opts [Integer] :compression Compression factor
1892
1889
  # @option opts [Boolean] :interlace Interlace image
1893
- # @option opts [String] :profile ICC profile to embed
1890
+ # @option opts [String] :profile Filename of ICC profile to embed
1894
1891
  # @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
1895
1892
  # @option opts [Boolean] :palette Quantise to 8bpp palette
1896
- # @option opts [Integer] :colours Max number of palette colours
1897
1893
  # @option opts [Integer] :Q Quantisation quality
1898
1894
  # @option opts [Float] :dither Amount of dithering
1899
- # @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
1900
- # @option opts [Boolean] :strip Strip all metadata from image
1895
+ # @option opts [Integer] :bitdepth Write as a 1, 2, 4, 8 or 16 bit image
1896
+ # @option opts [Integer] :effort Quantisation CPU effort
1897
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1901
1898
  # @option opts [Array<Double>] :background Background value
1902
1899
  # @option opts [Integer] :page_height Set page height for multipage save
1903
1900
  # @return [nil]
@@ -1907,14 +1904,14 @@ module Vips
1907
1904
  # @param opts [Hash] Set of options
1908
1905
  # @option opts [Integer] :compression Compression factor
1909
1906
  # @option opts [Boolean] :interlace Interlace image
1910
- # @option opts [String] :profile ICC profile to embed
1907
+ # @option opts [String] :profile Filename of ICC profile to embed
1911
1908
  # @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
1912
1909
  # @option opts [Boolean] :palette Quantise to 8bpp palette
1913
- # @option opts [Integer] :colours Max number of palette colours
1914
1910
  # @option opts [Integer] :Q Quantisation quality
1915
1911
  # @option opts [Float] :dither Amount of dithering
1916
- # @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
1917
- # @option opts [Boolean] :strip Strip all metadata from image
1912
+ # @option opts [Integer] :bitdepth Write as a 1, 2, 4, 8 or 16 bit image
1913
+ # @option opts [Integer] :effort Quantisation CPU effort
1914
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1918
1915
  # @option opts [Array<Double>] :background Background value
1919
1916
  # @option opts [Integer] :page_height Set page height for multipage save
1920
1917
  # @return [VipsBlob] Buffer to save to
@@ -1925,14 +1922,14 @@ module Vips
1925
1922
  # @param opts [Hash] Set of options
1926
1923
  # @option opts [Integer] :compression Compression factor
1927
1924
  # @option opts [Boolean] :interlace Interlace image
1928
- # @option opts [String] :profile ICC profile to embed
1925
+ # @option opts [String] :profile Filename of ICC profile to embed
1929
1926
  # @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
1930
1927
  # @option opts [Boolean] :palette Quantise to 8bpp palette
1931
- # @option opts [Integer] :colours Max number of palette colours
1932
1928
  # @option opts [Integer] :Q Quantisation quality
1933
1929
  # @option opts [Float] :dither Amount of dithering
1934
- # @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
1935
- # @option opts [Boolean] :strip Strip all metadata from image
1930
+ # @option opts [Integer] :bitdepth Write as a 1, 2, 4, 8 or 16 bit image
1931
+ # @option opts [Integer] :effort Quantisation CPU effort
1932
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1936
1933
  # @option opts [Array<Double>] :background Background value
1937
1934
  # @option opts [Integer] :page_height Set page height for multipage save
1938
1935
  # @return [nil]
@@ -1942,16 +1939,16 @@ module Vips
1942
1939
  # @param filename [String] Filename to save to
1943
1940
  # @param opts [Hash] Set of options
1944
1941
  # @option opts [Integer] :Q Q factor
1945
- # @option opts [String] :profile ICC profile to embed
1942
+ # @option opts [String] :profile Filename of ICC profile to embed
1946
1943
  # @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
1947
1944
  # @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
1948
- # @option opts [Boolean] :no_subsample Disable chroma subsample
1949
1945
  # @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
1950
1946
  # @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
1951
1947
  # @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
1952
1948
  # @option opts [Integer] :quant_table Use predefined quantization table with given index
1953
1949
  # @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
1954
- # @option opts [Boolean] :strip Strip all metadata from image
1950
+ # @option opts [Integer] :restart_interval Add restart markers every specified number of mcu
1951
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1955
1952
  # @option opts [Array<Double>] :background Background value
1956
1953
  # @option opts [Integer] :page_height Set page height for multipage save
1957
1954
  # @return [nil]
@@ -1960,16 +1957,16 @@ module Vips
1960
1957
  # Save image to jpeg buffer.
1961
1958
  # @param opts [Hash] Set of options
1962
1959
  # @option opts [Integer] :Q Q factor
1963
- # @option opts [String] :profile ICC profile to embed
1960
+ # @option opts [String] :profile Filename of ICC profile to embed
1964
1961
  # @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
1965
1962
  # @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
1966
- # @option opts [Boolean] :no_subsample Disable chroma subsample
1967
1963
  # @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
1968
1964
  # @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
1969
1965
  # @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
1970
1966
  # @option opts [Integer] :quant_table Use predefined quantization table with given index
1971
1967
  # @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
1972
- # @option opts [Boolean] :strip Strip all metadata from image
1968
+ # @option opts [Integer] :restart_interval Add restart markers every specified number of mcu
1969
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1973
1970
  # @option opts [Array<Double>] :background Background value
1974
1971
  # @option opts [Integer] :page_height Set page height for multipage save
1975
1972
  # @return [VipsBlob] Buffer to save to
@@ -1979,16 +1976,16 @@ module Vips
1979
1976
  # @param target [Vips::Target] Target to save to
1980
1977
  # @param opts [Hash] Set of options
1981
1978
  # @option opts [Integer] :Q Q factor
1982
- # @option opts [String] :profile ICC profile to embed
1979
+ # @option opts [String] :profile Filename of ICC profile to embed
1983
1980
  # @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
1984
1981
  # @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
1985
- # @option opts [Boolean] :no_subsample Disable chroma subsample
1986
1982
  # @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
1987
1983
  # @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
1988
1984
  # @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
1989
1985
  # @option opts [Integer] :quant_table Use predefined quantization table with given index
1990
1986
  # @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
1991
- # @option opts [Boolean] :strip Strip all metadata from image
1987
+ # @option opts [Integer] :restart_interval Add restart markers every specified number of mcu
1988
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
1992
1989
  # @option opts [Array<Double>] :background Background value
1993
1990
  # @option opts [Integer] :page_height Set page height for multipage save
1994
1991
  # @return [nil]
@@ -1997,75 +1994,98 @@ module Vips
1997
1994
  # Save image to jpeg mime.
1998
1995
  # @param opts [Hash] Set of options
1999
1996
  # @option opts [Integer] :Q Q factor
2000
- # @option opts [String] :profile ICC profile to embed
1997
+ # @option opts [String] :profile Filename of ICC profile to embed
2001
1998
  # @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
2002
1999
  # @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
2003
- # @option opts [Boolean] :no_subsample Disable chroma subsample
2004
2000
  # @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
2005
2001
  # @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
2006
2002
  # @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
2007
2003
  # @option opts [Integer] :quant_table Use predefined quantization table with given index
2008
2004
  # @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
2009
- # @option opts [Boolean] :strip Strip all metadata from image
2005
+ # @option opts [Integer] :restart_interval Add restart markers every specified number of mcu
2006
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2010
2007
  # @option opts [Array<Double>] :background Background value
2011
2008
  # @option opts [Integer] :page_height Set page height for multipage save
2012
2009
  # @return [nil]
2013
2010
 
2014
2011
  # @!method webpsave(filename, **opts)
2015
- # Save image to webp file.
2012
+ # Save as webp.
2016
2013
  # @param filename [String] Filename to save to
2017
2014
  # @param opts [Hash] Set of options
2018
2015
  # @option opts [Integer] :Q Q factor
2019
- # @option opts [Boolean] :lossless enable lossless compression
2016
+ # @option opts [Boolean] :lossless Enable lossless compression
2017
+ # @option opts [String] :profile Filename of ICC profile to embed
2020
2018
  # @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
2021
2019
  # @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
2022
2020
  # @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
2023
2021
  # @option opts [Integer] :alpha_q Change alpha plane fidelity for lossy compression
2024
- # @option opts [Boolean] :min_size Optimise for minium size
2022
+ # @option opts [Boolean] :min_size Optimise for minimum size
2025
2023
  # @option opts [Integer] :kmin Minimum number of frames between key frames
2026
2024
  # @option opts [Integer] :kmax Maximum number of frames between key frames
2027
- # @option opts [Integer] :reduction_effort Level of CPU effort to reduce file size
2028
- # @option opts [String] :profile ICC profile to embed
2029
- # @option opts [Boolean] :strip Strip all metadata from image
2025
+ # @option opts [Integer] :effort Level of CPU effort to reduce file size
2026
+ # @option opts [Boolean] :mixed Allow mixed encoding (might reduce file size)
2027
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2030
2028
  # @option opts [Array<Double>] :background Background value
2031
2029
  # @option opts [Integer] :page_height Set page height for multipage save
2032
2030
  # @return [nil]
2033
2031
 
2034
2032
  # @!method webpsave_buffer(**opts)
2035
- # Save image to webp buffer.
2033
+ # Save as webp.
2036
2034
  # @param opts [Hash] Set of options
2037
2035
  # @option opts [Integer] :Q Q factor
2038
- # @option opts [Boolean] :lossless enable lossless compression
2036
+ # @option opts [Boolean] :lossless Enable lossless compression
2037
+ # @option opts [String] :profile Filename of ICC profile to embed
2039
2038
  # @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
2040
2039
  # @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
2041
2040
  # @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
2042
2041
  # @option opts [Integer] :alpha_q Change alpha plane fidelity for lossy compression
2043
- # @option opts [Boolean] :min_size Optimise for minium size
2042
+ # @option opts [Boolean] :min_size Optimise for minimum size
2044
2043
  # @option opts [Integer] :kmin Minimum number of frames between key frames
2045
2044
  # @option opts [Integer] :kmax Maximum number of frames between key frames
2046
- # @option opts [Integer] :reduction_effort Level of CPU effort to reduce file size
2047
- # @option opts [String] :profile ICC profile to embed
2048
- # @option opts [Boolean] :strip Strip all metadata from image
2045
+ # @option opts [Integer] :effort Level of CPU effort to reduce file size
2046
+ # @option opts [Boolean] :mixed Allow mixed encoding (might reduce file size)
2047
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2049
2048
  # @option opts [Array<Double>] :background Background value
2050
2049
  # @option opts [Integer] :page_height Set page height for multipage save
2051
2050
  # @return [VipsBlob] Buffer to save to
2052
2051
 
2053
2052
  # @!method webpsave_target(target, **opts)
2054
- # Save image to webp target.
2053
+ # Save as webp.
2055
2054
  # @param target [Vips::Target] Target to save to
2056
2055
  # @param opts [Hash] Set of options
2057
2056
  # @option opts [Integer] :Q Q factor
2058
- # @option opts [Boolean] :lossless enable lossless compression
2057
+ # @option opts [Boolean] :lossless Enable lossless compression
2058
+ # @option opts [String] :profile Filename of ICC profile to embed
2059
+ # @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
2060
+ # @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
2061
+ # @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
2062
+ # @option opts [Integer] :alpha_q Change alpha plane fidelity for lossy compression
2063
+ # @option opts [Boolean] :min_size Optimise for minimum size
2064
+ # @option opts [Integer] :kmin Minimum number of frames between key frames
2065
+ # @option opts [Integer] :kmax Maximum number of frames between key frames
2066
+ # @option opts [Integer] :effort Level of CPU effort to reduce file size
2067
+ # @option opts [Boolean] :mixed Allow mixed encoding (might reduce file size)
2068
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2069
+ # @option opts [Array<Double>] :background Background value
2070
+ # @option opts [Integer] :page_height Set page height for multipage save
2071
+ # @return [nil]
2072
+
2073
+ # @!method webpsave_mime(**opts)
2074
+ # Save image to webp mime.
2075
+ # @param opts [Hash] Set of options
2076
+ # @option opts [Integer] :Q Q factor
2077
+ # @option opts [Boolean] :lossless Enable lossless compression
2078
+ # @option opts [String] :profile Filename of ICC profile to embed
2059
2079
  # @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
2060
2080
  # @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
2061
2081
  # @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
2062
2082
  # @option opts [Integer] :alpha_q Change alpha plane fidelity for lossy compression
2063
- # @option opts [Boolean] :min_size Optimise for minium size
2083
+ # @option opts [Boolean] :min_size Optimise for minimum size
2064
2084
  # @option opts [Integer] :kmin Minimum number of frames between key frames
2065
2085
  # @option opts [Integer] :kmax Maximum number of frames between key frames
2066
- # @option opts [Integer] :reduction_effort Level of CPU effort to reduce file size
2067
- # @option opts [String] :profile ICC profile to embed
2068
- # @option opts [Boolean] :strip Strip all metadata from image
2086
+ # @option opts [Integer] :effort Level of CPU effort to reduce file size
2087
+ # @option opts [Boolean] :mixed Allow mixed encoding (might reduce file size)
2088
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2069
2089
  # @option opts [Array<Double>] :background Background value
2070
2090
  # @option opts [Integer] :page_height Set page height for multipage save
2071
2091
  # @return [nil]
@@ -2077,19 +2097,17 @@ module Vips
2077
2097
  # @option opts [Vips::ForeignTiffCompression] :compression Compression for this file
2078
2098
  # @option opts [Integer] :Q Q factor
2079
2099
  # @option opts [Vips::ForeignTiffPredictor] :predictor Compression prediction
2080
- # @option opts [String] :profile ICC profile to embed
2081
2100
  # @option opts [Boolean] :tile Write a tiled tiff
2082
2101
  # @option opts [Integer] :tile_width Tile width in pixels
2102
+ # @option opts [String] :profile Filename of ICC profile to embed
2083
2103
  # @option opts [Integer] :tile_height Tile height in pixels
2084
2104
  # @option opts [Boolean] :pyramid Write a pyramidal tiff
2085
- # @option opts [Boolean] :squash Squash images down to 1 bit
2086
2105
  # @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
2087
2106
  # @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
2088
2107
  # @option opts [Vips::ForeignTiffResunit] :resunit Resolution unit
2089
2108
  # @option opts [Float] :xres Horizontal resolution in pixels/mm
2090
2109
  # @option opts [Float] :yres Vertical resolution in pixels/mm
2091
2110
  # @option opts [Boolean] :bigtiff Write a bigtiff image
2092
- # @option opts [Boolean] :rgbjpeg Output RGB JPEG rather than YCbCr
2093
2111
  # @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
2094
2112
  # @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
2095
2113
  # @option opts [Integer] :level ZSTD compression level
@@ -2097,7 +2115,7 @@ module Vips
2097
2115
  # @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
2098
2116
  # @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
2099
2117
  # @option opts [Boolean] :premultiply Save with premultiplied alpha
2100
- # @option opts [Boolean] :strip Strip all metadata from image
2118
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2101
2119
  # @option opts [Array<Double>] :background Background value
2102
2120
  # @option opts [Integer] :page_height Set page height for multipage save
2103
2121
  # @return [nil]
@@ -2108,19 +2126,17 @@ module Vips
2108
2126
  # @option opts [Vips::ForeignTiffCompression] :compression Compression for this file
2109
2127
  # @option opts [Integer] :Q Q factor
2110
2128
  # @option opts [Vips::ForeignTiffPredictor] :predictor Compression prediction
2111
- # @option opts [String] :profile ICC profile to embed
2112
2129
  # @option opts [Boolean] :tile Write a tiled tiff
2113
2130
  # @option opts [Integer] :tile_width Tile width in pixels
2131
+ # @option opts [String] :profile Filename of ICC profile to embed
2114
2132
  # @option opts [Integer] :tile_height Tile height in pixels
2115
2133
  # @option opts [Boolean] :pyramid Write a pyramidal tiff
2116
- # @option opts [Boolean] :squash Squash images down to 1 bit
2117
2134
  # @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
2118
2135
  # @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
2119
2136
  # @option opts [Vips::ForeignTiffResunit] :resunit Resolution unit
2120
2137
  # @option opts [Float] :xres Horizontal resolution in pixels/mm
2121
2138
  # @option opts [Float] :yres Vertical resolution in pixels/mm
2122
2139
  # @option opts [Boolean] :bigtiff Write a bigtiff image
2123
- # @option opts [Boolean] :rgbjpeg Output RGB JPEG rather than YCbCr
2124
2140
  # @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
2125
2141
  # @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
2126
2142
  # @option opts [Integer] :level ZSTD compression level
@@ -2128,16 +2144,47 @@ module Vips
2128
2144
  # @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
2129
2145
  # @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
2130
2146
  # @option opts [Boolean] :premultiply Save with premultiplied alpha
2131
- # @option opts [Boolean] :strip Strip all metadata from image
2147
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2132
2148
  # @option opts [Array<Double>] :background Background value
2133
2149
  # @option opts [Integer] :page_height Set page height for multipage save
2134
2150
  # @return [VipsBlob] Buffer to save to
2135
2151
 
2152
+ # @!method tiffsave_target(target, **opts)
2153
+ # Save image to tiff target.
2154
+ # @param target [Vips::Target] Target to save to
2155
+ # @param opts [Hash] Set of options
2156
+ # @option opts [Vips::ForeignTiffCompression] :compression Compression for this file
2157
+ # @option opts [Integer] :Q Q factor
2158
+ # @option opts [Vips::ForeignTiffPredictor] :predictor Compression prediction
2159
+ # @option opts [Boolean] :tile Write a tiled tiff
2160
+ # @option opts [Integer] :tile_width Tile width in pixels
2161
+ # @option opts [String] :profile Filename of ICC profile to embed
2162
+ # @option opts [Integer] :tile_height Tile height in pixels
2163
+ # @option opts [Boolean] :pyramid Write a pyramidal tiff
2164
+ # @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
2165
+ # @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
2166
+ # @option opts [Vips::ForeignTiffResunit] :resunit Resolution unit
2167
+ # @option opts [Float] :xres Horizontal resolution in pixels/mm
2168
+ # @option opts [Float] :yres Vertical resolution in pixels/mm
2169
+ # @option opts [Boolean] :bigtiff Write a bigtiff image
2170
+ # @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
2171
+ # @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
2172
+ # @option opts [Integer] :level ZSTD compression level
2173
+ # @option opts [Boolean] :lossless Enable WEBP lossless mode
2174
+ # @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
2175
+ # @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
2176
+ # @option opts [Boolean] :premultiply Save with premultiplied alpha
2177
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2178
+ # @option opts [Array<Double>] :background Background value
2179
+ # @option opts [Integer] :page_height Set page height for multipage save
2180
+ # @return [nil]
2181
+
2136
2182
  # @!method fitssave(filename, **opts)
2137
2183
  # Save image to fits file.
2138
2184
  # @param filename [String] Filename to save to
2139
2185
  # @param opts [Hash] Set of options
2140
- # @option opts [Boolean] :strip Strip all metadata from image
2186
+ # @option opts [String] :profile Filename of ICC profile to embed
2187
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2141
2188
  # @option opts [Array<Double>] :background Background value
2142
2189
  # @option opts [Integer] :page_height Set page height for multipage save
2143
2190
  # @return [nil]
@@ -2146,7 +2193,8 @@ module Vips
2146
2193
  # Save image to nifti file.
2147
2194
  # @param filename [String] Filename to save to
2148
2195
  # @param opts [Hash] Set of options
2149
- # @option opts [Boolean] :strip Strip all metadata from image
2196
+ # @option opts [String] :profile Filename of ICC profile to embed
2197
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2150
2198
  # @option opts [Array<Double>] :background Background value
2151
2199
  # @option opts [Integer] :page_height Set page height for multipage save
2152
2200
  # @return [nil]
@@ -2156,11 +2204,14 @@ module Vips
2156
2204
  # @param filename [String] Filename to save to
2157
2205
  # @param opts [Hash] Set of options
2158
2206
  # @option opts [Integer] :Q Q factor
2207
+ # @option opts [Integer] :bitdepth Number of bits per pixel
2208
+ # @option opts [String] :profile Filename of ICC profile to embed
2159
2209
  # @option opts [Boolean] :lossless Enable lossless compression
2160
2210
  # @option opts [Vips::ForeignHeifCompression] :compression Compression format
2161
- # @option opts [Integer] :speed CPU effort
2211
+ # @option opts [Integer] :effort CPU effort
2162
2212
  # @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
2163
- # @option opts [Boolean] :strip Strip all metadata from image
2213
+ # @option opts [Vips::ForeignHeifEncoder] :encoder Select encoder to use
2214
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2164
2215
  # @option opts [Array<Double>] :background Background value
2165
2216
  # @option opts [Integer] :page_height Set page height for multipage save
2166
2217
  # @return [nil]
@@ -2169,11 +2220,14 @@ module Vips
2169
2220
  # Save image in heif format.
2170
2221
  # @param opts [Hash] Set of options
2171
2222
  # @option opts [Integer] :Q Q factor
2223
+ # @option opts [Integer] :bitdepth Number of bits per pixel
2224
+ # @option opts [String] :profile Filename of ICC profile to embed
2172
2225
  # @option opts [Boolean] :lossless Enable lossless compression
2173
2226
  # @option opts [Vips::ForeignHeifCompression] :compression Compression format
2174
- # @option opts [Integer] :speed CPU effort
2227
+ # @option opts [Integer] :effort CPU effort
2175
2228
  # @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
2176
- # @option opts [Boolean] :strip Strip all metadata from image
2229
+ # @option opts [Vips::ForeignHeifEncoder] :encoder Select encoder to use
2230
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2177
2231
  # @option opts [Array<Double>] :background Background value
2178
2232
  # @option opts [Integer] :page_height Set page height for multipage save
2179
2233
  # @return [VipsBlob] Buffer to save to
@@ -2183,11 +2237,58 @@ module Vips
2183
2237
  # @param target [Vips::Target] Target to save to
2184
2238
  # @param opts [Hash] Set of options
2185
2239
  # @option opts [Integer] :Q Q factor
2240
+ # @option opts [Integer] :bitdepth Number of bits per pixel
2241
+ # @option opts [String] :profile Filename of ICC profile to embed
2186
2242
  # @option opts [Boolean] :lossless Enable lossless compression
2187
2243
  # @option opts [Vips::ForeignHeifCompression] :compression Compression format
2188
- # @option opts [Integer] :speed CPU effort
2244
+ # @option opts [Integer] :effort CPU effort
2189
2245
  # @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
2190
- # @option opts [Boolean] :strip Strip all metadata from image
2246
+ # @option opts [Vips::ForeignHeifEncoder] :encoder Select encoder to use
2247
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2248
+ # @option opts [Array<Double>] :background Background value
2249
+ # @option opts [Integer] :page_height Set page height for multipage save
2250
+ # @return [nil]
2251
+
2252
+ # @!method jxlsave(filename, **opts)
2253
+ # Save image in jpeg-xl format.
2254
+ # @param filename [String] Filename to load from
2255
+ # @param opts [Hash] Set of options
2256
+ # @option opts [Integer] :tier Decode speed tier
2257
+ # @option opts [Float] :distance Target butteraugli distance
2258
+ # @option opts [String] :profile Filename of ICC profile to embed
2259
+ # @option opts [Integer] :effort Encoding effort
2260
+ # @option opts [Boolean] :lossless Enable lossless compression
2261
+ # @option opts [Integer] :Q Quality factor
2262
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2263
+ # @option opts [Array<Double>] :background Background value
2264
+ # @option opts [Integer] :page_height Set page height for multipage save
2265
+ # @return [nil]
2266
+
2267
+ # @!method jxlsave_buffer(**opts)
2268
+ # Save image in jpeg-xl format.
2269
+ # @param opts [Hash] Set of options
2270
+ # @option opts [Integer] :tier Decode speed tier
2271
+ # @option opts [Float] :distance Target butteraugli distance
2272
+ # @option opts [String] :profile Filename of ICC profile to embed
2273
+ # @option opts [Integer] :effort Encoding effort
2274
+ # @option opts [Boolean] :lossless Enable lossless compression
2275
+ # @option opts [Integer] :Q Quality factor
2276
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2277
+ # @option opts [Array<Double>] :background Background value
2278
+ # @option opts [Integer] :page_height Set page height for multipage save
2279
+ # @return [VipsBlob] Buffer to save to
2280
+
2281
+ # @!method jxlsave_target(target, **opts)
2282
+ # Save image in jpeg-xl format.
2283
+ # @param target [Vips::Target] Target to save to
2284
+ # @param opts [Hash] Set of options
2285
+ # @option opts [Integer] :tier Decode speed tier
2286
+ # @option opts [Float] :distance Target butteraugli distance
2287
+ # @option opts [String] :profile Filename of ICC profile to embed
2288
+ # @option opts [Integer] :effort Encoding effort
2289
+ # @option opts [Boolean] :lossless Enable lossless compression
2290
+ # @option opts [Integer] :Q Quality factor
2291
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2191
2292
  # @option opts [Array<Double>] :background Background value
2192
2293
  # @option opts [Integer] :page_height Set page height for multipage save
2193
2294
  # @return [nil]
@@ -2200,7 +2301,9 @@ module Vips
2200
2301
  # @option opts [Integer] :quality Quality to use
2201
2302
  # @option opts [Boolean] :optimize_gif_frames Apply GIF frames optimization
2202
2303
  # @option opts [Boolean] :optimize_gif_transparency Apply GIF transparency optimization
2203
- # @option opts [Boolean] :strip Strip all metadata from image
2304
+ # @option opts [Integer] :bitdepth Number of bits per pixel
2305
+ # @option opts [String] :profile Filename of ICC profile to embed
2306
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2204
2307
  # @option opts [Array<Double>] :background Background value
2205
2308
  # @option opts [Integer] :page_height Set page height for multipage save
2206
2309
  # @return [nil]
@@ -2212,7 +2315,9 @@ module Vips
2212
2315
  # @option opts [Integer] :quality Quality to use
2213
2316
  # @option opts [Boolean] :optimize_gif_frames Apply GIF frames optimization
2214
2317
  # @option opts [Boolean] :optimize_gif_transparency Apply GIF transparency optimization
2215
- # @option opts [Boolean] :strip Strip all metadata from image
2318
+ # @option opts [Integer] :bitdepth Number of bits per pixel
2319
+ # @option opts [String] :profile Filename of ICC profile to embed
2320
+ # @option opts [Vips::ForeignKeep] :keep Which metadata to retain
2216
2321
  # @option opts [Array<Double>] :background Background value
2217
2322
  # @option opts [Integer] :page_height Set page height for multipage save
2218
2323
  # @return [VipsBlob] Buffer to save to
@@ -2230,7 +2335,7 @@ module Vips
2230
2335
  # @option opts [String] :import_profile Fallback import profile
2231
2336
  # @option opts [String] :export_profile Fallback export profile
2232
2337
  # @option opts [Vips::Intent] :intent Rendering intent
2233
- # @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
2338
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
2234
2339
  # @return [Vips::Image] Output image
2235
2340
 
2236
2341
  # @!method self.thumbnail_buffer(buffer, width, **opts)
@@ -2247,7 +2352,7 @@ module Vips
2247
2352
  # @option opts [String] :import_profile Fallback import profile
2248
2353
  # @option opts [String] :export_profile Fallback export profile
2249
2354
  # @option opts [Vips::Intent] :intent Rendering intent
2250
- # @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
2355
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
2251
2356
  # @return [Vips::Image] Output image
2252
2357
 
2253
2358
  # @!method thumbnail_image(width, **opts)
@@ -2262,7 +2367,7 @@ module Vips
2262
2367
  # @option opts [String] :import_profile Fallback import profile
2263
2368
  # @option opts [String] :export_profile Fallback export profile
2264
2369
  # @option opts [Vips::Intent] :intent Rendering intent
2265
- # @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
2370
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
2266
2371
  # @return [Vips::Image] Output image
2267
2372
 
2268
2373
  # @!method self.thumbnail_source(source, width, **opts)
@@ -2279,7 +2384,7 @@ module Vips
2279
2384
  # @option opts [String] :import_profile Fallback import profile
2280
2385
  # @option opts [String] :export_profile Fallback export profile
2281
2386
  # @option opts [Vips::Intent] :intent Rendering intent
2282
- # @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
2387
+ # @option opts [Vips::FailOn] :fail_on Error level to fail on
2283
2388
  # @return [Vips::Image] Output image
2284
2389
 
2285
2390
  # @!method mapim(index, **opts)
@@ -2287,6 +2392,9 @@ module Vips
2287
2392
  # @param index [Vips::Image] Index pixels with this
2288
2393
  # @param opts [Hash] Set of options
2289
2394
  # @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
2395
+ # @option opts [Array<Double>] :background Background value
2396
+ # @option opts [Boolean] :premultiplied Images have premultiplied alpha
2397
+ # @option opts [Vips::Extend] :extend How to generate the extra pixels
2290
2398
  # @return [Vips::Image] Output image
2291
2399
 
2292
2400
  # @!method shrink(hshrink, vshrink, **opts)
@@ -2294,40 +2402,37 @@ module Vips
2294
2402
  # @param hshrink [Float] Horizontal shrink factor
2295
2403
  # @param vshrink [Float] Vertical shrink factor
2296
2404
  # @param opts [Hash] Set of options
2297
- # @option opts [Float] :xshrink Horizontal shrink factor
2298
- # @option opts [Float] :yshrink Vertical shrink factor
2405
+ # @option opts [Boolean] :ceil Round-up output dimensions
2299
2406
  # @return [Vips::Image] Output image
2300
2407
 
2301
2408
  # @!method shrinkh(hshrink, **opts)
2302
2409
  # Shrink an image horizontally.
2303
2410
  # @param hshrink [Integer] Horizontal shrink factor
2304
2411
  # @param opts [Hash] Set of options
2305
- # @option opts [Integer] :xshrink Horizontal shrink factor
2412
+ # @option opts [Boolean] :ceil Round-up output dimensions
2306
2413
  # @return [Vips::Image] Output image
2307
2414
 
2308
2415
  # @!method shrinkv(vshrink, **opts)
2309
2416
  # Shrink an image vertically.
2310
2417
  # @param vshrink [Integer] Vertical shrink factor
2311
2418
  # @param opts [Hash] Set of options
2312
- # @option opts [Integer] :yshrink Vertical shrink factor
2419
+ # @option opts [Boolean] :ceil Round-up output dimensions
2313
2420
  # @return [Vips::Image] Output image
2314
2421
 
2315
2422
  # @!method reduceh(hshrink, **opts)
2316
2423
  # Shrink an image horizontally.
2317
2424
  # @param hshrink [Float] Horizontal shrink factor
2318
2425
  # @param opts [Hash] Set of options
2319
- # @option opts [Float] :xshrink Horizontal shrink factor
2320
2426
  # @option opts [Vips::Kernel] :kernel Resampling kernel
2321
- # @option opts [Boolean] :centre Use centre sampling convention
2427
+ # @option opts [Float] :gap Reducing gap
2322
2428
  # @return [Vips::Image] Output image
2323
2429
 
2324
2430
  # @!method reducev(vshrink, **opts)
2325
2431
  # Shrink an image vertically.
2326
2432
  # @param vshrink [Float] Vertical shrink factor
2327
2433
  # @param opts [Hash] Set of options
2328
- # @option opts [Float] :yshrink Vertical shrink factor
2329
2434
  # @option opts [Vips::Kernel] :kernel Resampling kernel
2330
- # @option opts [Boolean] :centre Use centre sampling convention
2435
+ # @option opts [Float] :gap Reducing gap
2331
2436
  # @return [Vips::Image] Output image
2332
2437
 
2333
2438
  # @!method reduce(hshrink, vshrink, **opts)
@@ -2336,9 +2441,7 @@ module Vips
2336
2441
  # @param vshrink [Float] Vertical shrink factor
2337
2442
  # @param opts [Hash] Set of options
2338
2443
  # @option opts [Vips::Kernel] :kernel Resampling kernel
2339
- # @option opts [Boolean] :centre Use centre sampling convention
2340
- # @option opts [Float] :xshrink Horizontal shrink factor
2341
- # @option opts [Float] :yshrink Vertical shrink factor
2444
+ # @option opts [Float] :gap Reducing gap
2342
2445
  # @return [Vips::Image] Output image
2343
2446
 
2344
2447
  # @!method quadratic(coeff, **opts)
@@ -2392,12 +2495,9 @@ module Vips
2392
2495
  # Resize an image.
2393
2496
  # @param scale [Float] Scale image by this factor
2394
2497
  # @param opts [Hash] Set of options
2395
- # @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
2396
2498
  # @option opts [Vips::Kernel] :kernel Resampling kernel
2397
- # @option opts [Boolean] :centre Use centre sampling convention
2499
+ # @option opts [Float] :gap Reducing gap
2398
2500
  # @option opts [Float] :vscale Vertical scale image by this factor
2399
- # @option opts [Float] :idx Horizontal input displacement
2400
- # @option opts [Float] :idy Vertical input displacement
2401
2501
  # @return [Vips::Image] Output image
2402
2502
 
2403
2503
  # @!method colourspace(space, **opts)
@@ -2449,16 +2549,6 @@ module Vips
2449
2549
  # @param opts [Hash] Set of options
2450
2550
  # @return [Vips::Image] Output image
2451
2551
 
2452
- # @!method scRGB2XYZ(**opts)
2453
- # Transform scrgb to xyz.
2454
- # @param opts [Hash] Set of options
2455
- # @return [Vips::Image] Output image
2456
-
2457
- # @!method XYZ2scRGB(**opts)
2458
- # Transform xyz to scrgb.
2459
- # @param opts [Hash] Set of options
2460
- # @return [Vips::Image] Output image
2461
-
2462
2552
  # @!method LabQ2Lab(**opts)
2463
2553
  # Unpack a labq image to float lab.
2464
2554
  # @param opts [Hash] Set of options
@@ -2569,12 +2659,22 @@ module Vips
2569
2659
  # @param opts [Hash] Set of options
2570
2660
  # @return [Vips::Image] Output image
2571
2661
 
2662
+ # @!method scRGB2XYZ(**opts)
2663
+ # Transform scrgb to xyz.
2664
+ # @param opts [Hash] Set of options
2665
+ # @return [Vips::Image] Output image
2666
+
2572
2667
  # @!method scRGB2BW(**opts)
2573
2668
  # Convert scrgb to bw.
2574
2669
  # @param opts [Hash] Set of options
2575
2670
  # @option opts [Integer] :depth Output device space depth in bits
2576
2671
  # @return [Vips::Image] Output image
2577
2672
 
2673
+ # @!method XYZ2scRGB(**opts)
2674
+ # Transform xyz to scrgb.
2675
+ # @param opts [Hash] Set of options
2676
+ # @return [Vips::Image] Output image
2677
+
2578
2678
  # @!method scRGB2sRGB(**opts)
2579
2679
  # Convert an scrgb image to srgb.
2580
2680
  # @param opts [Hash] Set of options
@@ -2601,7 +2701,7 @@ module Vips
2601
2701
  # Map an image though a lut.
2602
2702
  # @param lut [Vips::Image] Look-up table image
2603
2703
  # @param opts [Hash] Set of options
2604
- # @option opts [Integer] :band apply one-band lut to this band of in
2704
+ # @option opts [Integer] :band Apply one-band lut to this band of in
2605
2705
  # @return [Vips::Image] Output image
2606
2706
 
2607
2707
  # @!method case(cases, **opts)
@@ -2714,7 +2814,7 @@ module Vips
2714
2814
  # @return [Vips::Image] Output image
2715
2815
 
2716
2816
  # @!method convsep(mask, **opts)
2717
- # Seperable convolution operation.
2817
+ # Separable convolution operation.
2718
2818
  # @param mask [Vips::Image] Input matrix image
2719
2819
  # @param opts [Hash] Set of options
2720
2820
  # @option opts [Vips::Precision] :precision Convolve with this precision
@@ -2744,7 +2844,6 @@ module Vips
2744
2844
  # @!method sharpen(**opts)
2745
2845
  # Unsharp masking for print.
2746
2846
  # @param opts [Hash] Set of options
2747
- # @option opts [Integer] :radius radius of Gaussian
2748
2847
  # @option opts [Float] :sigma Sigma of Gaussian
2749
2848
  # @option opts [Float] :x1 Flat/jaggy threshold
2750
2849
  # @option opts [Float] :y2 Maximum brightening
@@ -2761,6 +2860,21 @@ module Vips
2761
2860
  # @option opts [Vips::Precision] :precision Convolve with this precision
2762
2861
  # @return [Vips::Image] Output image
2763
2862
 
2863
+ # @!method sobel(**opts)
2864
+ # Sobel edge detector.
2865
+ # @param opts [Hash] Set of options
2866
+ # @return [Vips::Image] Output image
2867
+
2868
+ # @!method scharr(**opts)
2869
+ # Scharr edge detector.
2870
+ # @param opts [Hash] Set of options
2871
+ # @return [Vips::Image] Output image
2872
+
2873
+ # @!method prewitt(**opts)
2874
+ # Prewitt edge detector.
2875
+ # @param opts [Hash] Set of options
2876
+ # @return [Vips::Image] Output image
2877
+
2764
2878
  # @!method canny(**opts)
2765
2879
  # Canny edge detector.
2766
2880
  # @param opts [Hash] Set of options
@@ -2768,11 +2882,6 @@ module Vips
2768
2882
  # @option opts [Vips::Precision] :precision Convolve with this precision
2769
2883
  # @return [Vips::Image] Output image
2770
2884
 
2771
- # @!method sobel(**opts)
2772
- # Sobel edge detector.
2773
- # @param opts [Hash] Set of options
2774
- # @return [Vips::Image] Output image
2775
-
2776
2885
  # @!method fwfft(**opts)
2777
2886
  # Forward fft.
2778
2887
  # @param opts [Hash] Set of options
@@ -2825,7 +2934,7 @@ module Vips
2825
2934
  # @!method labelregions(**opts)
2826
2935
  # Label regions in an image.
2827
2936
  # @param opts [Hash] Set of options
2828
- # @option opts [Integer] :segments Output Number of discrete contigious regions
2937
+ # @option opts [Integer] :segments Output Number of discrete contiguous regions
2829
2938
  # @return [Vips::Image, Hash<Symbol => Object>] Mask of region labels, Hash of optional output items
2830
2939
 
2831
2940
  # @!method fill_nearest(**opts)
@@ -2883,9 +2992,9 @@ module Vips
2883
2992
  # @option opts [Vips::Image] :test Test pixels in this image
2884
2993
  # @option opts [Boolean] :equal DrawFlood while equal to edge
2885
2994
  # @option opts [Integer] :left Output Left edge of modified area
2886
- # @option opts [Integer] :top Output top edge of modified area
2887
- # @option opts [Integer] :width Output width of modified area
2888
- # @option opts [Integer] :height Output height of modified area
2995
+ # @option opts [Integer] :top Output Top edge of modified area
2996
+ # @option opts [Integer] :width Output Width of modified area
2997
+ # @option opts [Integer] :height Output Height of modified area
2889
2998
  # @return [Vips::Image, Hash<Symbol => Object>] Image to draw on, Hash of optional output items
2890
2999
 
2891
3000
  # @!method draw_image(sub, x, y, **opts)
@@ -2955,7 +3064,6 @@ module Vips
2955
3064
  # @option opts [Boolean] :search Search to improve tie-points
2956
3065
  # @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
2957
3066
  # @option opts [Integer] :mblend Maximum blend size
2958
- # @option opts [Integer] :bandno Band to search for features on
2959
3067
  # @return [Vips::Image] Output image
2960
3068
 
2961
3069
  # @!method matrixinvert(**opts)