ruby-vips 2.1.0 → 2.1.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/README.md +22 -16
- data/TODO +2 -3
- data/VERSION +1 -1
- data/example/inheritance_with_refcount.rb +11 -3
- data/lib/vips/image.rb +132 -26
- data/lib/vips/methods.rb +334 -218
- data/lib/vips/mutableimage.rb +23 -4
- data/lib/vips/object.rb +4 -10
- data/lib/vips/operation.rb +15 -1
- data/lib/vips/version.rb +1 -1
- data/lib/vips.rb +8 -1
- metadata +3 -3
data/lib/vips/methods.rb
CHANGED
@@ -265,7 +265,6 @@ module Vips
|
|
265
265
|
# @!method copy(**opts)
|
266
266
|
# Copy an image.
|
267
267
|
# @param opts [Hash] Set of options
|
268
|
-
# @option opts [Boolean] :swap Swap bytes in image between little and big-endian
|
269
268
|
# @option opts [Integer] :width Image width in pixels
|
270
269
|
# @option opts [Integer] :height Image height in pixels
|
271
270
|
# @option opts [Integer] :bands Number of bands in image
|
@@ -301,9 +300,7 @@ module Vips
|
|
301
300
|
# @!method sequential(**opts)
|
302
301
|
# Check sequential access.
|
303
302
|
# @param opts [Hash] Set of options
|
304
|
-
# @option opts [Boolean] :trace trace pixel requests
|
305
303
|
# @option opts [Integer] :tile_height Tile height in pixels
|
306
|
-
# @option opts [Vips::Access] :access Expected access pattern
|
307
304
|
# @return [Vips::Image] Output image
|
308
305
|
|
309
306
|
# @!method cache(**opts)
|
@@ -590,21 +587,6 @@ module Vips
|
|
590
587
|
# @option opts [Integer] :seed Random number seed
|
591
588
|
# @return [Vips::Image] Output image
|
592
589
|
|
593
|
-
# @!method self.text(text, **opts)
|
594
|
-
# Make a text image.
|
595
|
-
# @param text [String] Text to render
|
596
|
-
# @param opts [Hash] Set of options
|
597
|
-
# @option opts [String] :font Font to render with
|
598
|
-
# @option opts [Integer] :width Maximum image width in pixels
|
599
|
-
# @option opts [Integer] :height Maximum image height in pixels
|
600
|
-
# @option opts [Vips::Align] :align Align on the low, centre or high edge
|
601
|
-
# @option opts [Integer] :dpi DPI to render at
|
602
|
-
# @option opts [Boolean] :justify Justify lines
|
603
|
-
# @option opts [Integer] :spacing Line spacing
|
604
|
-
# @option opts [String] :fontfile Load this font file
|
605
|
-
# @option opts [Integer] :autofit_dpi Output DPI selected by autofit
|
606
|
-
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
607
|
-
|
608
590
|
# @!method self.xyz(width, height, **opts)
|
609
591
|
# Make an image where pixel values are coordinates.
|
610
592
|
# @param width [Integer] Image width in pixels
|
@@ -621,7 +603,6 @@ module Vips
|
|
621
603
|
# @param min_ampl [Float] Minimum amplitude of Gaussian
|
622
604
|
# @param opts [Hash] Set of options
|
623
605
|
# @option opts [Boolean] :separable Generate separable Gaussian
|
624
|
-
# @option opts [Boolean] :integer Generate integer Gaussian
|
625
606
|
# @option opts [Vips::Precision] :precision Generate with this precision
|
626
607
|
# @return [Vips::Image] Output image
|
627
608
|
|
@@ -631,10 +612,25 @@ module Vips
|
|
631
612
|
# @param min_ampl [Float] Minimum amplitude of Logmatian
|
632
613
|
# @param opts [Hash] Set of options
|
633
614
|
# @option opts [Boolean] :separable Generate separable Logmatian
|
634
|
-
# @option opts [Boolean] :integer Generate integer Logmatian
|
635
615
|
# @option opts [Vips::Precision] :precision Generate with this precision
|
636
616
|
# @return [Vips::Image] Output image
|
637
617
|
|
618
|
+
# @!method self.text(text, **opts)
|
619
|
+
# Make a text image.
|
620
|
+
# @param text [String] Text to render
|
621
|
+
# @param opts [Hash] Set of options
|
622
|
+
# @option opts [String] :font Font to render with
|
623
|
+
# @option opts [Integer] :width Maximum image width in pixels
|
624
|
+
# @option opts [Integer] :height Maximum image height in pixels
|
625
|
+
# @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
|
+
# @option opts [Boolean] :justify Justify lines
|
629
|
+
# @option opts [Integer] :spacing Line spacing
|
630
|
+
# @option opts [String] :fontfile Load this font file
|
631
|
+
# @option opts [Integer] :autofit_dpi Output DPI selected by autofit
|
632
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
633
|
+
|
638
634
|
# @!method self.eye(width, height, **opts)
|
639
635
|
# Make an image showing the eye's spatial response.
|
640
636
|
# @param width [Integer] Image width in pixels
|
@@ -885,9 +881,7 @@ module Vips
|
|
885
881
|
# @option opts [String] :separator Set of separator characters
|
886
882
|
# @option opts [Boolean] :memory Force open via memory
|
887
883
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
888
|
-
# @option opts [
|
889
|
-
# @option opts [Boolean] :fail Fail on first error
|
890
|
-
# @option opts [Boolean] :disc Open to disc
|
884
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
891
885
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
892
886
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
893
887
|
|
@@ -901,9 +895,7 @@ module Vips
|
|
901
895
|
# @option opts [String] :separator Set of separator characters
|
902
896
|
# @option opts [Boolean] :memory Force open via memory
|
903
897
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
904
|
-
# @option opts [
|
905
|
-
# @option opts [Boolean] :fail Fail on first error
|
906
|
-
# @option opts [Boolean] :disc Open to disc
|
898
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
907
899
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
908
900
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
909
901
|
|
@@ -913,9 +905,7 @@ module Vips
|
|
913
905
|
# @param opts [Hash] Set of options
|
914
906
|
# @option opts [Boolean] :memory Force open via memory
|
915
907
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
916
|
-
# @option opts [
|
917
|
-
# @option opts [Boolean] :fail Fail on first error
|
918
|
-
# @option opts [Boolean] :disc Open to disc
|
908
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
919
909
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
920
910
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
921
911
|
|
@@ -925,9 +915,7 @@ module Vips
|
|
925
915
|
# @param opts [Hash] Set of options
|
926
916
|
# @option opts [Boolean] :memory Force open via memory
|
927
917
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
928
|
-
# @option opts [
|
929
|
-
# @option opts [Boolean] :fail Fail on first error
|
930
|
-
# @option opts [Boolean] :disc Open to disc
|
918
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
931
919
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
932
920
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
933
921
|
|
@@ -943,9 +931,7 @@ module Vips
|
|
943
931
|
# @option opts [Vips::Interpretation] :interpretation Pixel interpretation
|
944
932
|
# @option opts [Boolean] :memory Force open via memory
|
945
933
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
946
|
-
# @option opts [
|
947
|
-
# @option opts [Boolean] :fail Fail on first error
|
948
|
-
# @option opts [Boolean] :disc Open to disc
|
934
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
949
935
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
950
936
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
951
937
|
|
@@ -955,9 +941,17 @@ module Vips
|
|
955
941
|
# @param opts [Hash] Set of options
|
956
942
|
# @option opts [Boolean] :memory Force open via memory
|
957
943
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
958
|
-
# @option opts [
|
959
|
-
# @option opts [
|
960
|
-
# @
|
944
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
945
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
946
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
947
|
+
|
948
|
+
# @!method self.vipsload_source(source, **opts)
|
949
|
+
# Load vips from source.
|
950
|
+
# @param source [Vips::Source] Source to load from
|
951
|
+
# @param opts [Hash] Set of options
|
952
|
+
# @option opts [Boolean] :memory Force open via memory
|
953
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
954
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
961
955
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
962
956
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
963
957
|
|
@@ -967,9 +961,7 @@ module Vips
|
|
967
961
|
# @param opts [Hash] Set of options
|
968
962
|
# @option opts [Boolean] :memory Force open via memory
|
969
963
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
970
|
-
# @option opts [
|
971
|
-
# @option opts [Boolean] :fail Fail on first error
|
972
|
-
# @option opts [Boolean] :disc Open to disc
|
964
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
973
965
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
974
966
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
975
967
|
|
@@ -979,9 +971,7 @@ module Vips
|
|
979
971
|
# @param opts [Hash] Set of options
|
980
972
|
# @option opts [Boolean] :memory Force open via memory
|
981
973
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
982
|
-
# @option opts [
|
983
|
-
# @option opts [Boolean] :fail Fail on first error
|
984
|
-
# @option opts [Boolean] :disc Open to disc
|
974
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
985
975
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
986
976
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
987
977
|
|
@@ -991,9 +981,7 @@ module Vips
|
|
991
981
|
# @param opts [Hash] Set of options
|
992
982
|
# @option opts [Boolean] :memory Force open via memory
|
993
983
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
994
|
-
# @option opts [
|
995
|
-
# @option opts [Boolean] :fail Fail on first error
|
996
|
-
# @option opts [Boolean] :disc Open to disc
|
984
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
997
985
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
998
986
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
999
987
|
|
@@ -1003,9 +991,7 @@ module Vips
|
|
1003
991
|
# @param opts [Hash] Set of options
|
1004
992
|
# @option opts [Boolean] :memory Force open via memory
|
1005
993
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1006
|
-
# @option opts [
|
1007
|
-
# @option opts [Boolean] :fail Fail on first error
|
1008
|
-
# @option opts [Boolean] :disc Open to disc
|
994
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1009
995
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1010
996
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1011
997
|
|
@@ -1015,9 +1001,7 @@ module Vips
|
|
1015
1001
|
# @param opts [Hash] Set of options
|
1016
1002
|
# @option opts [Boolean] :memory Force open via memory
|
1017
1003
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1018
|
-
# @option opts [
|
1019
|
-
# @option opts [Boolean] :fail Fail on first error
|
1020
|
-
# @option opts [Boolean] :disc Open to disc
|
1004
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1021
1005
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1022
1006
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1023
1007
|
|
@@ -1027,9 +1011,7 @@ module Vips
|
|
1027
1011
|
# @param opts [Hash] Set of options
|
1028
1012
|
# @option opts [Boolean] :memory Force open via memory
|
1029
1013
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1030
|
-
# @option opts [
|
1031
|
-
# @option opts [Boolean] :fail Fail on first error
|
1032
|
-
# @option opts [Boolean] :disc Open to disc
|
1014
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1033
1015
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1034
1016
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1035
1017
|
|
@@ -1044,9 +1026,7 @@ module Vips
|
|
1044
1026
|
# @option opts [Array<Double>] :background Background value
|
1045
1027
|
# @option opts [Boolean] :memory Force open via memory
|
1046
1028
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1047
|
-
# @option opts [
|
1048
|
-
# @option opts [Boolean] :fail Fail on first error
|
1049
|
-
# @option opts [Boolean] :disc Open to disc
|
1029
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1050
1030
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1051
1031
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1052
1032
|
|
@@ -1061,9 +1041,7 @@ module Vips
|
|
1061
1041
|
# @option opts [Array<Double>] :background Background value
|
1062
1042
|
# @option opts [Boolean] :memory Force open via memory
|
1063
1043
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1064
|
-
# @option opts [
|
1065
|
-
# @option opts [Boolean] :fail Fail on first error
|
1066
|
-
# @option opts [Boolean] :disc Open to disc
|
1044
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1067
1045
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1068
1046
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1069
1047
|
|
@@ -1078,9 +1056,7 @@ module Vips
|
|
1078
1056
|
# @option opts [Array<Double>] :background Background value
|
1079
1057
|
# @option opts [Boolean] :memory Force open via memory
|
1080
1058
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1081
|
-
# @option opts [
|
1082
|
-
# @option opts [Boolean] :fail Fail on first error
|
1083
|
-
# @option opts [Boolean] :disc Open to disc
|
1059
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1084
1060
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1085
1061
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1086
1062
|
|
@@ -1093,9 +1069,7 @@ module Vips
|
|
1093
1069
|
# @option opts [Boolean] :unlimited Allow SVG of any size
|
1094
1070
|
# @option opts [Boolean] :memory Force open via memory
|
1095
1071
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1096
|
-
# @option opts [
|
1097
|
-
# @option opts [Boolean] :fail Fail on first error
|
1098
|
-
# @option opts [Boolean] :disc Open to disc
|
1072
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1099
1073
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1100
1074
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1101
1075
|
|
@@ -1108,9 +1082,7 @@ module Vips
|
|
1108
1082
|
# @option opts [Boolean] :unlimited Allow SVG of any size
|
1109
1083
|
# @option opts [Boolean] :memory Force open via memory
|
1110
1084
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1111
|
-
# @option opts [
|
1112
|
-
# @option opts [Boolean] :fail Fail on first error
|
1113
|
-
# @option opts [Boolean] :disc Open to disc
|
1085
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1114
1086
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1115
1087
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1116
1088
|
|
@@ -1123,51 +1095,106 @@ module Vips
|
|
1123
1095
|
# @option opts [Boolean] :unlimited Allow SVG of any size
|
1124
1096
|
# @option opts [Boolean] :memory Force open via memory
|
1125
1097
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1126
|
-
# @option opts [
|
1127
|
-
# @option opts [
|
1128
|
-
# @
|
1098
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1099
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
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
|
1129
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1130
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1131
|
+
|
1132
|
+
# @!method self.jp2kload(filename, **opts)
|
1133
|
+
# Load jpeg2000 image.
|
1134
|
+
# @param filename [String] Filename to load from
|
1135
|
+
# @param opts [Hash] Set of options
|
1136
|
+
# @option opts [Integer] :page Load this page from the image
|
1137
|
+
# @option opts [Boolean] :memory Force open via memory
|
1138
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1139
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1140
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1141
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1142
|
+
|
1143
|
+
# @!method self.jp2kload_buffer(buffer, **opts)
|
1144
|
+
# Load jpeg2000 image.
|
1145
|
+
# @param buffer [VipsBlob] Buffer to load from
|
1146
|
+
# @param opts [Hash] Set of options
|
1147
|
+
# @option opts [Integer] :page Load this page from the image
|
1148
|
+
# @option opts [Boolean] :memory Force open via memory
|
1149
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1150
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1151
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1152
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1153
|
+
|
1154
|
+
# @!method self.jp2kload_source(source, **opts)
|
1155
|
+
# Load jpeg2000 image.
|
1156
|
+
# @param source [Vips::Source] Source to load from
|
1157
|
+
# @param opts [Hash] Set of options
|
1158
|
+
# @option opts [Integer] :page Load this page from the image
|
1159
|
+
# @option opts [Boolean] :memory Force open via memory
|
1160
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1161
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1129
1162
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1130
1163
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1131
1164
|
|
1132
1165
|
# @!method self.gifload(filename, **opts)
|
1133
|
-
# Load gif with
|
1166
|
+
# Load gif with libnsgif.
|
1134
1167
|
# @param filename [String] Filename to load from
|
1135
1168
|
# @param opts [Hash] Set of options
|
1136
|
-
# @option opts [Integer] :page Load this page from the file
|
1137
1169
|
# @option opts [Integer] :n Load this many pages
|
1170
|
+
# @option opts [Integer] :page Load this page from the file
|
1138
1171
|
# @option opts [Boolean] :memory Force open via memory
|
1139
1172
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1140
|
-
# @option opts [
|
1141
|
-
# @option opts [Boolean] :fail Fail on first error
|
1142
|
-
# @option opts [Boolean] :disc Open to disc
|
1173
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1143
1174
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1144
1175
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1145
1176
|
|
1146
1177
|
# @!method self.gifload_buffer(buffer, **opts)
|
1147
|
-
# Load gif with
|
1178
|
+
# Load gif with libnsgif.
|
1148
1179
|
# @param buffer [VipsBlob] Buffer to load from
|
1149
1180
|
# @param opts [Hash] Set of options
|
1150
|
-
# @option opts [Integer] :page Load this page from the file
|
1151
1181
|
# @option opts [Integer] :n Load this many pages
|
1182
|
+
# @option opts [Integer] :page Load this page from the file
|
1152
1183
|
# @option opts [Boolean] :memory Force open via memory
|
1153
1184
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1154
|
-
# @option opts [
|
1155
|
-
# @option opts [Boolean] :fail Fail on first error
|
1156
|
-
# @option opts [Boolean] :disc Open to disc
|
1185
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1157
1186
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1158
1187
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1159
1188
|
|
1160
1189
|
# @!method self.gifload_source(source, **opts)
|
1161
|
-
# Load gif
|
1190
|
+
# Load gif from source.
|
1162
1191
|
# @param source [Vips::Source] Source to load from
|
1163
1192
|
# @param opts [Hash] Set of options
|
1164
|
-
# @option opts [Integer] :page Load this page from the file
|
1165
1193
|
# @option opts [Integer] :n Load this many pages
|
1194
|
+
# @option opts [Integer] :page Load this page from the file
|
1166
1195
|
# @option opts [Boolean] :memory Force open via memory
|
1167
1196
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1168
|
-
# @option opts [
|
1169
|
-
# @option opts [Boolean] :fail Fail on first error
|
1170
|
-
# @option opts [Boolean] :disc Open to disc
|
1197
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1171
1198
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1172
1199
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1173
1200
|
|
@@ -1175,11 +1202,10 @@ module Vips
|
|
1175
1202
|
# Load png from file.
|
1176
1203
|
# @param filename [String] Filename to load from
|
1177
1204
|
# @param opts [Hash] Set of options
|
1205
|
+
# @option opts [Boolean] :unlimited Remove all denial of service limits
|
1178
1206
|
# @option opts [Boolean] :memory Force open via memory
|
1179
1207
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1180
|
-
# @option opts [
|
1181
|
-
# @option opts [Boolean] :fail Fail on first error
|
1182
|
-
# @option opts [Boolean] :disc Open to disc
|
1208
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1183
1209
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1184
1210
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1185
1211
|
|
@@ -1187,11 +1213,10 @@ module Vips
|
|
1187
1213
|
# Load png from buffer.
|
1188
1214
|
# @param buffer [VipsBlob] Buffer to load from
|
1189
1215
|
# @param opts [Hash] Set of options
|
1216
|
+
# @option opts [Boolean] :unlimited Remove all denial of service limits
|
1190
1217
|
# @option opts [Boolean] :memory Force open via memory
|
1191
1218
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1192
|
-
# @option opts [
|
1193
|
-
# @option opts [Boolean] :fail Fail on first error
|
1194
|
-
# @option opts [Boolean] :disc Open to disc
|
1219
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1195
1220
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1196
1221
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1197
1222
|
|
@@ -1199,11 +1224,10 @@ module Vips
|
|
1199
1224
|
# Load png from source.
|
1200
1225
|
# @param source [Vips::Source] Source to load from
|
1201
1226
|
# @param opts [Hash] Set of options
|
1227
|
+
# @option opts [Boolean] :unlimited Remove all denial of service limits
|
1202
1228
|
# @option opts [Boolean] :memory Force open via memory
|
1203
1229
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1204
|
-
# @option opts [
|
1205
|
-
# @option opts [Boolean] :fail Fail on first error
|
1206
|
-
# @option opts [Boolean] :disc Open to disc
|
1230
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1207
1231
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1208
1232
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1209
1233
|
|
@@ -1213,9 +1237,7 @@ module Vips
|
|
1213
1237
|
# @param opts [Hash] Set of options
|
1214
1238
|
# @option opts [Boolean] :memory Force open via memory
|
1215
1239
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1216
|
-
# @option opts [
|
1217
|
-
# @option opts [Boolean] :fail Fail on first error
|
1218
|
-
# @option opts [Boolean] :disc Open to disc
|
1240
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1219
1241
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1220
1242
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1221
1243
|
|
@@ -1227,9 +1249,7 @@ module Vips
|
|
1227
1249
|
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1228
1250
|
# @option opts [Boolean] :memory Force open via memory
|
1229
1251
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1230
|
-
# @option opts [
|
1231
|
-
# @option opts [Boolean] :fail Fail on first error
|
1232
|
-
# @option opts [Boolean] :disc Open to disc
|
1252
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1233
1253
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1234
1254
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1235
1255
|
|
@@ -1241,9 +1261,7 @@ module Vips
|
|
1241
1261
|
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1242
1262
|
# @option opts [Boolean] :memory Force open via memory
|
1243
1263
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1244
|
-
# @option opts [
|
1245
|
-
# @option opts [Boolean] :fail Fail on first error
|
1246
|
-
# @option opts [Boolean] :disc Open to disc
|
1264
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1247
1265
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1248
1266
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1249
1267
|
|
@@ -1255,9 +1273,7 @@ module Vips
|
|
1255
1273
|
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1256
1274
|
# @option opts [Boolean] :memory Force open via memory
|
1257
1275
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1258
|
-
# @option opts [
|
1259
|
-
# @option opts [Boolean] :fail Fail on first error
|
1260
|
-
# @option opts [Boolean] :disc Open to disc
|
1276
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1261
1277
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1262
1278
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1263
1279
|
|
@@ -1268,12 +1284,9 @@ module Vips
|
|
1268
1284
|
# @option opts [Integer] :page Load this page from the file
|
1269
1285
|
# @option opts [Integer] :n Load this many pages
|
1270
1286
|
# @option opts [Float] :scale Scale factor on load
|
1271
|
-
# @option opts [Integer] :shrink Shrink factor on load
|
1272
1287
|
# @option opts [Boolean] :memory Force open via memory
|
1273
1288
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1274
|
-
# @option opts [
|
1275
|
-
# @option opts [Boolean] :fail Fail on first error
|
1276
|
-
# @option opts [Boolean] :disc Open to disc
|
1289
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1277
1290
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1278
1291
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1279
1292
|
|
@@ -1284,12 +1297,9 @@ module Vips
|
|
1284
1297
|
# @option opts [Integer] :page Load this page from the file
|
1285
1298
|
# @option opts [Integer] :n Load this many pages
|
1286
1299
|
# @option opts [Float] :scale Scale factor on load
|
1287
|
-
# @option opts [Integer] :shrink Shrink factor on load
|
1288
1300
|
# @option opts [Boolean] :memory Force open via memory
|
1289
1301
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1290
|
-
# @option opts [
|
1291
|
-
# @option opts [Boolean] :fail Fail on first error
|
1292
|
-
# @option opts [Boolean] :disc Open to disc
|
1302
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1293
1303
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1294
1304
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1295
1305
|
|
@@ -1300,12 +1310,9 @@ module Vips
|
|
1300
1310
|
# @option opts [Integer] :page Load this page from the file
|
1301
1311
|
# @option opts [Integer] :n Load this many pages
|
1302
1312
|
# @option opts [Float] :scale Scale factor on load
|
1303
|
-
# @option opts [Integer] :shrink Shrink factor on load
|
1304
1313
|
# @option opts [Boolean] :memory Force open via memory
|
1305
1314
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1306
|
-
# @option opts [
|
1307
|
-
# @option opts [Boolean] :fail Fail on first error
|
1308
|
-
# @option opts [Boolean] :disc Open to disc
|
1315
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1309
1316
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1310
1317
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1311
1318
|
|
@@ -1319,9 +1326,7 @@ module Vips
|
|
1319
1326
|
# @option opts [Boolean] :autorotate Rotate image using orientation tag
|
1320
1327
|
# @option opts [Boolean] :memory Force open via memory
|
1321
1328
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1322
|
-
# @option opts [
|
1323
|
-
# @option opts [Boolean] :fail Fail on first error
|
1324
|
-
# @option opts [Boolean] :disc Open to disc
|
1329
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1325
1330
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1326
1331
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1327
1332
|
|
@@ -1335,9 +1340,7 @@ module Vips
|
|
1335
1340
|
# @option opts [Boolean] :autorotate Rotate image using orientation tag
|
1336
1341
|
# @option opts [Boolean] :memory Force open via memory
|
1337
1342
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1338
|
-
# @option opts [
|
1339
|
-
# @option opts [Boolean] :fail Fail on first error
|
1340
|
-
# @option opts [Boolean] :disc Open to disc
|
1343
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1341
1344
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1342
1345
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1343
1346
|
|
@@ -1351,9 +1354,7 @@ module Vips
|
|
1351
1354
|
# @option opts [Boolean] :autorotate Rotate image using orientation tag
|
1352
1355
|
# @option opts [Boolean] :memory Force open via memory
|
1353
1356
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1354
|
-
# @option opts [
|
1355
|
-
# @option opts [Boolean] :fail Fail on first error
|
1356
|
-
# @option opts [Boolean] :disc Open to disc
|
1357
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1357
1358
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1358
1359
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1359
1360
|
|
@@ -1361,15 +1362,27 @@ module Vips
|
|
1361
1362
|
# Load file with openslide.
|
1362
1363
|
# @param filename [String] Filename to load from
|
1363
1364
|
# @param opts [Hash] Set of options
|
1364
|
-
# @option opts [Boolean] :attach_associated Attach all
|
1365
|
+
# @option opts [Boolean] :attach_associated Attach all associated images
|
1365
1366
|
# @option opts [Integer] :level Load this level from the file
|
1366
1367
|
# @option opts [Boolean] :autocrop Crop to image bounds
|
1367
1368
|
# @option opts [String] :associated Load this associated image
|
1368
1369
|
# @option opts [Boolean] :memory Force open via memory
|
1369
1370
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1370
|
-
# @option opts [
|
1371
|
-
# @option opts [
|
1372
|
-
# @
|
1371
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1372
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1373
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1374
|
+
|
1375
|
+
# @!method self.openslideload_source(source, **opts)
|
1376
|
+
# Load source with openslide.
|
1377
|
+
# @param source [Vips::Source] Source to load from
|
1378
|
+
# @param opts [Hash] Set of options
|
1379
|
+
# @option opts [Boolean] :attach_associated Attach all associated images
|
1380
|
+
# @option opts [Integer] :level Load this level from the file
|
1381
|
+
# @option opts [Boolean] :autocrop Crop to image bounds
|
1382
|
+
# @option opts [String] :associated Load this associated image
|
1383
|
+
# @option opts [Boolean] :memory Force open via memory
|
1384
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1385
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1373
1386
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1374
1387
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1375
1388
|
|
@@ -1377,15 +1390,12 @@ module Vips
|
|
1377
1390
|
# Load file with imagemagick.
|
1378
1391
|
# @param filename [String] Filename to load from
|
1379
1392
|
# @param opts [Hash] Set of options
|
1380
|
-
# @option opts [Boolean] :all_frames Read all frames from an image
|
1381
1393
|
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
|
1382
1394
|
# @option opts [Integer] :page Load this page from the file
|
1383
1395
|
# @option opts [Integer] :n Load this many pages
|
1384
1396
|
# @option opts [Boolean] :memory Force open via memory
|
1385
1397
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1386
|
-
# @option opts [
|
1387
|
-
# @option opts [Boolean] :fail Fail on first error
|
1388
|
-
# @option opts [Boolean] :disc Open to disc
|
1398
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1389
1399
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1390
1400
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1391
1401
|
|
@@ -1393,15 +1403,12 @@ module Vips
|
|
1393
1403
|
# Load buffer with imagemagick.
|
1394
1404
|
# @param buffer [VipsBlob] Buffer to load from
|
1395
1405
|
# @param opts [Hash] Set of options
|
1396
|
-
# @option opts [Boolean] :all_frames Read all frames from an image
|
1397
1406
|
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
|
1398
1407
|
# @option opts [Integer] :page Load this page from the file
|
1399
1408
|
# @option opts [Integer] :n Load this many pages
|
1400
1409
|
# @option opts [Boolean] :memory Force open via memory
|
1401
1410
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1402
|
-
# @option opts [
|
1403
|
-
# @option opts [Boolean] :fail Fail on first error
|
1404
|
-
# @option opts [Boolean] :disc Open to disc
|
1411
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1405
1412
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1406
1413
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1407
1414
|
|
@@ -1411,9 +1418,17 @@ module Vips
|
|
1411
1418
|
# @param opts [Hash] Set of options
|
1412
1419
|
# @option opts [Boolean] :memory Force open via memory
|
1413
1420
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1414
|
-
# @option opts [
|
1415
|
-
# @option opts [
|
1416
|
-
# @
|
1421
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1422
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1423
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1424
|
+
|
1425
|
+
# @!method self.fitsload_source(source, **opts)
|
1426
|
+
# Load fits from a source.
|
1427
|
+
# @param source [Vips::Source] Source to load from
|
1428
|
+
# @param opts [Hash] Set of options
|
1429
|
+
# @option opts [Boolean] :memory Force open via memory
|
1430
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1431
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1417
1432
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1418
1433
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1419
1434
|
|
@@ -1423,21 +1438,27 @@ module Vips
|
|
1423
1438
|
# @param opts [Hash] Set of options
|
1424
1439
|
# @option opts [Boolean] :memory Force open via memory
|
1425
1440
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1426
|
-
# @option opts [
|
1427
|
-
# @option opts [Boolean] :fail Fail on first error
|
1428
|
-
# @option opts [Boolean] :disc Open to disc
|
1441
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1429
1442
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1430
1443
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1431
1444
|
|
1432
1445
|
# @!method self.niftiload(filename, **opts)
|
1433
|
-
# Load
|
1446
|
+
# Load nifti volume.
|
1434
1447
|
# @param filename [String] Filename to load from
|
1435
1448
|
# @param opts [Hash] Set of options
|
1436
1449
|
# @option opts [Boolean] :memory Force open via memory
|
1437
1450
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1438
|
-
# @option opts [
|
1439
|
-
# @option opts [
|
1440
|
-
# @
|
1451
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1452
|
+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1453
|
+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1454
|
+
|
1455
|
+
# @!method self.niftiload_source(source, **opts)
|
1456
|
+
# Load nifti volumes.
|
1457
|
+
# @param source [Vips::Source] Source to load from
|
1458
|
+
# @param opts [Hash] Set of options
|
1459
|
+
# @option opts [Boolean] :memory Force open via memory
|
1460
|
+
# @option opts [Vips::Access] :access Required access pattern for this file
|
1461
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1441
1462
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1442
1463
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1443
1464
|
|
@@ -1448,12 +1469,9 @@ module Vips
|
|
1448
1469
|
# @option opts [Integer] :page Load this page from the file
|
1449
1470
|
# @option opts [Integer] :n Load this many pages
|
1450
1471
|
# @option opts [Boolean] :thumbnail Fetch thumbnail image
|
1451
|
-
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1452
1472
|
# @option opts [Boolean] :memory Force open via memory
|
1453
1473
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1454
|
-
# @option opts [
|
1455
|
-
# @option opts [Boolean] :fail Fail on first error
|
1456
|
-
# @option opts [Boolean] :disc Open to disc
|
1474
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1457
1475
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1458
1476
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1459
1477
|
|
@@ -1464,12 +1482,9 @@ module Vips
|
|
1464
1482
|
# @option opts [Integer] :page Load this page from the file
|
1465
1483
|
# @option opts [Integer] :n Load this many pages
|
1466
1484
|
# @option opts [Boolean] :thumbnail Fetch thumbnail image
|
1467
|
-
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1468
1485
|
# @option opts [Boolean] :memory Force open via memory
|
1469
1486
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1470
|
-
# @option opts [
|
1471
|
-
# @option opts [Boolean] :fail Fail on first error
|
1472
|
-
# @option opts [Boolean] :disc Open to disc
|
1487
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1473
1488
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1474
1489
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1475
1490
|
|
@@ -1480,12 +1495,9 @@ module Vips
|
|
1480
1495
|
# @option opts [Integer] :page Load this page from the file
|
1481
1496
|
# @option opts [Integer] :n Load this many pages
|
1482
1497
|
# @option opts [Boolean] :thumbnail Fetch thumbnail image
|
1483
|
-
# @option opts [Boolean] :autorotate Rotate image using exif orientation
|
1484
1498
|
# @option opts [Boolean] :memory Force open via memory
|
1485
1499
|
# @option opts [Vips::Access] :access Required access pattern for this file
|
1486
|
-
# @option opts [
|
1487
|
-
# @option opts [Boolean] :fail Fail on first error
|
1488
|
-
# @option opts [Boolean] :disc Open to disc
|
1500
|
+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
|
1489
1501
|
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
|
1490
1502
|
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
|
1491
1503
|
|
@@ -1554,7 +1566,7 @@ module Vips
|
|
1554
1566
|
# @return [nil]
|
1555
1567
|
|
1556
1568
|
# @!method vipssave(filename, **opts)
|
1557
|
-
# Save image to vips
|
1569
|
+
# Save image to file in vips format.
|
1558
1570
|
# @param filename [String] Filename to save to
|
1559
1571
|
# @param opts [Hash] Set of options
|
1560
1572
|
# @option opts [Boolean] :strip Strip all metadata from image
|
@@ -1562,12 +1574,21 @@ module Vips
|
|
1562
1574
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1563
1575
|
# @return [nil]
|
1564
1576
|
|
1577
|
+
# @!method vipssave_target(target, **opts)
|
1578
|
+
# Save image to target in vips format.
|
1579
|
+
# @param target [Vips::Target] Target to save to
|
1580
|
+
# @param opts [Hash] Set of options
|
1581
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1582
|
+
# @option opts [Array<Double>] :background Background value
|
1583
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1584
|
+
# @return [nil]
|
1585
|
+
|
1565
1586
|
# @!method ppmsave(filename, **opts)
|
1566
1587
|
# Save image to ppm file.
|
1567
1588
|
# @param filename [String] Filename to save to
|
1568
1589
|
# @param opts [Hash] Set of options
|
1590
|
+
# @option opts [Vips::ForeignPpmFormat] :format Format to save in
|
1569
1591
|
# @option opts [Boolean] :ascii save as ascii
|
1570
|
-
# @option opts [Boolean] :squash save as one bit
|
1571
1592
|
# @option opts [Integer] :bitdepth set to 1 to write as a 1 bit image
|
1572
1593
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1573
1594
|
# @option opts [Array<Double>] :background Background value
|
@@ -1578,8 +1599,8 @@ module Vips
|
|
1578
1599
|
# Save to ppm.
|
1579
1600
|
# @param target [Vips::Target] Target to save to
|
1580
1601
|
# @param opts [Hash] Set of options
|
1602
|
+
# @option opts [Vips::ForeignPpmFormat] :format Format to save in
|
1581
1603
|
# @option opts [Boolean] :ascii save as ascii
|
1582
|
-
# @option opts [Boolean] :squash save as one bit
|
1583
1604
|
# @option opts [Integer] :bitdepth set to 1 to write as a 1 bit image
|
1584
1605
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1585
1606
|
# @option opts [Array<Double>] :background Background value
|
@@ -1612,18 +1633,132 @@ module Vips
|
|
1612
1633
|
# @option opts [Integer] :page_height Set page height for multipage save
|
1613
1634
|
# @return [nil]
|
1614
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
|
1673
|
+
# @option opts [Array<Double>] :background Background value
|
1674
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1675
|
+
# @return [nil]
|
1676
|
+
|
1677
|
+
# @!method jp2ksave(filename, **opts)
|
1678
|
+
# Save image in jpeg2000 format.
|
1679
|
+
# @param filename [String] Filename to load from
|
1680
|
+
# @param opts [Hash] Set of options
|
1681
|
+
# @option opts [Integer] :tile_width Tile width in pixels
|
1682
|
+
# @option opts [Integer] :tile_height Tile height in pixels
|
1683
|
+
# @option opts [Boolean] :lossless Enable lossless compression
|
1684
|
+
# @option opts [Integer] :Q Q factor
|
1685
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1686
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1687
|
+
# @option opts [Array<Double>] :background Background value
|
1688
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1689
|
+
# @return [nil]
|
1690
|
+
|
1691
|
+
# @!method jp2ksave_buffer(**opts)
|
1692
|
+
# Save image in jpeg2000 format.
|
1693
|
+
# @param opts [Hash] Set of options
|
1694
|
+
# @option opts [Integer] :tile_width Tile width in pixels
|
1695
|
+
# @option opts [Integer] :tile_height Tile height in pixels
|
1696
|
+
# @option opts [Boolean] :lossless Enable lossless compression
|
1697
|
+
# @option opts [Integer] :Q Q factor
|
1698
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1699
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1700
|
+
# @option opts [Array<Double>] :background Background value
|
1701
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1702
|
+
# @return [VipsBlob] Buffer to save to
|
1703
|
+
|
1704
|
+
# @!method jp2ksave_target(target, **opts)
|
1705
|
+
# Save image in jpeg2000 format.
|
1706
|
+
# @param target [Vips::Target] Target to save to
|
1707
|
+
# @param opts [Hash] Set of options
|
1708
|
+
# @option opts [Integer] :tile_width Tile width in pixels
|
1709
|
+
# @option opts [Integer] :tile_height Tile height in pixels
|
1710
|
+
# @option opts [Boolean] :lossless Enable lossless compression
|
1711
|
+
# @option opts [Integer] :Q Q factor
|
1712
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1713
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1714
|
+
# @option opts [Array<Double>] :background Background value
|
1715
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1716
|
+
# @return [nil]
|
1717
|
+
|
1718
|
+
# @!method gifsave(filename, **opts)
|
1719
|
+
# Save as gif.
|
1720
|
+
# @param filename [String] Filename to save to
|
1721
|
+
# @param opts [Hash] Set of options
|
1722
|
+
# @option opts [Float] :dither Amount of dithering
|
1723
|
+
# @option opts [Integer] :effort Quantisation effort
|
1724
|
+
# @option opts [Integer] :bitdepth Number of bits per pixel
|
1725
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1726
|
+
# @option opts [Array<Double>] :background Background value
|
1727
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1728
|
+
# @return [nil]
|
1729
|
+
|
1730
|
+
# @!method gifsave_buffer(**opts)
|
1731
|
+
# Save as gif.
|
1732
|
+
# @param opts [Hash] Set of options
|
1733
|
+
# @option opts [Float] :dither Amount of dithering
|
1734
|
+
# @option opts [Integer] :effort Quantisation effort
|
1735
|
+
# @option opts [Integer] :bitdepth Number of bits per pixel
|
1736
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1737
|
+
# @option opts [Array<Double>] :background Background value
|
1738
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1739
|
+
# @return [VipsBlob] Buffer to save to
|
1740
|
+
|
1741
|
+
# @!method gifsave_target(target, **opts)
|
1742
|
+
# Save as gif.
|
1743
|
+
# @param target [Vips::Target] Target to save to
|
1744
|
+
# @param opts [Hash] Set of options
|
1745
|
+
# @option opts [Float] :dither Amount of dithering
|
1746
|
+
# @option opts [Integer] :effort Quantisation effort
|
1747
|
+
# @option opts [Integer] :bitdepth Number of bits per pixel
|
1748
|
+
# @option opts [Boolean] :strip Strip all metadata from image
|
1749
|
+
# @option opts [Array<Double>] :background Background value
|
1750
|
+
# @option opts [Integer] :page_height Set page height for multipage save
|
1751
|
+
# @return [nil]
|
1752
|
+
|
1615
1753
|
# @!method dzsave(filename, **opts)
|
1616
1754
|
# Save image to deepzoom file.
|
1617
1755
|
# @param filename [String] Filename to save to
|
1618
1756
|
# @param opts [Hash] Set of options
|
1619
|
-
# @option opts [String] :dirname Directory name to save to
|
1620
1757
|
# @option opts [String] :basename Base name to save to
|
1621
1758
|
# @option opts [Vips::ForeignDzLayout] :layout Directory layout
|
1622
1759
|
# @option opts [String] :suffix Filename suffix for tiles
|
1623
1760
|
# @option opts [Integer] :overlap Tile overlap in pixels
|
1624
1761
|
# @option opts [Integer] :tile_size Tile size in pixels
|
1625
|
-
# @option opts [Integer] :tile_height Tile height in pixels
|
1626
|
-
# @option opts [Integer] :tile_width Tile width in pixels
|
1627
1762
|
# @option opts [Boolean] :centre Center image in tile
|
1628
1763
|
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
1629
1764
|
# @option opts [Vips::Angle] :angle Rotate image during save
|
@@ -1642,14 +1777,11 @@ module Vips
|
|
1642
1777
|
# @!method dzsave_buffer(**opts)
|
1643
1778
|
# Save image to dz buffer.
|
1644
1779
|
# @param opts [Hash] Set of options
|
1645
|
-
# @option opts [String] :dirname Directory name to save to
|
1646
1780
|
# @option opts [String] :basename Base name to save to
|
1647
1781
|
# @option opts [Vips::ForeignDzLayout] :layout Directory layout
|
1648
1782
|
# @option opts [String] :suffix Filename suffix for tiles
|
1649
1783
|
# @option opts [Integer] :overlap Tile overlap in pixels
|
1650
1784
|
# @option opts [Integer] :tile_size Tile size in pixels
|
1651
|
-
# @option opts [Integer] :tile_height Tile height in pixels
|
1652
|
-
# @option opts [Integer] :tile_width Tile width in pixels
|
1653
1785
|
# @option opts [Boolean] :centre Center image in tile
|
1654
1786
|
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
1655
1787
|
# @option opts [Vips::Angle] :angle Rotate image during save
|
@@ -1674,10 +1806,10 @@ module Vips
|
|
1674
1806
|
# @option opts [String] :profile ICC profile to embed
|
1675
1807
|
# @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
|
1676
1808
|
# @option opts [Boolean] :palette Quantise to 8bpp palette
|
1677
|
-
# @option opts [Integer] :colours Max number of palette colours
|
1678
1809
|
# @option opts [Integer] :Q Quantisation quality
|
1679
1810
|
# @option opts [Float] :dither Amount of dithering
|
1680
1811
|
# @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
|
1812
|
+
# @option opts [Integer] :effort Quantisation CPU effort
|
1681
1813
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1682
1814
|
# @option opts [Array<Double>] :background Background value
|
1683
1815
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1691,10 +1823,10 @@ module Vips
|
|
1691
1823
|
# @option opts [String] :profile ICC profile to embed
|
1692
1824
|
# @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
|
1693
1825
|
# @option opts [Boolean] :palette Quantise to 8bpp palette
|
1694
|
-
# @option opts [Integer] :colours Max number of palette colours
|
1695
1826
|
# @option opts [Integer] :Q Quantisation quality
|
1696
1827
|
# @option opts [Float] :dither Amount of dithering
|
1697
1828
|
# @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
|
1829
|
+
# @option opts [Integer] :effort Quantisation CPU effort
|
1698
1830
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1699
1831
|
# @option opts [Array<Double>] :background Background value
|
1700
1832
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1709,10 +1841,10 @@ module Vips
|
|
1709
1841
|
# @option opts [String] :profile ICC profile to embed
|
1710
1842
|
# @option opts [Vips::ForeignPngFilter] :filter libpng row filter flag(s)
|
1711
1843
|
# @option opts [Boolean] :palette Quantise to 8bpp palette
|
1712
|
-
# @option opts [Integer] :colours Max number of palette colours
|
1713
1844
|
# @option opts [Integer] :Q Quantisation quality
|
1714
1845
|
# @option opts [Float] :dither Amount of dithering
|
1715
1846
|
# @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
|
1847
|
+
# @option opts [Integer] :effort Quantisation CPU effort
|
1716
1848
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1717
1849
|
# @option opts [Array<Double>] :background Background value
|
1718
1850
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1726,12 +1858,12 @@ module Vips
|
|
1726
1858
|
# @option opts [String] :profile ICC profile to embed
|
1727
1859
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
1728
1860
|
# @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
|
1729
|
-
# @option opts [Boolean] :no_subsample Disable chroma subsample
|
1730
1861
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
1731
1862
|
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
|
1732
1863
|
# @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
|
1733
1864
|
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1734
|
-
# @option opts [Vips::
|
1865
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1866
|
+
# @option opts [Integer] :restart_interval Add restart markers every specified number of mcu
|
1735
1867
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1736
1868
|
# @option opts [Array<Double>] :background Background value
|
1737
1869
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1744,12 +1876,12 @@ module Vips
|
|
1744
1876
|
# @option opts [String] :profile ICC profile to embed
|
1745
1877
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
1746
1878
|
# @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
|
1747
|
-
# @option opts [Boolean] :no_subsample Disable chroma subsample
|
1748
1879
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
1749
1880
|
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
|
1750
1881
|
# @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
|
1751
1882
|
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1752
|
-
# @option opts [Vips::
|
1883
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1884
|
+
# @option opts [Integer] :restart_interval Add restart markers every specified number of mcu
|
1753
1885
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1754
1886
|
# @option opts [Array<Double>] :background Background value
|
1755
1887
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1763,12 +1895,12 @@ module Vips
|
|
1763
1895
|
# @option opts [String] :profile ICC profile to embed
|
1764
1896
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
1765
1897
|
# @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
|
1766
|
-
# @option opts [Boolean] :no_subsample Disable chroma subsample
|
1767
1898
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
1768
1899
|
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
|
1769
1900
|
# @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
|
1770
1901
|
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1771
|
-
# @option opts [Vips::
|
1902
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1903
|
+
# @option opts [Integer] :restart_interval Add restart markers every specified number of mcu
|
1772
1904
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1773
1905
|
# @option opts [Array<Double>] :background Background value
|
1774
1906
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1781,12 +1913,12 @@ module Vips
|
|
1781
1913
|
# @option opts [String] :profile ICC profile to embed
|
1782
1914
|
# @option opts [Boolean] :optimize_coding Compute optimal Huffman coding tables
|
1783
1915
|
# @option opts [Boolean] :interlace Generate an interlaced (progressive) jpeg
|
1784
|
-
# @option opts [Boolean] :no_subsample Disable chroma subsample
|
1785
1916
|
# @option opts [Boolean] :trellis_quant Apply trellis quantisation to each 8x8 block
|
1786
1917
|
# @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
|
1787
1918
|
# @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
|
1788
1919
|
# @option opts [Integer] :quant_table Use predefined quantization table with given index
|
1789
|
-
# @option opts [Vips::
|
1920
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1921
|
+
# @option opts [Integer] :restart_interval Add restart markers every specified number of mcu
|
1790
1922
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1791
1923
|
# @option opts [Array<Double>] :background Background value
|
1792
1924
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1805,7 +1937,7 @@ module Vips
|
|
1805
1937
|
# @option opts [Boolean] :min_size Optimise for minium size
|
1806
1938
|
# @option opts [Integer] :kmin Minimum number of frames between key frames
|
1807
1939
|
# @option opts [Integer] :kmax Maximum number of frames between key frames
|
1808
|
-
# @option opts [Integer] :
|
1940
|
+
# @option opts [Integer] :effort Level of CPU effort to reduce file size
|
1809
1941
|
# @option opts [String] :profile ICC profile to embed
|
1810
1942
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1811
1943
|
# @option opts [Array<Double>] :background Background value
|
@@ -1824,7 +1956,7 @@ module Vips
|
|
1824
1956
|
# @option opts [Boolean] :min_size Optimise for minium size
|
1825
1957
|
# @option opts [Integer] :kmin Minimum number of frames between key frames
|
1826
1958
|
# @option opts [Integer] :kmax Maximum number of frames between key frames
|
1827
|
-
# @option opts [Integer] :
|
1959
|
+
# @option opts [Integer] :effort Level of CPU effort to reduce file size
|
1828
1960
|
# @option opts [String] :profile ICC profile to embed
|
1829
1961
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1830
1962
|
# @option opts [Array<Double>] :background Background value
|
@@ -1844,7 +1976,7 @@ module Vips
|
|
1844
1976
|
# @option opts [Boolean] :min_size Optimise for minium size
|
1845
1977
|
# @option opts [Integer] :kmin Minimum number of frames between key frames
|
1846
1978
|
# @option opts [Integer] :kmax Maximum number of frames between key frames
|
1847
|
-
# @option opts [Integer] :
|
1979
|
+
# @option opts [Integer] :effort Level of CPU effort to reduce file size
|
1848
1980
|
# @option opts [String] :profile ICC profile to embed
|
1849
1981
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1850
1982
|
# @option opts [Array<Double>] :background Background value
|
@@ -1863,20 +1995,19 @@ module Vips
|
|
1863
1995
|
# @option opts [Integer] :tile_width Tile width in pixels
|
1864
1996
|
# @option opts [Integer] :tile_height Tile height in pixels
|
1865
1997
|
# @option opts [Boolean] :pyramid Write a pyramidal tiff
|
1866
|
-
# @option opts [Boolean] :squash Squash images down to 1 bit
|
1867
1998
|
# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
|
1868
1999
|
# @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
|
1869
2000
|
# @option opts [Vips::ForeignTiffResunit] :resunit Resolution unit
|
1870
2001
|
# @option opts [Float] :xres Horizontal resolution in pixels/mm
|
1871
2002
|
# @option opts [Float] :yres Vertical resolution in pixels/mm
|
1872
2003
|
# @option opts [Boolean] :bigtiff Write a bigtiff image
|
1873
|
-
# @option opts [Boolean] :rgbjpeg Output RGB JPEG rather than YCbCr
|
1874
2004
|
# @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
|
1875
2005
|
# @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
|
1876
2006
|
# @option opts [Integer] :level ZSTD compression level
|
1877
|
-
# @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
|
1878
2007
|
# @option opts [Boolean] :lossless Enable WEBP lossless mode
|
1879
2008
|
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
2009
|
+
# @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
|
2010
|
+
# @option opts [Boolean] :premultiply Save with premultiplied alpha
|
1880
2011
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1881
2012
|
# @option opts [Array<Double>] :background Background value
|
1882
2013
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1893,20 +2024,19 @@ module Vips
|
|
1893
2024
|
# @option opts [Integer] :tile_width Tile width in pixels
|
1894
2025
|
# @option opts [Integer] :tile_height Tile height in pixels
|
1895
2026
|
# @option opts [Boolean] :pyramid Write a pyramidal tiff
|
1896
|
-
# @option opts [Boolean] :squash Squash images down to 1 bit
|
1897
2027
|
# @option opts [Boolean] :miniswhite Use 0 for white in 1-bit images
|
1898
2028
|
# @option opts [Integer] :bitdepth Write as a 1, 2, 4 or 8 bit image
|
1899
2029
|
# @option opts [Vips::ForeignTiffResunit] :resunit Resolution unit
|
1900
2030
|
# @option opts [Float] :xres Horizontal resolution in pixels/mm
|
1901
2031
|
# @option opts [Float] :yres Vertical resolution in pixels/mm
|
1902
2032
|
# @option opts [Boolean] :bigtiff Write a bigtiff image
|
1903
|
-
# @option opts [Boolean] :rgbjpeg Output RGB JPEG rather than YCbCr
|
1904
2033
|
# @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
|
1905
2034
|
# @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
|
1906
2035
|
# @option opts [Integer] :level ZSTD compression level
|
1907
|
-
# @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
|
1908
2036
|
# @option opts [Boolean] :lossless Enable WEBP lossless mode
|
1909
2037
|
# @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
|
2038
|
+
# @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
|
2039
|
+
# @option opts [Boolean] :premultiply Save with premultiplied alpha
|
1910
2040
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1911
2041
|
# @option opts [Array<Double>] :background Background value
|
1912
2042
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1957,12 +2087,13 @@ module Vips
|
|
1957
2087
|
|
1958
2088
|
# @!method heifsave(filename, **opts)
|
1959
2089
|
# Save image in heif format.
|
1960
|
-
# @param filename [String] Filename to
|
2090
|
+
# @param filename [String] Filename to save to
|
1961
2091
|
# @param opts [Hash] Set of options
|
1962
2092
|
# @option opts [Integer] :Q Q factor
|
1963
2093
|
# @option opts [Boolean] :lossless Enable lossless compression
|
1964
2094
|
# @option opts [Vips::ForeignHeifCompression] :compression Compression format
|
1965
|
-
# @option opts [Integer] :
|
2095
|
+
# @option opts [Integer] :effort CPU effort
|
2096
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1966
2097
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1967
2098
|
# @option opts [Array<Double>] :background Background value
|
1968
2099
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1974,7 +2105,8 @@ module Vips
|
|
1974
2105
|
# @option opts [Integer] :Q Q factor
|
1975
2106
|
# @option opts [Boolean] :lossless Enable lossless compression
|
1976
2107
|
# @option opts [Vips::ForeignHeifCompression] :compression Compression format
|
1977
|
-
# @option opts [Integer] :
|
2108
|
+
# @option opts [Integer] :effort CPU effort
|
2109
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1978
2110
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1979
2111
|
# @option opts [Array<Double>] :background Background value
|
1980
2112
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -1987,7 +2119,8 @@ module Vips
|
|
1987
2119
|
# @option opts [Integer] :Q Q factor
|
1988
2120
|
# @option opts [Boolean] :lossless Enable lossless compression
|
1989
2121
|
# @option opts [Vips::ForeignHeifCompression] :compression Compression format
|
1990
|
-
# @option opts [Integer] :
|
2122
|
+
# @option opts [Integer] :effort CPU effort
|
2123
|
+
# @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
|
1991
2124
|
# @option opts [Boolean] :strip Strip all metadata from image
|
1992
2125
|
# @option opts [Array<Double>] :background Background value
|
1993
2126
|
# @option opts [Integer] :page_height Set page height for multipage save
|
@@ -2006,7 +2139,6 @@ module Vips
|
|
2006
2139
|
# @option opts [String] :import_profile Fallback import profile
|
2007
2140
|
# @option opts [String] :export_profile Fallback export profile
|
2008
2141
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2009
|
-
# @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
|
2010
2142
|
# @return [Vips::Image] Output image
|
2011
2143
|
|
2012
2144
|
# @!method self.thumbnail_buffer(buffer, width, **opts)
|
@@ -2023,7 +2155,6 @@ module Vips
|
|
2023
2155
|
# @option opts [String] :import_profile Fallback import profile
|
2024
2156
|
# @option opts [String] :export_profile Fallback export profile
|
2025
2157
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2026
|
-
# @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
|
2027
2158
|
# @return [Vips::Image] Output image
|
2028
2159
|
|
2029
2160
|
# @!method thumbnail_image(width, **opts)
|
@@ -2038,7 +2169,6 @@ module Vips
|
|
2038
2169
|
# @option opts [String] :import_profile Fallback import profile
|
2039
2170
|
# @option opts [String] :export_profile Fallback export profile
|
2040
2171
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2041
|
-
# @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
|
2042
2172
|
# @return [Vips::Image] Output image
|
2043
2173
|
|
2044
2174
|
# @!method self.thumbnail_source(source, width, **opts)
|
@@ -2055,7 +2185,6 @@ module Vips
|
|
2055
2185
|
# @option opts [String] :import_profile Fallback import profile
|
2056
2186
|
# @option opts [String] :export_profile Fallback export profile
|
2057
2187
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2058
|
-
# @option opts [Boolean] :auto_rotate Use orientation tags to rotate image upright
|
2059
2188
|
# @return [Vips::Image] Output image
|
2060
2189
|
|
2061
2190
|
# @!method mapim(index, **opts)
|
@@ -2070,40 +2199,32 @@ module Vips
|
|
2070
2199
|
# @param hshrink [Float] Horizontal shrink factor
|
2071
2200
|
# @param vshrink [Float] Vertical shrink factor
|
2072
2201
|
# @param opts [Hash] Set of options
|
2073
|
-
# @option opts [Float] :xshrink Horizontal shrink factor
|
2074
|
-
# @option opts [Float] :yshrink Vertical shrink factor
|
2075
2202
|
# @return [Vips::Image] Output image
|
2076
2203
|
|
2077
2204
|
# @!method shrinkh(hshrink, **opts)
|
2078
2205
|
# Shrink an image horizontally.
|
2079
2206
|
# @param hshrink [Integer] Horizontal shrink factor
|
2080
2207
|
# @param opts [Hash] Set of options
|
2081
|
-
# @option opts [Integer] :xshrink Horizontal shrink factor
|
2082
2208
|
# @return [Vips::Image] Output image
|
2083
2209
|
|
2084
2210
|
# @!method shrinkv(vshrink, **opts)
|
2085
2211
|
# Shrink an image vertically.
|
2086
2212
|
# @param vshrink [Integer] Vertical shrink factor
|
2087
2213
|
# @param opts [Hash] Set of options
|
2088
|
-
# @option opts [Integer] :yshrink Vertical shrink factor
|
2089
2214
|
# @return [Vips::Image] Output image
|
2090
2215
|
|
2091
2216
|
# @!method reduceh(hshrink, **opts)
|
2092
2217
|
# Shrink an image horizontally.
|
2093
2218
|
# @param hshrink [Float] Horizontal shrink factor
|
2094
2219
|
# @param opts [Hash] Set of options
|
2095
|
-
# @option opts [Float] :xshrink Horizontal shrink factor
|
2096
2220
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
2097
|
-
# @option opts [Boolean] :centre Use centre sampling convention
|
2098
2221
|
# @return [Vips::Image] Output image
|
2099
2222
|
|
2100
2223
|
# @!method reducev(vshrink, **opts)
|
2101
2224
|
# Shrink an image vertically.
|
2102
2225
|
# @param vshrink [Float] Vertical shrink factor
|
2103
2226
|
# @param opts [Hash] Set of options
|
2104
|
-
# @option opts [Float] :yshrink Vertical shrink factor
|
2105
2227
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
2106
|
-
# @option opts [Boolean] :centre Use centre sampling convention
|
2107
2228
|
# @return [Vips::Image] Output image
|
2108
2229
|
|
2109
2230
|
# @!method reduce(hshrink, vshrink, **opts)
|
@@ -2112,9 +2233,6 @@ module Vips
|
|
2112
2233
|
# @param vshrink [Float] Vertical shrink factor
|
2113
2234
|
# @param opts [Hash] Set of options
|
2114
2235
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
2115
|
-
# @option opts [Boolean] :centre Use centre sampling convention
|
2116
|
-
# @option opts [Float] :xshrink Horizontal shrink factor
|
2117
|
-
# @option opts [Float] :yshrink Vertical shrink factor
|
2118
2236
|
# @return [Vips::Image] Output image
|
2119
2237
|
|
2120
2238
|
# @!method quadratic(coeff, **opts)
|
@@ -2168,12 +2286,8 @@ module Vips
|
|
2168
2286
|
# Resize an image.
|
2169
2287
|
# @param scale [Float] Scale image by this factor
|
2170
2288
|
# @param opts [Hash] Set of options
|
2171
|
-
# @option opts [Vips::Interpolate] :interpolate Interpolate pixels with this
|
2172
2289
|
# @option opts [Vips::Kernel] :kernel Resampling kernel
|
2173
|
-
# @option opts [Boolean] :centre Use centre sampling convention
|
2174
2290
|
# @option opts [Float] :vscale Vertical scale image by this factor
|
2175
|
-
# @option opts [Float] :idx Horizontal input displacement
|
2176
|
-
# @option opts [Float] :idy Vertical input displacement
|
2177
2291
|
# @return [Vips::Image] Output image
|
2178
2292
|
|
2179
2293
|
# @!method colourspace(space, **opts)
|
@@ -2295,6 +2409,7 @@ module Vips
|
|
2295
2409
|
# @param opts [Hash] Set of options
|
2296
2410
|
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
2297
2411
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2412
|
+
# @option opts [Boolean] :black_point_compensation Enable black point compensation
|
2298
2413
|
# @option opts [Boolean] :embedded Use embedded input profile, if available
|
2299
2414
|
# @option opts [String] :input_profile Filename to load input profile from
|
2300
2415
|
# @return [Vips::Image] Output image
|
@@ -2304,6 +2419,7 @@ module Vips
|
|
2304
2419
|
# @param opts [Hash] Set of options
|
2305
2420
|
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
2306
2421
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2422
|
+
# @option opts [Boolean] :black_point_compensation Enable black point compensation
|
2307
2423
|
# @option opts [String] :output_profile Filename to load output profile from
|
2308
2424
|
# @option opts [Integer] :depth Output device space depth in bits
|
2309
2425
|
# @return [Vips::Image] Output image
|
@@ -2314,6 +2430,7 @@ module Vips
|
|
2314
2430
|
# @param opts [Hash] Set of options
|
2315
2431
|
# @option opts [Vips::PCS] :pcs Set Profile Connection Space
|
2316
2432
|
# @option opts [Vips::Intent] :intent Rendering intent
|
2433
|
+
# @option opts [Boolean] :black_point_compensation Enable black point compensation
|
2317
2434
|
# @option opts [Boolean] :embedded Use embedded input profile, if available
|
2318
2435
|
# @option opts [String] :input_profile Filename to load input profile from
|
2319
2436
|
# @option opts [Integer] :depth Output device space depth in bits
|
@@ -2517,7 +2634,6 @@ module Vips
|
|
2517
2634
|
# @!method sharpen(**opts)
|
2518
2635
|
# Unsharp masking for print.
|
2519
2636
|
# @param opts [Hash] Set of options
|
2520
|
-
# @option opts [Integer] :radius radius of Gaussian
|
2521
2637
|
# @option opts [Float] :sigma Sigma of Gaussian
|
2522
2638
|
# @option opts [Float] :x1 Flat/jaggy threshold
|
2523
2639
|
# @option opts [Float] :y2 Maximum brightening
|