ruby-vips 2.1.4 → 2.2.1
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.
- checksums.yaml +4 -4
- data/.github/dependabot.yml +6 -0
- data/.github/workflows/test.yml +12 -11
- data/CHANGELOG.md +19 -0
- data/README.md +18 -18
- data/TODO +1 -2
- data/VERSION +1 -1
- data/example/revalidate.rb +39 -0
- data/lib/vips/image.rb +10 -3
- data/lib/vips/interpolate.rb +3 -3
- data/lib/vips/methods.rb +544 -325
- data/lib/vips/mutableimage.rb +8 -1
- data/lib/vips/operation.rb +16 -11
- data/lib/vips/region.rb +3 -3
- data/lib/vips/sourcecustom.rb +1 -1
- data/lib/vips/targetcustom.rb +1 -1
- data/lib/vips/version.rb +1 -1
- data/lib/vips.rb +110 -2
- metadata +8 -6
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]
|
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]
|
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]
|
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]
|
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]
|
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]
|
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]
|
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]
|
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]
|
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]
|
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]
|
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
|
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,6 +260,7 @@ 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)
|
@@ -324,7 +325,7 @@ module Vips
|
|
324
325
|
|
325
326
|
# @!method gravity(direction, width, height, **opts)
|
326
327
|
# Place an image within a larger image with a certain gravity.
|
327
|
-
# @param direction [Vips::CompassDirection]
|
328
|
+
# @param direction [Vips::CompassDirection] Direction to place image within width/height
|
328
329
|
# @param width [Integer] Image width in pixels
|
329
330
|
# @param height [Integer] Image height in pixels
|
330
331
|
# @param opts [Hash] Set of options
|
@@ -396,7 +397,10 @@ module Vips
|
|
396
397
|
# @param height [Integer] Height of extract area
|
397
398
|
# @param opts [Hash] Set of options
|
398
399
|
# @option opts [Vips::Interesting] :interesting How to measure interestingness
|
399
|
-
# @
|
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
|
400
404
|
|
401
405
|
# @!method extract_band(band, **opts)
|
402
406
|
# Extract band from an image.
|
@@ -425,7 +429,7 @@ module Vips
|
|
425
429
|
|
426
430
|
# @!method bandbool(boolean, **opts)
|
427
431
|
# Boolean operation across image bands.
|
428
|
-
# @param boolean [Vips::OperationBoolean]
|
432
|
+
# @param boolean [Vips::OperationBoolean] Boolean to perform
|
429
433
|
# @param opts [Hash] Set of options
|
430
434
|
# @return [Vips::Image] Output image
|
431
435
|
|
@@ -464,7 +468,7 @@ module Vips
|
|
464
468
|
|
465
469
|
# @!method recomb(m, **opts)
|
466
470
|
# Linear recombination with matrix.
|
467
|
-
# @param m [Vips::Image]
|
471
|
+
# @param m [Vips::Image] Matrix of coefficients
|
468
472
|
# @param opts [Hash] Set of options
|
469
473
|
# @return [Vips::Image] Output image
|
470
474
|
|
@@ -502,9 +506,9 @@ module Vips
|
|
502
506
|
|
503
507
|
# @!method grid(tile_height, across, down, **opts)
|
504
508
|
# Grid an image.
|
505
|
-
# @param tile_height [Integer]
|
506
|
-
# @param across [Integer]
|
507
|
-
# @param down [Integer]
|
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
|
508
512
|
# @param opts [Hash] Set of options
|
509
513
|
# @return [Vips::Image] Output image
|
510
514
|
|
@@ -608,10 +612,10 @@ module Vips
|
|
608
612
|
|
609
613
|
# @!method self.logmat(sigma, min_ampl, **opts)
|
610
614
|
# Make a laplacian of gaussian image.
|
611
|
-
# @param sigma [Float] Radius of
|
612
|
-
# @param min_ampl [Float] Minimum amplitude of
|
615
|
+
# @param sigma [Float] Radius of Gaussian
|
616
|
+
# @param min_ampl [Float] Minimum amplitude of Gaussian
|
613
617
|
# @param opts [Hash] Set of options
|
614
|
-
# @option opts [Boolean] :separable Generate separable
|
618
|
+
# @option opts [Boolean] :separable Generate separable Gaussian
|
615
619
|
# @option opts [Vips::Precision] :precision Generate with this precision
|
616
620
|
# @return [Vips::Image] Output image
|
617
621
|
|
@@ -623,11 +627,12 @@ module Vips
|
|
623
627
|
# @option opts [Integer] :width Maximum image width in pixels
|
624
628
|
# @option opts [Integer] :height Maximum image height in pixels
|
625
629
|
# @option opts [Vips::Align] :align Align on the low, centre or high edge
|
626
|
-
# @option opts [Boolean] :rgba Enable RGBA output
|
627
|
-
# @option opts [Integer] :dpi DPI to render at
|
628
630
|
# @option opts [Boolean] :justify Justify lines
|
631
|
+
# @option opts [Integer] :dpi DPI to render at
|
629
632
|
# @option opts [Integer] :spacing Line spacing
|
630
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
|
631
636
|
# @option opts [Integer] :autofit_dpi Output DPI selected by autofit
|
632
637
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
633
638
|
|
@@ -697,7 +702,7 @@ module Vips
|
|
697
702
|
# @param height [Integer] Image height in pixels
|
698
703
|
# @param frequency_cutoff_x [Float] Frequency cutoff x
|
699
704
|
# @param frequency_cutoff_y [Float] Frequency cutoff y
|
700
|
-
# @param radius [Float]
|
705
|
+
# @param radius [Float] Radius of circle
|
701
706
|
# @param opts [Hash] Set of options
|
702
707
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
703
708
|
# @option opts [Boolean] :nodc Remove DC component
|
@@ -741,7 +746,7 @@ module Vips
|
|
741
746
|
# @param order [Float] Filter order
|
742
747
|
# @param frequency_cutoff_x [Float] Frequency cutoff x
|
743
748
|
# @param frequency_cutoff_y [Float] Frequency cutoff y
|
744
|
-
# @param radius [Float]
|
749
|
+
# @param radius [Float] Radius of circle
|
745
750
|
# @param amplitude_cutoff [Float] Amplitude cutoff
|
746
751
|
# @param opts [Hash] Set of options
|
747
752
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
@@ -783,7 +788,7 @@ module Vips
|
|
783
788
|
# @param height [Integer] Image height in pixels
|
784
789
|
# @param frequency_cutoff_x [Float] Frequency cutoff x
|
785
790
|
# @param frequency_cutoff_y [Float] Frequency cutoff y
|
786
|
-
# @param radius [Float]
|
791
|
+
# @param radius [Float] Radius of circle
|
787
792
|
# @param amplitude_cutoff [Float] Amplitude cutoff
|
788
793
|
# @param opts [Hash] Set of options
|
789
794
|
# @option opts [Boolean] :uchar Output an unsigned char image
|
@@ -882,6 +887,7 @@ module Vips
|
|
882
887
|
# @option opts [Boolean] :memory Force open via memory
|
883
888
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
884
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
|
885
891
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
886
892
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
887
893
|
|
@@ -896,6 +902,7 @@ module Vips
|
|
896
902
|
# @option opts [Boolean] :memory Force open via memory
|
897
903
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
898
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
|
899
906
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
900
907
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
901
908
|
|
@@ -906,6 +913,7 @@ module Vips
|
|
906
913
|
# @option opts [Boolean] :memory Force open via memory
|
907
914
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
908
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
|
909
917
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
910
918
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
911
919
|
|
@@ -916,6 +924,7 @@ module Vips
|
|
916
924
|
# @option opts [Boolean] :memory Force open via memory
|
917
925
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
918
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
|
919
928
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
920
929
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
921
930
|
|
@@ -932,6 +941,7 @@ module Vips
|
|
932
941
|
# @option opts [Boolean] :memory Force open via memory
|
933
942
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
934
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
|
935
945
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
936
946
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
937
947
|
|
@@ -942,6 +952,7 @@ module Vips
|
|
942
952
|
# @option opts [Boolean] :memory Force open via memory
|
943
953
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
944
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
|
945
956
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
946
957
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
947
958
|
|
@@ -952,6 +963,7 @@ module Vips
|
|
952
963
|
# @option opts [Boolean] :memory Force open via memory
|
953
964
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
954
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
|
955
967
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
956
968
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
957
969
|
|
@@ -962,6 +974,7 @@ module Vips
|
|
962
974
|
# @option opts [Boolean] :memory Force open via memory
|
963
975
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
964
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
|
965
978
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
966
979
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
967
980
|
|
@@ -972,6 +985,7 @@ module Vips
|
|
972
985
|
# @option opts [Boolean] :memory Force open via memory
|
973
986
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
974
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
|
975
989
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
976
990
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
977
991
|
|
@@ -982,6 +996,7 @@ module Vips
|
|
982
996
|
# @option opts [Boolean] :memory Force open via memory
|
983
997
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
984
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
|
985
1000
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
986
1001
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
987
1002
|
|
@@ -992,6 +1007,7 @@ module Vips
|
|
992
1007
|
# @option opts [Boolean] :memory Force open via memory
|
993
1008
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
994
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
|
995
1011
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
996
1012
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
997
1013
|
|
@@ -1002,6 +1018,7 @@ module Vips
|
|
1002
1018
|
# @option opts [Boolean] :memory Force open via memory
|
1003
1019
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1004
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
|
1005
1022
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1006
1023
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1007
1024
|
|
@@ -1012,51 +1029,7 @@ module Vips
|
|
1012
1029
|
# @option opts [Boolean] :memory Force open via memory
|
1013
1030
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1014
1031
|
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1015
|
-
# @option opts [
|
1016
|
-
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1017
|
-
|
1018
|
-
# @!method self.pdfload(filename, **opts)
|
1019
|
-
# Load pdf from file.
|
1020
|
-
# @param filename [String] Filename to load from
|
1021
|
-
# @param opts [Hash] Set of options
|
1022
|
-
# @option opts [Integer] :page Load this page from the file
|
1023
|
-
# @option opts [Integer] :n Load this many pages
|
1024
|
-
# @option opts [Float] :dpi Render at this DPI
|
1025
|
-
# @option opts [Float] :scale Scale output by this factor
|
1026
|
-
# @option opts [Array<Double>] :background Background value
|
1027
|
-
# @option opts [Boolean] :memory Force open via memory
|
1028
|
-
# @option opts [Vips::Access] :access Required access pattern for this file
|
1029
|
-
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1030
|
-
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1031
|
-
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1032
|
-
|
1033
|
-
# @!method self.pdfload_buffer(buffer, **opts)
|
1034
|
-
# Load pdf from buffer.
|
1035
|
-
# @param buffer [VipsBlob] Buffer to load from
|
1036
|
-
# @param opts [Hash] Set of options
|
1037
|
-
# @option opts [Integer] :page Load this page from the file
|
1038
|
-
# @option opts [Integer] :n Load this many pages
|
1039
|
-
# @option opts [Float] :dpi Render at this DPI
|
1040
|
-
# @option opts [Float] :scale Scale output by this factor
|
1041
|
-
# @option opts [Array<Double>] :background Background value
|
1042
|
-
# @option opts [Boolean] :memory Force open via memory
|
1043
|
-
# @option opts [Vips::Access] :access Required access pattern for this file
|
1044
|
-
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1045
|
-
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1046
|
-
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1047
|
-
|
1048
|
-
# @!method self.pdfload_source(source, **opts)
|
1049
|
-
# Load pdf from source.
|
1050
|
-
# @param source [Vips::Source] Source to load from
|
1051
|
-
# @param opts [Hash] Set of options
|
1052
|
-
# @option opts [Integer] :page Load this page from the file
|
1053
|
-
# @option opts [Integer] :n Load this many pages
|
1054
|
-
# @option opts [Float] :dpi Render at this DPI
|
1055
|
-
# @option opts [Float] :scale Scale output by this factor
|
1056
|
-
# @option opts [Array<Double>] :background Background value
|
1057
|
-
# @option opts [Boolean] :memory Force open via memory
|
1058
|
-
# @option opts [Vips::Access] :access Required access pattern for this file
|
1059
|
-
# @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
|
1060
1033
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1061
1034
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1062
1035
|
|
@@ -1070,6 +1043,7 @@ module Vips
|
|
1070
1043
|
# @option opts [Boolean] :memory Force open via memory
|
1071
1044
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1072
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
|
1073
1047
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1074
1048
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1075
1049
|
|
@@ -1083,6 +1057,7 @@ module Vips
|
|
1083
1057
|
# @option opts [Boolean] :memory Force open via memory
|
1084
1058
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1085
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
|
1086
1061
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1087
1062
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1088
1063
|
|
@@ -1096,36 +1071,7 @@ module Vips
|
|
1096
1071
|
# @option opts [Boolean] :memory Force open via memory
|
1097
1072
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1098
1073
|
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1099
|
-
# @option opts [
|
1100
|
-
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1101
|
-
|
1102
|
-
# @!method self.jxlload(filename, **opts)
|
1103
|
-
# Load jpeg-xl image.
|
1104
|
-
# @param filename [String] Filename to load from
|
1105
|
-
# @param opts [Hash] Set of options
|
1106
|
-
# @option opts [Boolean] :memory Force open via memory
|
1107
|
-
# @option opts [Vips::Access] :access Required access pattern for this file
|
1108
|
-
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1109
|
-
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1110
|
-
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1111
|
-
|
1112
|
-
# @!method self.jxlload_buffer(buffer, **opts)
|
1113
|
-
# Load jpeg-xl image.
|
1114
|
-
# @param buffer [VipsBlob] Buffer to load from
|
1115
|
-
# @param opts [Hash] Set of options
|
1116
|
-
# @option opts [Boolean] :memory Force open via memory
|
1117
|
-
# @option opts [Vips::Access] :access Required access pattern for this file
|
1118
|
-
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1119
|
-
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1120
|
-
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1121
|
-
|
1122
|
-
# @!method self.jxlload_source(source, **opts)
|
1123
|
-
# Load jpeg-xl image.
|
1124
|
-
# @param source [Vips::Source] Source to load from
|
1125
|
-
# @param opts [Hash] Set of options
|
1126
|
-
# @option opts [Boolean] :memory Force open via memory
|
1127
|
-
# @option opts [Vips::Access] :access Required access pattern for this file
|
1128
|
-
# @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
|
1129
1075
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1130
1076
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1131
1077
|
|
@@ -1137,6 +1083,7 @@ module Vips
|
|
1137
1083
|
# @option opts [Boolean] :memory Force open via memory
|
1138
1084
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1139
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
|
|
@@ -1148,6 +1095,7 @@ module Vips
|
|
1148
1095
|
# @option opts [Boolean] :memory Force open via memory
|
1149
1096
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1150
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
|
1151
1099
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1152
1100
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1153
1101
|
|
@@ -1159,6 +1107,7 @@ module Vips
|
|
1159
1107
|
# @option opts [Boolean] :memory Force open via memory
|
1160
1108
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1161
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
|
1162
1111
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1163
1112
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1164
1113
|
|
@@ -1166,11 +1115,12 @@ module Vips
|
|
1166
1115
|
# Load gif with libnsgif.
|
1167
1116
|
# @param filename [String] Filename to load from
|
1168
1117
|
# @param opts [Hash] Set of options
|
1169
|
-
# @option opts [Integer] :n
|
1170
|
-
# @option opts [Integer] :page
|
1118
|
+
# @option opts [Integer] :n Number of pages to load, -1 for all
|
1119
|
+
# @option opts [Integer] :page First page to load
|
1171
1120
|
# @option opts [Boolean] :memory Force open via memory
|
1172
1121
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1173
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
|
1174
1124
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1175
1125
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1176
1126
|
|
@@ -1178,11 +1128,12 @@ module Vips
|
|
1178
1128
|
# Load gif with libnsgif.
|
1179
1129
|
# @param buffer [VipsBlob] Buffer to load from
|
1180
1130
|
# @param opts [Hash] Set of options
|
1181
|
-
# @option opts [Integer] :n
|
1182
|
-
# @option opts [Integer] :page
|
1131
|
+
# @option opts [Integer] :n Number of pages to load, -1 for all
|
1132
|
+
# @option opts [Integer] :page First page to load
|
1183
1133
|
# @option opts [Boolean] :memory Force open via memory
|
1184
1134
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1185
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
|
1186
1137
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1187
1138
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1188
1139
|
|
@@ -1190,11 +1141,12 @@ module Vips
|
|
1190
1141
|
# Load gif from source.
|
1191
1142
|
# @param source [Vips::Source] Source to load from
|
1192
1143
|
# @param opts [Hash] Set of options
|
1193
|
-
# @option opts [Integer] :n
|
1194
|
-
# @option opts [Integer] :page
|
1144
|
+
# @option opts [Integer] :n Number of pages to load, -1 for all
|
1145
|
+
# @option opts [Integer] :page First page to load
|
1195
1146
|
# @option opts [Boolean] :memory Force open via memory
|
1196
1147
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1197
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
|
1198
1150
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1199
1151
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1200
1152
|
|
@@ -1206,6 +1158,7 @@ module Vips
|
|
1206
1158
|
# @option opts [Boolean] :memory Force open via memory
|
1207
1159
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1208
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
|
1209
1162
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1210
1163
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1211
1164
|
|
@@ -1217,6 +1170,7 @@ module Vips
|
|
1217
1170
|
# @option opts [Boolean] :memory Force open via memory
|
1218
1171
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1219
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
|
1220
1174
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1221
1175
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1222
1176
|
|
@@ -1228,6 +1182,7 @@ module Vips
|
|
1228
1182
|
# @option opts [Boolean] :memory Force open via memory
|
1229
1183
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1230
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
|
1231
1186
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1232
1187
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1233
1188
|
|
@@ -1238,6 +1193,7 @@ module Vips
|
|
1238
1193
|
# @option opts [Boolean] :memory Force open via memory
|
1239
1194
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1240
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
|
1241
1197
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1242
1198
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1243
1199
|
|
@@ -1247,9 +1203,11 @@ module Vips
|
|
1247
1203
|
# @param opts [Hash] Set of options
|
1248
1204
|
# @option opts [Integer] :shrink Shrink factor on load
|
1249
1205
|
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1206
|
+
# @option opts [Boolean] :unlimited Remove all denial of service limits
|
1250
1207
|
# @option opts [Boolean] :memory Force open via memory
|
1251
1208
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1252
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
|
1253
1211
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1254
1212
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1255
1213
|
|
@@ -1259,9 +1217,11 @@ module Vips
|
|
1259
1217
|
# @param opts [Hash] Set of options
|
1260
1218
|
# @option opts [Integer] :shrink Shrink factor on load
|
1261
1219
|
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1220
|
+
# @option opts [Boolean] :unlimited Remove all denial of service limits
|
1262
1221
|
# @option opts [Boolean] :memory Force open via memory
|
1263
1222
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1264
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
|
1265
1225
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1266
1226
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1267
1227
|
|
@@ -1271,9 +1231,11 @@ module Vips
|
|
1271
1231
|
# @param opts [Hash] Set of options
|
1272
1232
|
# @option opts [Integer] :shrink Shrink factor on load
|
1273
1233
|
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1234
|
+
# @option opts [Boolean] :unlimited Remove all denial of service limits
|
1274
1235
|
# @option opts [Boolean] :memory Force open via memory
|
1275
1236
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1276
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
|
1277
1239
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1278
1240
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1279
1241
|
|
@@ -1281,12 +1243,13 @@ module Vips
|
|
1281
1243
|
# Load webp from file.
|
1282
1244
|
# @param filename [String] Filename to load from
|
1283
1245
|
# @param opts [Hash] Set of options
|
1284
|
-
# @option opts [Integer] :page
|
1285
|
-
# @option opts [Integer] :n
|
1286
|
-
# @option opts [Float] :scale
|
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
|
1287
1249
|
# @option opts [Boolean] :memory Force open via memory
|
1288
1250
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1289
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
|
1290
1253
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1291
1254
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1292
1255
|
|
@@ -1294,12 +1257,13 @@ module Vips
|
|
1294
1257
|
# Load webp from buffer.
|
1295
1258
|
# @param buffer [VipsBlob] Buffer to load from
|
1296
1259
|
# @param opts [Hash] Set of options
|
1297
|
-
# @option opts [Integer] :page
|
1298
|
-
# @option opts [Integer] :n
|
1299
|
-
# @option opts [Float] :scale
|
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
|
1300
1263
|
# @option opts [Boolean] :memory Force open via memory
|
1301
1264
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1302
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
|
1303
1267
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1304
1268
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1305
1269
|
|
@@ -1307,12 +1271,13 @@ module Vips
|
|
1307
1271
|
# Load webp from source.
|
1308
1272
|
# @param source [Vips::Source] Source to load from
|
1309
1273
|
# @param opts [Hash] Set of options
|
1310
|
-
# @option opts [Integer] :page
|
1311
|
-
# @option opts [Integer] :n
|
1312
|
-
# @option opts [Float] :scale
|
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
|
1313
1277
|
# @option opts [Boolean] :memory Force open via memory
|
1314
1278
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1315
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
|
1316
1281
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1317
1282
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1318
1283
|
|
@@ -1320,13 +1285,14 @@ module Vips
|
|
1320
1285
|
# Load tiff from file.
|
1321
1286
|
# @param filename [String] Filename to load from
|
1322
1287
|
# @param opts [Hash] Set of options
|
1323
|
-
# @option opts [Integer] :page
|
1324
|
-
# @option opts [Integer] :subifd
|
1325
|
-
# @option opts [Integer] :n
|
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
|
1326
1291
|
# @option opts [Boolean] :autorotate Rotate image using orientation tag
|
1327
1292
|
# @option opts [Boolean] :memory Force open via memory
|
1328
1293
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1329
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
|
1330
1296
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1331
1297
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1332
1298
|
|
@@ -1334,13 +1300,14 @@ module Vips
|
|
1334
1300
|
# Load tiff from buffer.
|
1335
1301
|
# @param buffer [VipsBlob] Buffer to load from
|
1336
1302
|
# @param opts [Hash] Set of options
|
1337
|
-
# @option opts [Integer] :page
|
1338
|
-
# @option opts [Integer] :subifd
|
1339
|
-
# @option opts [Integer] :n
|
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
|
1340
1306
|
# @option opts [Boolean] :autorotate Rotate image using orientation tag
|
1341
1307
|
# @option opts [Boolean] :memory Force open via memory
|
1342
1308
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1343
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
|
1344
1311
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1345
1312
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1346
1313
|
|
@@ -1348,13 +1315,69 @@ module Vips
|
|
1348
1315
|
# Load tiff from source.
|
1349
1316
|
# @param source [Vips::Source] Source to load from
|
1350
1317
|
# @param opts [Hash] Set of options
|
1351
|
-
# @option opts [Integer] :page
|
1352
|
-
# @option opts [Integer] :subifd
|
1353
|
-
# @option opts [Integer] :n
|
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
|
1354
1321
|
# @option opts [Boolean] :autorotate Rotate image using orientation tag
|
1355
1322
|
# @option opts [Boolean] :memory Force open via memory
|
1356
1323
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1357
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
|
1326
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1327
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1328
|
+
|
1329
|
+
# @!method self.fitsload(filename, **opts)
|
1330
|
+
# Load a fits image.
|
1331
|
+
# @param filename [String] Filename to load from
|
1332
|
+
# @param opts [Hash] Set of options
|
1333
|
+
# @option opts [Boolean] :memory Force open via memory
|
1334
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
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
|
1337
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1338
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1339
|
+
|
1340
|
+
# @!method self.fitsload_source(source, **opts)
|
1341
|
+
# Load fits from a source.
|
1342
|
+
# @param source [Vips::Source] Source to load from
|
1343
|
+
# @param opts [Hash] Set of options
|
1344
|
+
# @option opts [Boolean] :memory Force open via memory
|
1345
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
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
|
1348
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1349
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1350
|
+
|
1351
|
+
# @!method self.openexrload(filename, **opts)
|
1352
|
+
# Load an openexr image.
|
1353
|
+
# @param filename [String] Filename to load from
|
1354
|
+
# @param opts [Hash] Set of options
|
1355
|
+
# @option opts [Boolean] :memory Force open via memory
|
1356
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
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
|
1359
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1360
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1361
|
+
|
1362
|
+
# @!method self.niftiload(filename, **opts)
|
1363
|
+
# Load nifti volume.
|
1364
|
+
# @param filename [String] Filename to load from
|
1365
|
+
# @param opts [Hash] Set of options
|
1366
|
+
# @option opts [Boolean] :memory Force open via memory
|
1367
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
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
|
1370
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1371
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1372
|
+
|
1373
|
+
# @!method self.niftiload_source(source, **opts)
|
1374
|
+
# Load nifti volumes.
|
1375
|
+
# @param source [Vips::Source] Source to load from
|
1376
|
+
# @param opts [Hash] Set of options
|
1377
|
+
# @option opts [Boolean] :memory Force open via memory
|
1378
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
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
|
1358
1381
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1359
1382
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1360
1383
|
|
@@ -1362,13 +1385,15 @@ module Vips
|
|
1362
1385
|
# Load file with openslide.
|
1363
1386
|
# @param filename [String] Filename to load from
|
1364
1387
|
# @param opts [Hash] Set of options
|
1365
|
-
# @option opts [Boolean] :attach_associated Attach all associated images
|
1366
1388
|
# @option opts [Integer] :level Load this level from the file
|
1367
1389
|
# @option opts [Boolean] :autocrop Crop to image bounds
|
1368
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)
|
1369
1393
|
# @option opts [Boolean] :memory Force open via memory
|
1370
1394
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1371
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
|
1372
1397
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1373
1398
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1374
1399
|
|
@@ -1376,128 +1401,172 @@ module Vips
|
|
1376
1401
|
# Load source with openslide.
|
1377
1402
|
# @param source [Vips::Source] Source to load from
|
1378
1403
|
# @param opts [Hash] Set of options
|
1379
|
-
# @option opts [Boolean] :attach_associated Attach all associated images
|
1380
1404
|
# @option opts [Integer] :level Load this level from the file
|
1381
1405
|
# @option opts [Boolean] :autocrop Crop to image bounds
|
1382
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)
|
1383
1409
|
# @option opts [Boolean] :memory Force open via memory
|
1384
1410
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1385
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
|
1386
1413
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1387
1414
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1388
1415
|
|
1389
|
-
# @!method self.
|
1390
|
-
# Load
|
1416
|
+
# @!method self.heifload(filename, **opts)
|
1417
|
+
# Load a heif image.
|
1391
1418
|
# @param filename [String] Filename to load from
|
1392
1419
|
# @param opts [Hash] Set of options
|
1393
|
-
# @option opts [
|
1394
|
-
# @option opts [Integer] :
|
1395
|
-
# @option opts [
|
1420
|
+
# @option opts [Integer] :page First page to load
|
1421
|
+
# @option opts [Integer] :n Number of pages to load, -1 for all
|
1422
|
+
# @option opts [Boolean] :thumbnail Fetch thumbnail image
|
1423
|
+
# @option opts [Boolean] :unlimited Remove all denial of service limits
|
1396
1424
|
# @option opts [Boolean] :memory Force open via memory
|
1397
1425
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1398
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
|
1399
1428
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1400
1429
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1401
1430
|
|
1402
|
-
# @!method self.
|
1403
|
-
# Load
|
1431
|
+
# @!method self.heifload_buffer(buffer, **opts)
|
1432
|
+
# Load a heif image.
|
1404
1433
|
# @param buffer [VipsBlob] Buffer to load from
|
1405
1434
|
# @param opts [Hash] Set of options
|
1406
|
-
# @option opts [
|
1407
|
-
# @option opts [Integer] :
|
1408
|
-
# @option opts [
|
1435
|
+
# @option opts [Integer] :page First page to load
|
1436
|
+
# @option opts [Integer] :n Number of pages to load, -1 for all
|
1437
|
+
# @option opts [Boolean] :thumbnail Fetch thumbnail image
|
1438
|
+
# @option opts [Boolean] :unlimited Remove all denial of service limits
|
1409
1439
|
# @option opts [Boolean] :memory Force open via memory
|
1410
1440
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1411
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
|
1412
1443
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1413
1444
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1414
1445
|
|
1415
|
-
# @!method self.
|
1416
|
-
# Load a
|
1446
|
+
# @!method self.heifload_source(source, **opts)
|
1447
|
+
# Load a heif image.
|
1448
|
+
# @param source [Vips::Source] Source to load from
|
1449
|
+
# @param opts [Hash] Set of options
|
1450
|
+
# @option opts [Integer] :page First page to load
|
1451
|
+
# @option opts [Integer] :n Number of pages to load, -1 for all
|
1452
|
+
# @option opts [Boolean] :thumbnail Fetch thumbnail image
|
1453
|
+
# @option opts [Boolean] :unlimited Remove all denial of service limits
|
1454
|
+
# @option opts [Boolean] :memory Force open via memory
|
1455
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
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.
|
1417
1463
|
# @param filename [String] Filename to load from
|
1418
1464
|
# @param opts [Hash] Set of options
|
1419
1465
|
# @option opts [Boolean] :memory Force open via memory
|
1420
1466
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1421
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
|
1422
1469
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1423
1470
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1424
1471
|
|
1425
|
-
# @!method self.
|
1426
|
-
# Load
|
1427
|
-
# @param
|
1472
|
+
# @!method self.jxlload_buffer(buffer, **opts)
|
1473
|
+
# Load jpeg-xl image.
|
1474
|
+
# @param buffer [VipsBlob] Buffer to load from
|
1428
1475
|
# @param opts [Hash] Set of options
|
1429
1476
|
# @option opts [Boolean] :memory Force open via memory
|
1430
1477
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1431
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
|
1432
1480
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1433
1481
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1434
1482
|
|
1435
|
-
# @!method self.
|
1436
|
-
# Load
|
1437
|
-
# @param
|
1483
|
+
# @!method self.jxlload_source(source, **opts)
|
1484
|
+
# Load jpeg-xl image.
|
1485
|
+
# @param source [Vips::Source] Source to load from
|
1438
1486
|
# @param opts [Hash] Set of options
|
1439
1487
|
# @option opts [Boolean] :memory Force open via memory
|
1440
1488
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1441
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
|
1442
1491
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1443
1492
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1444
1493
|
|
1445
|
-
# @!method self.
|
1446
|
-
# Load
|
1494
|
+
# @!method self.pdfload(filename, **opts)
|
1495
|
+
# Load pdf from file.
|
1447
1496
|
# @param filename [String] Filename to load from
|
1448
1497
|
# @param opts [Hash] Set of options
|
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
|
1449
1504
|
# @option opts [Boolean] :memory Force open via memory
|
1450
1505
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1451
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
|
1452
1508
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1453
1509
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1454
1510
|
|
1455
|
-
# @!method self.
|
1456
|
-
# Load
|
1457
|
-
# @param
|
1511
|
+
# @!method self.pdfload_buffer(buffer, **opts)
|
1512
|
+
# Load pdf from buffer.
|
1513
|
+
# @param buffer [VipsBlob] Buffer to load from
|
1458
1514
|
# @param opts [Hash] Set of options
|
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
|
1459
1521
|
# @option opts [Boolean] :memory Force open via memory
|
1460
1522
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1461
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
|
1462
1525
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1463
1526
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1464
1527
|
|
1465
|
-
# @!method self.
|
1466
|
-
# Load
|
1467
|
-
# @param
|
1528
|
+
# @!method self.pdfload_source(source, **opts)
|
1529
|
+
# Load pdf from source.
|
1530
|
+
# @param source [Vips::Source] Source to load from
|
1468
1531
|
# @param opts [Hash] Set of options
|
1469
|
-
# @option opts [Integer] :page
|
1470
|
-
# @option opts [Integer] :n
|
1471
|
-
# @option opts [
|
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
|
1472
1538
|
# @option opts [Boolean] :memory Force open via memory
|
1473
1539
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1474
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
|
1475
1542
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1476
1543
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1477
1544
|
|
1478
|
-
# @!method self.
|
1479
|
-
# Load
|
1480
|
-
# @param
|
1545
|
+
# @!method self.magickload(filename, **opts)
|
1546
|
+
# Load file with imagemagick.
|
1547
|
+
# @param filename [String] Filename to load from
|
1481
1548
|
# @param opts [Hash] Set of options
|
1482
|
-
# @option opts [
|
1483
|
-
# @option opts [Integer] :
|
1484
|
-
# @option opts [
|
1549
|
+
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
|
1550
|
+
# @option opts [Integer] :page First page to load
|
1551
|
+
# @option opts [Integer] :n Number of pages to load, -1 for all
|
1485
1552
|
# @option opts [Boolean] :memory Force open via memory
|
1486
1553
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1487
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
|
1488
1556
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1489
1557
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1490
1558
|
|
1491
|
-
# @!method self.
|
1492
|
-
# Load
|
1493
|
-
# @param
|
1559
|
+
# @!method self.magickload_buffer(buffer, **opts)
|
1560
|
+
# Load buffer with imagemagick.
|
1561
|
+
# @param buffer [VipsBlob] Buffer to load from
|
1494
1562
|
# @param opts [Hash] Set of options
|
1495
|
-
# @option opts [
|
1496
|
-
# @option opts [Integer] :
|
1497
|
-
# @option opts [
|
1563
|
+
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
|
1564
|
+
# @option opts [Integer] :page First page to load
|
1565
|
+
# @option opts [Integer] :n Number of pages to load, -1 for all
|
1498
1566
|
# @option opts [Boolean] :memory Force open via memory
|
1499
1567
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1500
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
|
1501
1570
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1502
1571
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1503
1572
|
|
@@ -1505,8 +1574,9 @@ module Vips
|
|
1505
1574
|
# Save image to csv.
|
1506
1575
|
# @param filename [String] Filename to save to
|
1507
1576
|
# @param opts [Hash] Set of options
|
1577
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1508
1578
|
# @option opts [String] :separator Separator characters
|
1509
|
-
# @option opts [
|
1579
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1510
1580
|
# @option opts [Array<Double>] :background Background value
|
1511
1581
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1512
1582
|
# @return [nil]
|
@@ -1515,8 +1585,9 @@ module Vips
|
|
1515
1585
|
# Save image to csv.
|
1516
1586
|
# @param target [Vips::Target] Target to save to
|
1517
1587
|
# @param opts [Hash] Set of options
|
1588
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1518
1589
|
# @option opts [String] :separator Separator characters
|
1519
|
-
# @option opts [
|
1590
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1520
1591
|
# @option opts [Array<Double>] :background Background value
|
1521
1592
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1522
1593
|
# @return [nil]
|
@@ -1525,7 +1596,8 @@ module Vips
|
|
1525
1596
|
# Save image to matrix.
|
1526
1597
|
# @param filename [String] Filename to save to
|
1527
1598
|
# @param opts [Hash] Set of options
|
1528
|
-
# @option opts [
|
1599
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1600
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1529
1601
|
# @option opts [Array<Double>] :background Background value
|
1530
1602
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1531
1603
|
# @return [nil]
|
@@ -1534,7 +1606,8 @@ module Vips
|
|
1534
1606
|
# Save image to matrix.
|
1535
1607
|
# @param target [Vips::Target] Target to save to
|
1536
1608
|
# @param opts [Hash] Set of options
|
1537
|
-
# @option opts [
|
1609
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1610
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1538
1611
|
# @option opts [Array<Double>] :background Background value
|
1539
1612
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1540
1613
|
# @return [nil]
|
@@ -1542,7 +1615,8 @@ module Vips
|
|
1542
1615
|
# @!method matrixprint(**opts)
|
1543
1616
|
# Print matrix.
|
1544
1617
|
# @param opts [Hash] Set of options
|
1545
|
-
# @option opts [
|
1618
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1619
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1546
1620
|
# @option opts [Array<Double>] :background Background value
|
1547
1621
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1548
1622
|
# @return [nil]
|
@@ -1551,7 +1625,8 @@ module Vips
|
|
1551
1625
|
# Save image to raw file.
|
1552
1626
|
# @param filename [String] Filename to save to
|
1553
1627
|
# @param opts [Hash] Set of options
|
1554
|
-
# @option opts [
|
1628
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1629
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1555
1630
|
# @option opts [Array<Double>] :background Background value
|
1556
1631
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1557
1632
|
# @return [nil]
|
@@ -1560,7 +1635,8 @@ module Vips
|
|
1560
1635
|
# Write raw image to file descriptor.
|
1561
1636
|
# @param fd [Integer] File descriptor to write to
|
1562
1637
|
# @param opts [Hash] Set of options
|
1563
|
-
# @option opts [
|
1638
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1639
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1564
1640
|
# @option opts [Array<Double>] :background Background value
|
1565
1641
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1566
1642
|
# @return [nil]
|
@@ -1569,7 +1645,8 @@ module Vips
|
|
1569
1645
|
# Save image to file in vips format.
|
1570
1646
|
# @param filename [String] Filename to save to
|
1571
1647
|
# @param opts [Hash] Set of options
|
1572
|
-
# @option opts [
|
1648
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1649
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1573
1650
|
# @option opts [Array<Double>] :background Background value
|
1574
1651
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1575
1652
|
# @return [nil]
|
@@ -1578,7 +1655,8 @@ module Vips
|
|
1578
1655
|
# Save image to target in vips format.
|
1579
1656
|
# @param target [Vips::Target] Target to save to
|
1580
1657
|
# @param opts [Hash] Set of options
|
1581
|
-
# @option opts [
|
1658
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1659
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1582
1660
|
# @option opts [Array<Double>] :background Background value
|
1583
1661
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1584
1662
|
# @return [nil]
|
@@ -1588,9 +1666,10 @@ module Vips
|
|
1588
1666
|
# @param filename [String] Filename to save to
|
1589
1667
|
# @param opts [Hash] Set of options
|
1590
1668
|
# @option opts [Vips::ForeignPpmFormat] :format Format to save in
|
1591
|
-
# @option opts [Boolean] :ascii
|
1592
|
-
# @option opts [
|
1593
|
-
# @option opts [
|
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
|
1594
1673
|
# @option opts [Array<Double>] :background Background value
|
1595
1674
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1596
1675
|
# @return [nil]
|
@@ -1600,9 +1679,10 @@ module Vips
|
|
1600
1679
|
# @param target [Vips::Target] Target to save to
|
1601
1680
|
# @param opts [Hash] Set of options
|
1602
1681
|
# @option opts [Vips::ForeignPpmFormat] :format Format to save in
|
1603
|
-
# @option opts [Boolean] :ascii
|
1604
|
-
# @option opts [
|
1605
|
-
# @option opts [
|
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
|
1606
1686
|
# @option opts [Array<Double>] :background Background value
|
1607
1687
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1608
1688
|
# @return [nil]
|
@@ -1611,7 +1691,8 @@ module Vips
|
|
1611
1691
|
# Save image to radiance file.
|
1612
1692
|
# @param filename [String] Filename to save to
|
1613
1693
|
# @param opts [Hash] Set of options
|
1614
|
-
# @option opts [
|
1694
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1695
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1615
1696
|
# @option opts [Array<Double>] :background Background value
|
1616
1697
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1617
1698
|
# @return [nil]
|
@@ -1619,7 +1700,8 @@ module Vips
|
|
1619
1700
|
# @!method radsave_buffer(**opts)
|
1620
1701
|
# Save image to radiance buffer.
|
1621
1702
|
# @param opts [Hash] Set of options
|
1622
|
-
# @option opts [
|
1703
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1704
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1623
1705
|
# @option opts [Array<Double>] :background Background value
|
1624
1706
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1625
1707
|
# @return [VipsBlob] Buffer to save to
|
@@ -1628,48 +1710,8 @@ module Vips
|
|
1628
1710
|
# Save image to radiance target.
|
1629
1711
|
# @param target [Vips::Target] Target to save to
|
1630
1712
|
# @param opts [Hash] Set of options
|
1631
|
-
# @option opts [
|
1632
|
-
# @option opts [
|
1633
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1634
|
-
# @return [nil]
|
1635
|
-
|
1636
|
-
# @!method jxlsave(filename, **opts)
|
1637
|
-
# Save image in jpeg-xl format.
|
1638
|
-
# @param filename [String] Filename to load from
|
1639
|
-
# @param opts [Hash] Set of options
|
1640
|
-
# @option opts [Integer] :tier Decode speed tier
|
1641
|
-
# @option opts [Float] :distance Target butteraugli distance
|
1642
|
-
# @option opts [Integer] :effort Encoding effort
|
1643
|
-
# @option opts [Boolean] :lossless Enable lossless compression
|
1644
|
-
# @option opts [Integer] :Q Quality factor
|
1645
|
-
# @option opts [Boolean] :strip Strip all metadata from image
|
1646
|
-
# @option opts [Array<Double>] :background Background value
|
1647
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1648
|
-
# @return [nil]
|
1649
|
-
|
1650
|
-
# @!method jxlsave_buffer(**opts)
|
1651
|
-
# Save image in jpeg-xl format.
|
1652
|
-
# @param opts [Hash] Set of options
|
1653
|
-
# @option opts [Integer] :tier Decode speed tier
|
1654
|
-
# @option opts [Float] :distance Target butteraugli distance
|
1655
|
-
# @option opts [Integer] :effort Encoding effort
|
1656
|
-
# @option opts [Boolean] :lossless Enable lossless compression
|
1657
|
-
# @option opts [Integer] :Q Quality factor
|
1658
|
-
# @option opts [Boolean] :strip Strip all metadata from image
|
1659
|
-
# @option opts [Array<Double>] :background Background value
|
1660
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
1661
|
-
# @return [VipsBlob] Buffer to save to
|
1662
|
-
|
1663
|
-
# @!method jxlsave_target(target, **opts)
|
1664
|
-
# Save image in jpeg-xl format.
|
1665
|
-
# @param target [Vips::Target] Target to save to
|
1666
|
-
# @param opts [Hash] Set of options
|
1667
|
-
# @option opts [Integer] :tier Decode speed tier
|
1668
|
-
# @option opts [Float] :distance Target butteraugli distance
|
1669
|
-
# @option opts [Integer] :effort Encoding effort
|
1670
|
-
# @option opts [Boolean] :lossless Enable lossless compression
|
1671
|
-
# @option opts [Integer] :Q Quality factor
|
1672
|
-
# @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
|
1673
1715
|
# @option opts [Array<Double>] :background Background value
|
1674
1716
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1675
1717
|
# @return [nil]
|
@@ -1679,11 +1721,12 @@ module Vips
|
|
1679
1721
|
# @param filename [String] Filename to load from
|
1680
1722
|
# @param opts [Hash] Set of options
|
1681
1723
|
# @option opts [Integer] :tile_width Tile width in pixels
|
1724
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1682
1725
|
# @option opts [Integer] :tile_height Tile height in pixels
|
1683
1726
|
# @option opts [Boolean] :lossless Enable lossless compression
|
1684
1727
|
# @option opts [Integer] :Q Q factor
|
1685
1728
|
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1686
|
-
# @option opts [
|
1729
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1687
1730
|
# @option opts [Array<Double>] :background Background value
|
1688
1731
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1689
1732
|
# @return [nil]
|
@@ -1692,11 +1735,12 @@ module Vips
|
|
1692
1735
|
# Save image in jpeg2000 format.
|
1693
1736
|
# @param opts [Hash] Set of options
|
1694
1737
|
# @option opts [Integer] :tile_width Tile width in pixels
|
1738
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1695
1739
|
# @option opts [Integer] :tile_height Tile height in pixels
|
1696
1740
|
# @option opts [Boolean] :lossless Enable lossless compression
|
1697
1741
|
# @option opts [Integer] :Q Q factor
|
1698
1742
|
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1699
|
-
# @option opts [
|
1743
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1700
1744
|
# @option opts [Array<Double>] :background Background value
|
1701
1745
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1702
1746
|
# @return [VipsBlob] Buffer to save to
|
@@ -1706,11 +1750,12 @@ module Vips
|
|
1706
1750
|
# @param target [Vips::Target] Target to save to
|
1707
1751
|
# @param opts [Hash] Set of options
|
1708
1752
|
# @option opts [Integer] :tile_width Tile width in pixels
|
1753
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1709
1754
|
# @option opts [Integer] :tile_height Tile height in pixels
|
1710
1755
|
# @option opts [Boolean] :lossless Enable lossless compression
|
1711
1756
|
# @option opts [Integer] :Q Q factor
|
1712
1757
|
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1713
|
-
# @option opts [
|
1758
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1714
1759
|
# @option opts [Array<Double>] :background Background value
|
1715
1760
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1716
1761
|
# @return [nil]
|
@@ -1721,8 +1766,13 @@ module Vips
|
|
1721
1766
|
# @param opts [Hash] Set of options
|
1722
1767
|
# @option opts [Float] :dither Amount of dithering
|
1723
1768
|
# @option opts [Integer] :effort Quantisation effort
|
1769
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1724
1770
|
# @option opts [Integer] :bitdepth Number of bits per pixel
|
1725
|
-
# @option opts [
|
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
|
1726
1776
|
# @option opts [Array<Double>] :background Background value
|
1727
1777
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1728
1778
|
# @return [nil]
|
@@ -1732,8 +1782,13 @@ module Vips
|
|
1732
1782
|
# @param opts [Hash] Set of options
|
1733
1783
|
# @option opts [Float] :dither Amount of dithering
|
1734
1784
|
# @option opts [Integer] :effort Quantisation effort
|
1785
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1735
1786
|
# @option opts [Integer] :bitdepth Number of bits per pixel
|
1736
|
-
# @option opts [
|
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
|
1737
1792
|
# @option opts [Array<Double>] :background Background value
|
1738
1793
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1739
1794
|
# @return [VipsBlob] Buffer to save to
|
@@ -1744,8 +1799,13 @@ module Vips
|
|
1744
1799
|
# @param opts [Hash] Set of options
|
1745
1800
|
# @option opts [Float] :dither Amount of dithering
|
1746
1801
|
# @option opts [Integer] :effort Quantisation effort
|
1802
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1747
1803
|
# @option opts [Integer] :bitdepth Number of bits per pixel
|
1748
|
-
# @option opts [
|
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
|
1749
1809
|
# @option opts [Array<Double>] :background Background value
|
1750
1810
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1751
1811
|
# @return [nil]
|
@@ -1754,22 +1814,22 @@ module Vips
|
|
1754
1814
|
# Save image to deepzoom file.
|
1755
1815
|
# @param filename [String] Filename to save to
|
1756
1816
|
# @param opts [Hash] Set of options
|
1757
|
-
# @option opts [String] :
|
1817
|
+
# @option opts [String] :imagename Image name
|
1758
1818
|
# @option opts [Vips::ForeignDzLayout] :layout Directory layout
|
1759
1819
|
# @option opts [String] :suffix Filename suffix for tiles
|
1760
1820
|
# @option opts [Integer] :overlap Tile overlap in pixels
|
1761
1821
|
# @option opts [Integer] :tile_size Tile size in pixels
|
1822
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1762
1823
|
# @option opts [Boolean] :centre Center image in tile
|
1763
1824
|
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
1764
1825
|
# @option opts [Vips::Angle] :angle Rotate image during save
|
1765
1826
|
# @option opts [Vips::ForeignDzContainer] :container Pyramid container type
|
1766
|
-
# @option opts [Boolean] :properties Write a properties file to the output directory
|
1767
1827
|
# @option opts [Integer] :compression ZIP deflate compression level
|
1768
1828
|
# @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
|
1769
1829
|
# @option opts [Integer] :skip_blanks Skip tiles which are nearly equal to the background
|
1770
|
-
# @option opts [Boolean] :no_strip Don't strip tile metadata
|
1771
1830
|
# @option opts [String] :id Resource ID
|
1772
|
-
# @option opts [
|
1831
|
+
# @option opts [Integer] :Q Q factor
|
1832
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1773
1833
|
# @option opts [Array<Double>] :background Background value
|
1774
1834
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1775
1835
|
# @return [nil]
|
@@ -1777,40 +1837,64 @@ module Vips
|
|
1777
1837
|
# @!method dzsave_buffer(**opts)
|
1778
1838
|
# Save image to dz buffer.
|
1779
1839
|
# @param opts [Hash] Set of options
|
1780
|
-
# @option opts [String] :
|
1840
|
+
# @option opts [String] :imagename Image name
|
1781
1841
|
# @option opts [Vips::ForeignDzLayout] :layout Directory layout
|
1782
1842
|
# @option opts [String] :suffix Filename suffix for tiles
|
1783
1843
|
# @option opts [Integer] :overlap Tile overlap in pixels
|
1784
1844
|
# @option opts [Integer] :tile_size Tile size in pixels
|
1845
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1785
1846
|
# @option opts [Boolean] :centre Center image in tile
|
1786
1847
|
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
1787
1848
|
# @option opts [Vips::Angle] :angle Rotate image during save
|
1788
1849
|
# @option opts [Vips::ForeignDzContainer] :container Pyramid container type
|
1789
|
-
# @option opts [Boolean] :properties Write a properties file to the output directory
|
1790
1850
|
# @option opts [Integer] :compression ZIP deflate compression level
|
1791
1851
|
# @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
|
1792
1852
|
# @option opts [Integer] :skip_blanks Skip tiles which are nearly equal to the background
|
1793
|
-
# @option opts [Boolean] :no_strip Don't strip tile metadata
|
1794
1853
|
# @option opts [String] :id Resource ID
|
1795
|
-
# @option opts [
|
1854
|
+
# @option opts [Integer] :Q Q factor
|
1855
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1796
1856
|
# @option opts [Array<Double>] :background Background value
|
1797
1857
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1798
1858
|
# @return [VipsBlob] Buffer to save to
|
1799
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
|
+
|
1800
1884
|
# @!method pngsave(filename, **opts)
|
1801
1885
|
# Save image to png file.
|
1802
1886
|
# @param filename [String] Filename to save to
|
1803
1887
|
# @param opts [Hash] Set of options
|
1804
1888
|
# @option opts [Integer] :compression Compression factor
|
1805
1889
|
# @option opts [Boolean] :interlace Interlace image
|
1806
|
-
# @option opts [String] :profile ICC profile to embed
|
1890
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1807
1891
|
# @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
|
1808
1892
|
# @option opts [Boolean] :palette Quantise to 8bpp palette
|
1809
1893
|
# @option opts [Integer] :Q Quantisation quality
|
1810
1894
|
# @option opts [Float] :dither Amount of dithering
|
1811
|
-
# @option opts [Integer] :bitdepth Write as a 1, 2, 4 or
|
1895
|
+
# @option opts [Integer] :bitdepth Write as a 1, 2, 4, 8 or 16 bit image
|
1812
1896
|
# @option opts [Integer] :effort Quantisation CPU effort
|
1813
|
-
# @option opts [
|
1897
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1814
1898
|
# @option opts [Array<Double>] :background Background value
|
1815
1899
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1816
1900
|
# @return [nil]
|
@@ -1820,14 +1904,14 @@ module Vips
|
|
1820
1904
|
# @param opts [Hash] Set of options
|
1821
1905
|
# @option opts [Integer] :compression Compression factor
|
1822
1906
|
# @option opts [Boolean] :interlace Interlace image
|
1823
|
-
# @option opts [String] :profile ICC profile to embed
|
1907
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1824
1908
|
# @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
|
1825
1909
|
# @option opts [Boolean] :palette Quantise to 8bpp palette
|
1826
1910
|
# @option opts [Integer] :Q Quantisation quality
|
1827
1911
|
# @option opts [Float] :dither Amount of dithering
|
1828
|
-
# @option opts [Integer] :bitdepth Write as a 1, 2, 4 or
|
1912
|
+
# @option opts [Integer] :bitdepth Write as a 1, 2, 4, 8 or 16 bit image
|
1829
1913
|
# @option opts [Integer] :effort Quantisation CPU effort
|
1830
|
-
# @option opts [
|
1914
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1831
1915
|
# @option opts [Array<Double>] :background Background value
|
1832
1916
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1833
1917
|
# @return [VipsBlob] Buffer to save to
|
@@ -1838,14 +1922,14 @@ module Vips
|
|
1838
1922
|
# @param opts [Hash] Set of options
|
1839
1923
|
# @option opts [Integer] :compression Compression factor
|
1840
1924
|
# @option opts [Boolean] :interlace Interlace image
|
1841
|
-
# @option opts [String] :profile ICC profile to embed
|
1925
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1842
1926
|
# @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
|
1843
1927
|
# @option opts [Boolean] :palette Quantise to 8bpp palette
|
1844
1928
|
# @option opts [Integer] :Q Quantisation quality
|
1845
1929
|
# @option opts [Float] :dither Amount of dithering
|
1846
|
-
# @option opts [Integer] :bitdepth Write as a 1, 2, 4 or
|
1930
|
+
# @option opts [Integer] :bitdepth Write as a 1, 2, 4, 8 or 16 bit image
|
1847
1931
|
# @option opts [Integer] :effort Quantisation CPU effort
|
1848
|
-
# @option opts [
|
1932
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1849
1933
|
# @option opts [Array<Double>] :background Background value
|
1850
1934
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1851
1935
|
# @return [nil]
|
@@ -1855,7 +1939,7 @@ module Vips
|
|
1855
1939
|
# @param filename [String] Filename to save to
|
1856
1940
|
# @param opts [Hash] Set of options
|
1857
1941
|
# @option opts [Integer] :Q Q factor
|
1858
|
-
# @option opts [String] :profile ICC profile to embed
|
1942
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1859
1943
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
1860
1944
|
# @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
|
1861
1945
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
@@ -1864,7 +1948,7 @@ module Vips
|
|
1864
1948
|
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1865
1949
|
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1866
1950
|
# @option opts [Integer] :restart_interval Add restart markers every specified number of mcu
|
1867
|
-
# @option opts [
|
1951
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1868
1952
|
# @option opts [Array<Double>] :background Background value
|
1869
1953
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1870
1954
|
# @return [nil]
|
@@ -1873,7 +1957,7 @@ module Vips
|
|
1873
1957
|
# Save image to jpeg buffer.
|
1874
1958
|
# @param opts [Hash] Set of options
|
1875
1959
|
# @option opts [Integer] :Q Q factor
|
1876
|
-
# @option opts [String] :profile ICC profile to embed
|
1960
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1877
1961
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
1878
1962
|
# @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
|
1879
1963
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
@@ -1882,7 +1966,7 @@ module Vips
|
|
1882
1966
|
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1883
1967
|
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1884
1968
|
# @option opts [Integer] :restart_interval Add restart markers every specified number of mcu
|
1885
|
-
# @option opts [
|
1969
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1886
1970
|
# @option opts [Array<Double>] :background Background value
|
1887
1971
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1888
1972
|
# @return [VipsBlob] Buffer to save to
|
@@ -1892,7 +1976,7 @@ module Vips
|
|
1892
1976
|
# @param target [Vips::Target] Target to save to
|
1893
1977
|
# @param opts [Hash] Set of options
|
1894
1978
|
# @option opts [Integer] :Q Q factor
|
1895
|
-
# @option opts [String] :profile ICC profile to embed
|
1979
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1896
1980
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
1897
1981
|
# @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
|
1898
1982
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
@@ -1901,7 +1985,7 @@ module Vips
|
|
1901
1985
|
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1902
1986
|
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1903
1987
|
# @option opts [Integer] :restart_interval Add restart markers every specified number of mcu
|
1904
|
-
# @option opts [
|
1988
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1905
1989
|
# @option opts [Array<Double>] :background Background value
|
1906
1990
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1907
1991
|
# @return [nil]
|
@@ -1910,7 +1994,7 @@ module Vips
|
|
1910
1994
|
# Save image to jpeg mime.
|
1911
1995
|
# @param opts [Hash] Set of options
|
1912
1996
|
# @option opts [Integer] :Q Q factor
|
1913
|
-
# @option opts [String] :profile ICC profile to embed
|
1997
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1914
1998
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
1915
1999
|
# @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
|
1916
2000
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
@@ -1919,66 +2003,89 @@ module Vips
|
|
1919
2003
|
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1920
2004
|
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1921
2005
|
# @option opts [Integer] :restart_interval Add restart markers every specified number of mcu
|
1922
|
-
# @option opts [
|
2006
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1923
2007
|
# @option opts [Array<Double>] :background Background value
|
1924
2008
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1925
2009
|
# @return [nil]
|
1926
2010
|
|
1927
2011
|
# @!method webpsave(filename, **opts)
|
1928
|
-
# Save
|
2012
|
+
# Save as webp.
|
1929
2013
|
# @param filename [String] Filename to save to
|
1930
2014
|
# @param opts [Hash] Set of options
|
1931
2015
|
# @option opts [Integer] :Q Q factor
|
1932
|
-
# @option opts [Boolean] :lossless
|
2016
|
+
# @option opts [Boolean] :lossless Enable lossless compression
|
2017
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1933
2018
|
# @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
|
1934
2019
|
# @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
|
1935
2020
|
# @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
|
1936
2021
|
# @option opts [Integer] :alpha_q Change alpha plane fidelity for lossy compression
|
1937
|
-
# @option opts [Boolean] :min_size Optimise for
|
2022
|
+
# @option opts [Boolean] :min_size Optimise for minimum size
|
1938
2023
|
# @option opts [Integer] :kmin Minimum number of frames between key frames
|
1939
2024
|
# @option opts [Integer] :kmax Maximum number of frames between key frames
|
1940
2025
|
# @option opts [Integer] :effort Level of CPU effort to reduce file size
|
1941
|
-
# @option opts [
|
1942
|
-
# @option opts [
|
2026
|
+
# @option opts [Boolean] :mixed Allow mixed encoding (might reduce file size)
|
2027
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1943
2028
|
# @option opts [Array<Double>] :background Background value
|
1944
2029
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1945
2030
|
# @return [nil]
|
1946
2031
|
|
1947
2032
|
# @!method webpsave_buffer(**opts)
|
1948
|
-
# Save
|
2033
|
+
# Save as webp.
|
1949
2034
|
# @param opts [Hash] Set of options
|
1950
2035
|
# @option opts [Integer] :Q Q factor
|
1951
|
-
# @option opts [Boolean] :lossless
|
2036
|
+
# @option opts [Boolean] :lossless Enable lossless compression
|
2037
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1952
2038
|
# @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
|
1953
2039
|
# @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
|
1954
2040
|
# @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
|
1955
2041
|
# @option opts [Integer] :alpha_q Change alpha plane fidelity for lossy compression
|
1956
|
-
# @option opts [Boolean] :min_size Optimise for
|
2042
|
+
# @option opts [Boolean] :min_size Optimise for minimum size
|
1957
2043
|
# @option opts [Integer] :kmin Minimum number of frames between key frames
|
1958
2044
|
# @option opts [Integer] :kmax Maximum number of frames between key frames
|
1959
2045
|
# @option opts [Integer] :effort Level of CPU effort to reduce file size
|
1960
|
-
# @option opts [
|
1961
|
-
# @option opts [
|
2046
|
+
# @option opts [Boolean] :mixed Allow mixed encoding (might reduce file size)
|
2047
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1962
2048
|
# @option opts [Array<Double>] :background Background value
|
1963
2049
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1964
2050
|
# @return [VipsBlob] Buffer to save to
|
1965
2051
|
|
1966
2052
|
# @!method webpsave_target(target, **opts)
|
1967
|
-
# Save
|
2053
|
+
# Save as webp.
|
1968
2054
|
# @param target [Vips::Target] Target to save to
|
1969
2055
|
# @param opts [Hash] Set of options
|
1970
2056
|
# @option opts [Integer] :Q Q factor
|
1971
|
-
# @option opts [Boolean] :lossless
|
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
|
1972
2079
|
# @option opts [Vips::ForeignWebpPreset] :preset Preset for lossy compression
|
1973
2080
|
# @option opts [Boolean] :smart_subsample Enable high quality chroma subsampling
|
1974
2081
|
# @option opts [Boolean] :near_lossless Enable preprocessing in lossless mode (uses Q)
|
1975
2082
|
# @option opts [Integer] :alpha_q Change alpha plane fidelity for lossy compression
|
1976
|
-
# @option opts [Boolean] :min_size Optimise for
|
2083
|
+
# @option opts [Boolean] :min_size Optimise for minimum size
|
1977
2084
|
# @option opts [Integer] :kmin Minimum number of frames between key frames
|
1978
2085
|
# @option opts [Integer] :kmax Maximum number of frames between key frames
|
1979
2086
|
# @option opts [Integer] :effort Level of CPU effort to reduce file size
|
1980
|
-
# @option opts [
|
1981
|
-
# @option opts [
|
2087
|
+
# @option opts [Boolean] :mixed Allow mixed encoding (might reduce file size)
|
2088
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
1982
2089
|
# @option opts [Array<Double>] :background Background value
|
1983
2090
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1984
2091
|
# @return [nil]
|
@@ -1990,9 +2097,9 @@ module Vips
|
|
1990
2097
|
# @option opts [Vips::ForeignTiffCompression] :compression Compression for this file
|
1991
2098
|
# @option opts [Integer] :Q Q factor
|
1992
2099
|
# @option opts [Vips::ForeignTiffPredictor] :predictor Compression prediction
|
1993
|
-
# @option opts [String] :profile ICC profile to embed
|
1994
2100
|
# @option opts [Boolean] :tile Write a tiled tiff
|
1995
2101
|
# @option opts [Integer] :tile_width Tile width in pixels
|
2102
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
1996
2103
|
# @option opts [Integer] :tile_height Tile height in pixels
|
1997
2104
|
# @option opts [Boolean] :pyramid Write a pyramidal tiff
|
1998
2105
|
# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
|
@@ -2008,7 +2115,7 @@ module Vips
|
|
2008
2115
|
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
2009
2116
|
# @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
|
2010
2117
|
# @option opts [Boolean] :premultiply Save with premultiplied alpha
|
2011
|
-
# @option opts [
|
2118
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
2012
2119
|
# @option opts [Array<Double>] :background Background value
|
2013
2120
|
# @option opts [Integer] :page_height Set page height for multipage save
|
2014
2121
|
# @return [nil]
|
@@ -2019,9 +2126,9 @@ module Vips
|
|
2019
2126
|
# @option opts [Vips::ForeignTiffCompression] :compression Compression for this file
|
2020
2127
|
# @option opts [Integer] :Q Q factor
|
2021
2128
|
# @option opts [Vips::ForeignTiffPredictor] :predictor Compression prediction
|
2022
|
-
# @option opts [String] :profile ICC profile to embed
|
2023
2129
|
# @option opts [Boolean] :tile Write a tiled tiff
|
2024
2130
|
# @option opts [Integer] :tile_width Tile width in pixels
|
2131
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
2025
2132
|
# @option opts [Integer] :tile_height Tile height in pixels
|
2026
2133
|
# @option opts [Boolean] :pyramid Write a pyramidal tiff
|
2027
2134
|
# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
|
@@ -2037,41 +2144,47 @@ module Vips
|
|
2037
2144
|
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
2038
2145
|
# @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
|
2039
2146
|
# @option opts [Boolean] :premultiply Save with premultiplied alpha
|
2040
|
-
# @option opts [
|
2147
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
2041
2148
|
# @option opts [Array<Double>] :background Background value
|
2042
2149
|
# @option opts [Integer] :page_height Set page height for multipage save
|
2043
2150
|
# @return [VipsBlob] Buffer to save to
|
2044
2151
|
|
2045
|
-
# @!method
|
2046
|
-
# Save
|
2047
|
-
# @param
|
2152
|
+
# @!method tiffsave_target(target, **opts)
|
2153
|
+
# Save image to tiff target.
|
2154
|
+
# @param target [Vips::Target] Target to save to
|
2048
2155
|
# @param opts [Hash] Set of options
|
2049
|
-
# @option opts [
|
2050
|
-
# @option opts [Integer] :
|
2051
|
-
# @option opts [
|
2052
|
-
# @option opts [Boolean] :
|
2053
|
-
# @option opts [
|
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
|
2054
2178
|
# @option opts [Array<Double>] :background Background value
|
2055
2179
|
# @option opts [Integer] :page_height Set page height for multipage save
|
2056
2180
|
# @return [nil]
|
2057
2181
|
|
2058
|
-
# @!method magicksave_buffer(**opts)
|
2059
|
-
# Save image to magick buffer.
|
2060
|
-
# @param opts [Hash] Set of options
|
2061
|
-
# @option opts [String] :format Format to save in
|
2062
|
-
# @option opts [Integer] :quality Quality to use
|
2063
|
-
# @option opts [Boolean] :optimize_gif_frames Apply GIF frames optimization
|
2064
|
-
# @option opts [Boolean] :optimize_gif_transparency Apply GIF transparency optimization
|
2065
|
-
# @option opts [Boolean] :strip Strip all metadata from image
|
2066
|
-
# @option opts [Array<Double>] :background Background value
|
2067
|
-
# @option opts [Integer] :page_height Set page height for multipage save
|
2068
|
-
# @return [VipsBlob] Buffer to save to
|
2069
|
-
|
2070
2182
|
# @!method fitssave(filename, **opts)
|
2071
2183
|
# Save image to fits file.
|
2072
2184
|
# @param filename [String] Filename to save to
|
2073
2185
|
# @param opts [Hash] Set of options
|
2074
|
-
# @option opts [
|
2186
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
2187
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
2075
2188
|
# @option opts [Array<Double>] :background Background value
|
2076
2189
|
# @option opts [Integer] :page_height Set page height for multipage save
|
2077
2190
|
# @return [nil]
|
@@ -2080,7 +2193,8 @@ module Vips
|
|
2080
2193
|
# Save image to nifti file.
|
2081
2194
|
# @param filename [String] Filename to save to
|
2082
2195
|
# @param opts [Hash] Set of options
|
2083
|
-
# @option opts [
|
2196
|
+
# @option opts [String] :profile Filename of ICC profile to embed
|
2197
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
2084
2198
|
# @option opts [Array<Double>] :background Background value
|
2085
2199
|
# @option opts [Integer] :page_height Set page height for multipage save
|
2086
2200
|
# @return [nil]
|
@@ -2090,11 +2204,14 @@ module Vips
|
|
2090
2204
|
# @param filename [String] Filename to save to
|
2091
2205
|
# @param opts [Hash] Set of options
|
2092
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
|
2093
2209
|
# @option opts [Boolean] :lossless Enable lossless compression
|
2094
2210
|
# @option opts [Vips::ForeignHeifCompression] :compression Compression format
|
2095
2211
|
# @option opts [Integer] :effort CPU effort
|
2096
2212
|
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
2097
|
-
# @option opts [
|
2213
|
+
# @option opts [Vips::ForeignHeifEncoder] :encoder Select encoder to use
|
2214
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
2098
2215
|
# @option opts [Array<Double>] :background Background value
|
2099
2216
|
# @option opts [Integer] :page_height Set page height for multipage save
|
2100
2217
|
# @return [nil]
|
@@ -2103,11 +2220,14 @@ module Vips
|
|
2103
2220
|
# Save image in heif format.
|
2104
2221
|
# @param opts [Hash] Set of options
|
2105
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
|
2106
2225
|
# @option opts [Boolean] :lossless Enable lossless compression
|
2107
2226
|
# @option opts [Vips::ForeignHeifCompression] :compression Compression format
|
2108
2227
|
# @option opts [Integer] :effort CPU effort
|
2109
2228
|
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
2110
|
-
# @option opts [
|
2229
|
+
# @option opts [Vips::ForeignHeifEncoder] :encoder Select encoder to use
|
2230
|
+
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
|
2111
2231
|
# @option opts [Array<Double>] :background Background value
|
2112
2232
|
# @option opts [Integer] :page_height Set page height for multipage save
|
2113
2233
|
# @return [VipsBlob] Buffer to save to
|
@@ -2117,15 +2237,91 @@ module Vips
|
|
2117
2237
|
# @param target [Vips::Target] Target to save to
|
2118
2238
|
# @param opts [Hash] Set of options
|
2119
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
|
2120
2242
|
# @option opts [Boolean] :lossless Enable lossless compression
|
2121
2243
|
# @option opts [Vips::ForeignHeifCompression] :compression Compression format
|
2122
2244
|
# @option opts [Integer] :effort CPU effort
|
2123
2245
|
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
2124
|
-
# @option opts [
|
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
|
2125
2263
|
# @option opts [Array<Double>] :background Background value
|
2126
2264
|
# @option opts [Integer] :page_height Set page height for multipage save
|
2127
2265
|
# @return [nil]
|
2128
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
|
2292
|
+
# @option opts [Array<Double>] :background Background value
|
2293
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
2294
|
+
# @return [nil]
|
2295
|
+
|
2296
|
+
# @!method magicksave(filename, **opts)
|
2297
|
+
# Save file with imagemagick.
|
2298
|
+
# @param filename [String] Filename to save to
|
2299
|
+
# @param opts [Hash] Set of options
|
2300
|
+
# @option opts [String] :format Format to save in
|
2301
|
+
# @option opts [Integer] :quality Quality to use
|
2302
|
+
# @option opts [Boolean] :optimize_gif_frames Apply GIF frames optimization
|
2303
|
+
# @option opts [Boolean] :optimize_gif_transparency Apply GIF transparency optimization
|
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
|
2307
|
+
# @option opts [Array<Double>] :background Background value
|
2308
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
2309
|
+
# @return [nil]
|
2310
|
+
|
2311
|
+
# @!method magicksave_buffer(**opts)
|
2312
|
+
# Save image to magick buffer.
|
2313
|
+
# @param opts [Hash] Set of options
|
2314
|
+
# @option opts [String] :format Format to save in
|
2315
|
+
# @option opts [Integer] :quality Quality to use
|
2316
|
+
# @option opts [Boolean] :optimize_gif_frames Apply GIF frames optimization
|
2317
|
+
# @option opts [Boolean] :optimize_gif_transparency Apply GIF transparency optimization
|
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
|
2321
|
+
# @option opts [Array<Double>] :background Background value
|
2322
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
2323
|
+
# @return [VipsBlob] Buffer to save to
|
2324
|
+
|
2129
2325
|
# @!method self.thumbnail(filename, width, **opts)
|
2130
2326
|
# Generate thumbnail from file.
|
2131
2327
|
# @param filename [String] Filename to read from
|
@@ -2139,6 +2335,7 @@ module Vips
|
|
2139
2335
|
# @option opts [String] :import_profile Fallback import profile
|
2140
2336
|
# @option opts [String] :export_profile Fallback export profile
|
2141
2337
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2338
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
2142
2339
|
# @return [Vips::Image] Output image
|
2143
2340
|
|
2144
2341
|
# @!method self.thumbnail_buffer(buffer, width, **opts)
|
@@ -2155,6 +2352,7 @@ module Vips
|
|
2155
2352
|
# @option opts [String] :import_profile Fallback import profile
|
2156
2353
|
# @option opts [String] :export_profile Fallback export profile
|
2157
2354
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2355
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
2158
2356
|
# @return [Vips::Image] Output image
|
2159
2357
|
|
2160
2358
|
# @!method thumbnail_image(width, **opts)
|
@@ -2169,6 +2367,7 @@ module Vips
|
|
2169
2367
|
# @option opts [String] :import_profile Fallback import profile
|
2170
2368
|
# @option opts [String] :export_profile Fallback export profile
|
2171
2369
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2370
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
2172
2371
|
# @return [Vips::Image] Output image
|
2173
2372
|
|
2174
2373
|
# @!method self.thumbnail_source(source, width, **opts)
|
@@ -2185,6 +2384,7 @@ module Vips
|
|
2185
2384
|
# @option opts [String] :import_profile Fallback import profile
|
2186
2385
|
# @option opts [String] :export_profile Fallback export profile
|
2187
2386
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2387
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
2188
2388
|
# @return [Vips::Image] Output image
|
2189
2389
|
|
2190
2390
|
# @!method mapim(index, **opts)
|
@@ -2192,6 +2392,9 @@ module Vips
|
|
2192
2392
|
# @param index [Vips::Image] Index pixels with this
|
2193
2393
|
# @param opts [Hash] Set of options
|
2194
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
|
2195
2398
|
# @return [Vips::Image] Output image
|
2196
2399
|
|
2197
2400
|
# @!method shrink(hshrink, vshrink, **opts)
|
@@ -2199,18 +2402,21 @@ module Vips
|
|
2199
2402
|
# @param hshrink [Float] Horizontal shrink factor
|
2200
2403
|
# @param vshrink [Float] Vertical shrink factor
|
2201
2404
|
# @param opts [Hash] Set of options
|
2405
|
+
# @option opts [Boolean] :ceil Round-up output dimensions
|
2202
2406
|
# @return [Vips::Image] Output image
|
2203
2407
|
|
2204
2408
|
# @!method shrinkh(hshrink, **opts)
|
2205
2409
|
# Shrink an image horizontally.
|
2206
2410
|
# @param hshrink [Integer] Horizontal shrink factor
|
2207
2411
|
# @param opts [Hash] Set of options
|
2412
|
+
# @option opts [Boolean] :ceil Round-up output dimensions
|
2208
2413
|
# @return [Vips::Image] Output image
|
2209
2414
|
|
2210
2415
|
# @!method shrinkv(vshrink, **opts)
|
2211
2416
|
# Shrink an image vertically.
|
2212
2417
|
# @param vshrink [Integer] Vertical shrink factor
|
2213
2418
|
# @param opts [Hash] Set of options
|
2419
|
+
# @option opts [Boolean] :ceil Round-up output dimensions
|
2214
2420
|
# @return [Vips::Image] Output image
|
2215
2421
|
|
2216
2422
|
# @!method reduceh(hshrink, **opts)
|
@@ -2218,6 +2424,7 @@ module Vips
|
|
2218
2424
|
# @param hshrink [Float] Horizontal shrink factor
|
2219
2425
|
# @param opts [Hash] Set of options
|
2220
2426
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
2427
|
+
# @option opts [Float] :gap Reducing gap
|
2221
2428
|
# @return [Vips::Image] Output image
|
2222
2429
|
|
2223
2430
|
# @!method reducev(vshrink, **opts)
|
@@ -2225,6 +2432,7 @@ module Vips
|
|
2225
2432
|
# @param vshrink [Float] Vertical shrink factor
|
2226
2433
|
# @param opts [Hash] Set of options
|
2227
2434
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
2435
|
+
# @option opts [Float] :gap Reducing gap
|
2228
2436
|
# @return [Vips::Image] Output image
|
2229
2437
|
|
2230
2438
|
# @!method reduce(hshrink, vshrink, **opts)
|
@@ -2233,6 +2441,7 @@ module Vips
|
|
2233
2441
|
# @param vshrink [Float] Vertical shrink factor
|
2234
2442
|
# @param opts [Hash] Set of options
|
2235
2443
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
2444
|
+
# @option opts [Float] :gap Reducing gap
|
2236
2445
|
# @return [Vips::Image] Output image
|
2237
2446
|
|
2238
2447
|
# @!method quadratic(coeff, **opts)
|
@@ -2287,6 +2496,7 @@ module Vips
|
|
2287
2496
|
# @param scale [Float] Scale image by this factor
|
2288
2497
|
# @param opts [Hash] Set of options
|
2289
2498
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
2499
|
+
# @option opts [Float] :gap Reducing gap
|
2290
2500
|
# @option opts [Float] :vscale Vertical scale image by this factor
|
2291
2501
|
# @return [Vips::Image] Output image
|
2292
2502
|
|
@@ -2339,16 +2549,6 @@ module Vips
|
|
2339
2549
|
# @param opts [Hash] Set of options
|
2340
2550
|
# @return [Vips::Image] Output image
|
2341
2551
|
|
2342
|
-
# @!method scRGB2XYZ(**opts)
|
2343
|
-
# Transform scrgb to xyz.
|
2344
|
-
# @param opts [Hash] Set of options
|
2345
|
-
# @return [Vips::Image] Output image
|
2346
|
-
|
2347
|
-
# @!method XYZ2scRGB(**opts)
|
2348
|
-
# Transform xyz to scrgb.
|
2349
|
-
# @param opts [Hash] Set of options
|
2350
|
-
# @return [Vips::Image] Output image
|
2351
|
-
|
2352
2552
|
# @!method LabQ2Lab(**opts)
|
2353
2553
|
# Unpack a labq image to float lab.
|
2354
2554
|
# @param opts [Hash] Set of options
|
@@ -2459,12 +2659,22 @@ module Vips
|
|
2459
2659
|
# @param opts [Hash] Set of options
|
2460
2660
|
# @return [Vips::Image] Output image
|
2461
2661
|
|
2662
|
+
# @!method scRGB2XYZ(**opts)
|
2663
|
+
# Transform scrgb to xyz.
|
2664
|
+
# @param opts [Hash] Set of options
|
2665
|
+
# @return [Vips::Image] Output image
|
2666
|
+
|
2462
2667
|
# @!method scRGB2BW(**opts)
|
2463
2668
|
# Convert scrgb to bw.
|
2464
2669
|
# @param opts [Hash] Set of options
|
2465
2670
|
# @option opts [Integer] :depth Output device space depth in bits
|
2466
2671
|
# @return [Vips::Image] Output image
|
2467
2672
|
|
2673
|
+
# @!method XYZ2scRGB(**opts)
|
2674
|
+
# Transform xyz to scrgb.
|
2675
|
+
# @param opts [Hash] Set of options
|
2676
|
+
# @return [Vips::Image] Output image
|
2677
|
+
|
2468
2678
|
# @!method scRGB2sRGB(**opts)
|
2469
2679
|
# Convert an scrgb image to srgb.
|
2470
2680
|
# @param opts [Hash] Set of options
|
@@ -2491,7 +2701,7 @@ module Vips
|
|
2491
2701
|
# Map an image though a lut.
|
2492
2702
|
# @param lut [Vips::Image] Look-up table image
|
2493
2703
|
# @param opts [Hash] Set of options
|
2494
|
-
# @option opts [Integer] :band
|
2704
|
+
# @option opts [Integer] :band Apply one-band lut to this band of in
|
2495
2705
|
# @return [Vips::Image] Output image
|
2496
2706
|
|
2497
2707
|
# @!method case(cases, **opts)
|
@@ -2604,7 +2814,7 @@ module Vips
|
|
2604
2814
|
# @return [Vips::Image] Output image
|
2605
2815
|
|
2606
2816
|
# @!method convsep(mask, **opts)
|
2607
|
-
#
|
2817
|
+
# Separable convolution operation.
|
2608
2818
|
# @param mask [Vips::Image] Input matrix image
|
2609
2819
|
# @param opts [Hash] Set of options
|
2610
2820
|
# @option opts [Vips::Precision] :precision Convolve with this precision
|
@@ -2650,6 +2860,21 @@ module Vips
|
|
2650
2860
|
# @option opts [Vips::Precision] :precision Convolve with this precision
|
2651
2861
|
# @return [Vips::Image] Output image
|
2652
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
|
+
|
2653
2878
|
# @!method canny(**opts)
|
2654
2879
|
# Canny edge detector.
|
2655
2880
|
# @param opts [Hash] Set of options
|
@@ -2657,11 +2882,6 @@ module Vips
|
|
2657
2882
|
# @option opts [Vips::Precision] :precision Convolve with this precision
|
2658
2883
|
# @return [Vips::Image] Output image
|
2659
2884
|
|
2660
|
-
# @!method sobel(**opts)
|
2661
|
-
# Sobel edge detector.
|
2662
|
-
# @param opts [Hash] Set of options
|
2663
|
-
# @return [Vips::Image] Output image
|
2664
|
-
|
2665
2885
|
# @!method fwfft(**opts)
|
2666
2886
|
# Forward fft.
|
2667
2887
|
# @param opts [Hash] Set of options
|
@@ -2714,7 +2934,7 @@ module Vips
|
|
2714
2934
|
# @!method labelregions(**opts)
|
2715
2935
|
# Label regions in an image.
|
2716
2936
|
# @param opts [Hash] Set of options
|
2717
|
-
# @option opts [Integer] :segments Output Number of discrete
|
2937
|
+
# @option opts [Integer] :segments Output Number of discrete contiguous regions
|
2718
2938
|
# @return [Vips::Image, Hash<Symbol => Object>] Mask of region labels, Hash of optional output items
|
2719
2939
|
|
2720
2940
|
# @!method fill_nearest(**opts)
|
@@ -2772,9 +2992,9 @@ module Vips
|
|
2772
2992
|
# @option opts [Vips::Image] :test Test pixels in this image
|
2773
2993
|
# @option opts [Boolean] :equal DrawFlood while equal to edge
|
2774
2994
|
# @option opts [Integer] :left Output Left edge of modified area
|
2775
|
-
# @option opts [Integer] :top Output
|
2776
|
-
# @option opts [Integer] :width Output
|
2777
|
-
# @option opts [Integer] :height Output
|
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
|
2778
2998
|
# @return [Vips::Image, Hash<Symbol => Object>] Image to draw on, Hash of optional output items
|
2779
2999
|
|
2780
3000
|
# @!method draw_image(sub, x, y, **opts)
|
@@ -2844,7 +3064,6 @@ module Vips
|
|
2844
3064
|
# @option opts [Boolean] :search Search to improve tie-points
|
2845
3065
|
# @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
|
2846
3066
|
# @option opts [Integer] :mblend Maximum blend size
|
2847
|
-
# @option opts [Integer] :bandno Band to search for features on
|
2848
3067
|
# @return [Vips::Image] Output image
|
2849
3068
|
|
2850
3069
|
# @!method matrixinvert(**opts)
|