Skip to content

Commit 80a222b

Browse files
committed
version bump and docs update
1 parent 12140ce commit 80a222b

File tree

4 files changed

+84
-44
lines changed

4 files changed

+84
-44
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
## Version 2.2.4 (2025-06-05)
66

77
* fix write to target test with libvips 8.17 [jcupitt]
8+
* update docs for libvips 8.17 [jcupitt]
89

910
## Version 2.2.3 (2025-02-06)
1011

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.2.3
1+
2.2.4

lib/vips/methods.rb

Lines changed: 81 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1018,8 +1018,19 @@ class Image
10181018
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
10191019
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
10201020

1021+
# @!method self.ppmload_buffer(buffer, **opts)
1022+
# Load ppm from buffer.
1023+
# @param buffer [VipsBlob] Buffer to load from
1024+
# @param opts [Hash] Set of options
1025+
# @option opts [Boolean] :memory Force open via memory
1026+
# @option opts [Vips::Access] :access Required access pattern for this file
1027+
# @option opts [Vips::FailOn] :fail_on Error level to fail on
1028+
# @option opts [Boolean] :revalidate Don't use a cached result for this operation
1029+
# @option opts [Vips::ForeignFlags] :flags Output Flags for this file
1030+
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
1031+
10211032
# @!method self.ppmload_source(source, **opts)
1022-
# Load ppm base class.
1033+
# Load ppm from source.
10231034
# @param source [Vips::Source] Source to load from
10241035
# @param opts [Hash] Set of options
10251036
# @option opts [Boolean] :memory Force open via memory
@@ -1069,6 +1080,8 @@ class Image
10691080
# @option opts [Float] :dpi Render at this DPI
10701081
# @option opts [Float] :scale Scale output by this factor
10711082
# @option opts [Boolean] :unlimited Allow SVG of any size
1083+
# @option opts [String] :stylesheet Custom CSS
1084+
# @option opts [Boolean] :high_bitdepth Enable scRGB 128-bit output (32-bit per channel)
10721085
# @option opts [Boolean] :memory Force open via memory
10731086
# @option opts [Vips::Access] :access Required access pattern for this file
10741087
# @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1083,6 +1096,8 @@ class Image
10831096
# @option opts [Float] :dpi Render at this DPI
10841097
# @option opts [Float] :scale Scale output by this factor
10851098
# @option opts [Boolean] :unlimited Allow SVG of any size
1099+
# @option opts [String] :stylesheet Custom CSS
1100+
# @option opts [Boolean] :high_bitdepth Enable scRGB 128-bit output (32-bit per channel)
10861101
# @option opts [Boolean] :memory Force open via memory
10871102
# @option opts [Vips::Access] :access Required access pattern for this file
10881103
# @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1097,6 +1112,8 @@ class Image
10971112
# @option opts [Float] :dpi Render at this DPI
10981113
# @option opts [Float] :scale Scale output by this factor
10991114
# @option opts [Boolean] :unlimited Allow SVG of any size
1115+
# @option opts [String] :stylesheet Custom CSS
1116+
# @option opts [Boolean] :high_bitdepth Enable scRGB 128-bit output (32-bit per channel)
11001117
# @option opts [Boolean] :memory Force open via memory
11011118
# @option opts [Vips::Access] :access Required access pattern for this file
11021119
# @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1109,6 +1126,7 @@ class Image
11091126
# @param filename [String] Filename to load from
11101127
# @param opts [Hash] Set of options
11111128
# @option opts [Integer] :page Load this page from the image
1129+
# @option opts [Boolean] :oneshot Load images a frame at a time
11121130
# @option opts [Boolean] :memory Force open via memory
11131131
# @option opts [Vips::Access] :access Required access pattern for this file
11141132
# @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1121,6 +1139,7 @@ class Image
11211139
# @param buffer [VipsBlob] Buffer to load from
11221140
# @param opts [Hash] Set of options
11231141
# @option opts [Integer] :page Load this page from the image
1142+
# @option opts [Boolean] :oneshot Load images a frame at a time
11241143
# @option opts [Boolean] :memory Force open via memory
11251144
# @option opts [Vips::Access] :access Required access pattern for this file
11261145
# @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1133,6 +1152,7 @@ class Image
11331152
# @param source [Vips::Source] Source to load from
11341153
# @param opts [Hash] Set of options
11351154
# @option opts [Integer] :page Load this page from the image
1155+
# @option opts [Boolean] :oneshot Load images a frame at a time
11361156
# @option opts [Boolean] :memory Force open via memory
11371157
# @option opts [Vips::Access] :access Required access pattern for this file
11381158
# @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1315,9 +1335,10 @@ class Image
13151335
# @param filename [String] Filename to load from
13161336
# @param opts [Hash] Set of options
13171337
# @option opts [Integer] :page First page to load
1318-
# @option opts [Integer] :subifd Subifd index
13191338
# @option opts [Integer] :n Number of pages to load, -1 for all
13201339
# @option opts [Boolean] :autorotate Rotate image using orientation tag
1340+
# @option opts [Integer] :subifd Subifd index
1341+
# @option opts [Boolean] :unlimited Remove all denial of service limits
13211342
# @option opts [Boolean] :memory Force open via memory
13221343
# @option opts [Vips::Access] :access Required access pattern for this file
13231344
# @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1330,9 +1351,10 @@ class Image
13301351
# @param buffer [VipsBlob] Buffer to load from
13311352
# @param opts [Hash] Set of options
13321353
# @option opts [Integer] :page First page to load
1333-
# @option opts [Integer] :subifd Subifd index
13341354
# @option opts [Integer] :n Number of pages to load, -1 for all
13351355
# @option opts [Boolean] :autorotate Rotate image using orientation tag
1356+
# @option opts [Integer] :subifd Subifd index
1357+
# @option opts [Boolean] :unlimited Remove all denial of service limits
13361358
# @option opts [Boolean] :memory Force open via memory
13371359
# @option opts [Vips::Access] :access Required access pattern for this file
13381360
# @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1345,9 +1367,10 @@ class Image
13451367
# @param source [Vips::Source] Source to load from
13461368
# @param opts [Hash] Set of options
13471369
# @option opts [Integer] :page First page to load
1348-
# @option opts [Integer] :subifd Subifd index
13491370
# @option opts [Integer] :n Number of pages to load, -1 for all
13501371
# @option opts [Boolean] :autorotate Rotate image using orientation tag
1372+
# @option opts [Integer] :subifd Subifd index
1373+
# @option opts [Boolean] :unlimited Remove all denial of service limits
13511374
# @option opts [Boolean] :memory Force open via memory
13521375
# @option opts [Vips::Access] :access Required access pattern for this file
13531376
# @option opts [Vips::FailOn] :fail_on Error level to fail on
@@ -1578,7 +1601,7 @@ class Image
15781601
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
15791602

15801603
# @!method self.magickload(filename, **opts)
1581-
# Load file with imagemagick.
1604+
# Load file with imagemagick7.
15821605
# @param filename [String] Filename to load from
15831606
# @param opts [Hash] Set of options
15841607
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
@@ -1592,7 +1615,7 @@ class Image
15921615
# @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
15931616

15941617
# @!method self.magickload_buffer(buffer, **opts)
1595-
# Load buffer with imagemagick.
1618+
# Load buffer with imagemagick7.
15961619
# @param buffer [VipsBlob] Buffer to load from
15971620
# @param opts [Hash] Set of options
15981621
# @option opts [String] :density Canvas resolution for rendering vector formats like SVG
@@ -1815,6 +1838,7 @@ class Image
18151838
# @option opts [Boolean] :reuse Reuse palette from input
18161839
# @option opts [Float] :interpalette_maxerror Maximum inter-palette error for palette reusage
18171840
# @option opts [Boolean] :interlace Generate an interlaced (progressive) GIF
1841+
# @option opts [Boolean] :keep_duplicate_frames Keep duplicate frames in the output instead of combining them
18181842
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
18191843
# @option opts [Array<Double>] :background Background value
18201844
# @option opts [Integer] :page_height Set page height for multipage save
@@ -1831,6 +1855,7 @@ class Image
18311855
# @option opts [Boolean] :reuse Reuse palette from input
18321856
# @option opts [Float] :interpalette_maxerror Maximum inter-palette error for palette reusage
18331857
# @option opts [Boolean] :interlace Generate an interlaced (progressive) GIF
1858+
# @option opts [Boolean] :keep_duplicate_frames Keep duplicate frames in the output instead of combining them
18341859
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
18351860
# @option opts [Array<Double>] :background Background value
18361861
# @option opts [Integer] :page_height Set page height for multipage save
@@ -1848,6 +1873,7 @@ class Image
18481873
# @option opts [Boolean] :reuse Reuse palette from input
18491874
# @option opts [Float] :interpalette_maxerror Maximum inter-palette error for palette reusage
18501875
# @option opts [Boolean] :interlace Generate an interlaced (progressive) GIF
1876+
# @option opts [Boolean] :keep_duplicate_frames Keep duplicate frames in the output instead of combining them
18511877
# @option opts [Vips::ForeignKeep] :keep Which metadata to retain
18521878
# @option opts [Array<Double>] :background Background value
18531879
# @option opts [Integer] :page_height Set page height for multipage save
@@ -2388,8 +2414,8 @@ class Image
23882414
# @option opts [Boolean] :no_rotate Don't use orientation tags to rotate image upright
23892415
# @option opts [Vips::Interesting] :crop Reduce to fill target rectangle, then crop
23902416
# @option opts [Boolean] :linear Reduce in linear light
2391-
# @option opts [String] :import_profile Fallback import profile
2392-
# @option opts [String] :export_profile Fallback export profile
2417+
# @option opts [String] :input_profile Fallback input profile
2418+
# @option opts [String] :output_profile Fallback output profile
23932419
# @option opts [Vips::Intent] :intent Rendering intent
23942420
# @option opts [Vips::FailOn] :fail_on Error level to fail on
23952421
# @return [Vips::Image] Output image
@@ -2405,8 +2431,8 @@ class Image
24052431
# @option opts [Boolean] :no_rotate Don't use orientation tags to rotate image upright
24062432
# @option opts [Vips::Interesting] :crop Reduce to fill target rectangle, then crop
24072433
# @option opts [Boolean] :linear Reduce in linear light
2408-
# @option opts [String] :import_profile Fallback import profile
2409-
# @option opts [String] :export_profile Fallback export profile
2434+
# @option opts [String] :input_profile Fallback input profile
2435+
# @option opts [String] :output_profile Fallback output profile
24102436
# @option opts [Vips::Intent] :intent Rendering intent
24112437
# @option opts [Vips::FailOn] :fail_on Error level to fail on
24122438
# @return [Vips::Image] Output image
@@ -2420,8 +2446,8 @@ class Image
24202446
# @option opts [Boolean] :no_rotate Don't use orientation tags to rotate image upright
24212447
# @option opts [Vips::Interesting] :crop Reduce to fill target rectangle, then crop
24222448
# @option opts [Boolean] :linear Reduce in linear light
2423-
# @option opts [String] :import_profile Fallback import profile
2424-
# @option opts [String] :export_profile Fallback export profile
2449+
# @option opts [String] :input_profile Fallback input profile
2450+
# @option opts [String] :output_profile Fallback output profile
24252451
# @option opts [Vips::Intent] :intent Rendering intent
24262452
# @option opts [Vips::FailOn] :fail_on Error level to fail on
24272453
# @return [Vips::Image] Output image
@@ -2437,8 +2463,8 @@ class Image
24372463
# @option opts [Boolean] :no_rotate Don't use orientation tags to rotate image upright
24382464
# @option opts [Vips::Interesting] :crop Reduce to fill target rectangle, then crop
24392465
# @option opts [Boolean] :linear Reduce in linear light
2440-
# @option opts [String] :import_profile Fallback import profile
2441-
# @option opts [String] :export_profile Fallback export profile
2466+
# @option opts [String] :input_profile Fallback input profile
2467+
# @option opts [String] :output_profile Fallback output profile
24422468
# @option opts [Vips::Intent] :intent Rendering intent
24432469
# @option opts [Vips::FailOn] :fail_on Error level to fail on
24442470
# @return [Vips::Image] Output image
@@ -2605,6 +2631,16 @@ class Image
26052631
# @param opts [Hash] Set of options
26062632
# @return [Vips::Image] Output image
26072633

2634+
# @!method scRGB2XYZ(**opts)
2635+
# Transform scrgb to xyz.
2636+
# @param opts [Hash] Set of options
2637+
# @return [Vips::Image] Output image
2638+
2639+
# @!method XYZ2scRGB(**opts)
2640+
# Transform xyz to scrgb.
2641+
# @param opts [Hash] Set of options
2642+
# @return [Vips::Image] Output image
2643+
26082644
# @!method LabQ2Lab(**opts)
26092645
# Unpack a labq image to float lab.
26102646
# @param opts [Hash] Set of options
@@ -2650,6 +2686,17 @@ class Image
26502686
# @param opts [Hash] Set of options
26512687
# @return [Vips::Image] Output image
26522688

2689+
# @!method sRGB2scRGB(**opts)
2690+
# Convert an srgb image to scrgb.
2691+
# @param opts [Hash] Set of options
2692+
# @return [Vips::Image] Output image
2693+
2694+
# @!method scRGB2BW(**opts)
2695+
# Convert scrgb to bw.
2696+
# @param opts [Hash] Set of options
2697+
# @option opts [Integer] :depth Output device space depth in bits
2698+
# @return [Vips::Image] Output image
2699+
26532700
# @!method sRGB2HSV(**opts)
26542701
# Transform srgb to hsv.
26552702
# @param opts [Hash] Set of options
@@ -2660,6 +2707,12 @@ class Image
26602707
# @param opts [Hash] Set of options
26612708
# @return [Vips::Image] Output image
26622709

2710+
# @!method scRGB2sRGB(**opts)
2711+
# Convert scrgb to srgb.
2712+
# @param opts [Hash] Set of options
2713+
# @option opts [Integer] :depth Output device space depth in bits
2714+
# @return [Vips::Image] Output image
2715+
26632716
# @!method icc_import(**opts)
26642717
# Import from device with icc profile.
26652718
# @param opts [Hash] Set of options
@@ -2710,33 +2763,6 @@ class Image
27102763
# @param opts [Hash] Set of options
27112764
# @return [Vips::Image] Output image
27122765

2713-
# @!method sRGB2scRGB(**opts)
2714-
# Convert an srgb image to scrgb.
2715-
# @param opts [Hash] Set of options
2716-
# @return [Vips::Image] Output image
2717-
2718-
# @!method scRGB2XYZ(**opts)
2719-
# Transform scrgb to xyz.
2720-
# @param opts [Hash] Set of options
2721-
# @return [Vips::Image] Output image
2722-
2723-
# @!method scRGB2BW(**opts)
2724-
# Convert scrgb to bw.
2725-
# @param opts [Hash] Set of options
2726-
# @option opts [Integer] :depth Output device space depth in bits
2727-
# @return [Vips::Image] Output image
2728-
2729-
# @!method XYZ2scRGB(**opts)
2730-
# Transform xyz to scrgb.
2731-
# @param opts [Hash] Set of options
2732-
# @return [Vips::Image] Output image
2733-
2734-
# @!method scRGB2sRGB(**opts)
2735-
# Convert an scrgb image to srgb.
2736-
# @param opts [Hash] Set of options
2737-
# @option opts [Integer] :depth Output device space depth in bits
2738-
# @return [Vips::Image] Output image
2739-
27402766
# @!method CMYK2XYZ(**opts)
27412767
# Transform cmyk to xyz.
27422768
# @param opts [Hash] Set of options
@@ -3123,7 +3149,13 @@ class Image
31233149
# @return [Vips::Image] Output image
31243150

31253151
# @!method matrixinvert(**opts)
3126-
# Invert an matrix.
3152+
# Invert a matrix.
3153+
# @param opts [Hash] Set of options
3154+
# @return [Vips::Image] Output matrix
3155+
3156+
# @!method matrixmultiply(right, **opts)
3157+
# Multiply two matrices.
3158+
# @param right [Vips::Image] Second matrix to multiply
31273159
# @param opts [Hash] Set of options
31283160
# @return [Vips::Image] Output matrix
31293161

@@ -3150,6 +3182,13 @@ class Image
31503182
# @param opts [Hash] Set of options
31513183
# @option opts [Float] :gamma Image gamma
31523184
# @option opts [Boolean] :int_output Integer output
3185+
# @return [Vips::Image] Output image
3186+
3187+
# @!method remosaic(old_str, new_str, **opts)
3188+
# Rebuild an mosaiced image.
3189+
# @param old_str [String] Search for this string
3190+
# @param new_str [String] And swap for this string
3191+
# @param opts [Hash] Set of options
31533192
# @return [Vips::Image] Output image
31543193

31553194
end

lib/vips/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
module Vips
2-
VERSION = "2.2.3"
2+
VERSION = "2.2.4"
33
end

0 commit comments

Comments
 (0)