Skip to content

Commit ee57584

Browse files
committed
add missing flag and enum docs
We'd not updated these for quite a while! I used the automatically-generated python enum docs as a guide.
1 parent 712ca2c commit ee57584

23 files changed

+288
-9
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
* improve NULL pointer handling [dloebl]
66
* improve GFlags argument handling [jcupitt]
7+
* add missing flags and enums [jcupitt]
78

89
## Version 2.2.4 (2025-06-05)
910

lib/vips/combine.rb

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
module Vips
2+
# How to combine values, see for example {Image#compass}.
3+
#
4+
# * `:max` take the maximum of the possible values
5+
# * `:sum` sum all the values
6+
# * `:min` take the minimum value
7+
8+
class Combine < Symbol
9+
end
10+
end
11+
12+

lib/vips/fail_on.rb

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
module Vips
2+
# How sensitive loaders are to errors, from never stop (very insensitive),
3+
# to stop on the smallest warning (very sensitive).
4+
#
5+
# Each implies the ones before it, so `:error` implies `:truncated`, for
6+
# example.
7+
#
8+
# * `:none` never stop
9+
# * `:truncated` stop on image truncated, nothing else
10+
# * `:error` stop on serious error or truncation
11+
# * `:warning` stop on anything, even warnings
12+
13+
class FailOn < Symbol
14+
end
15+
end
16+
17+

lib/vips/foreign_dz_container.rb

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
module Vips
2+
# The container format to use
3+
#
4+
# * `:fs` write tiles to the filesystem
5+
# * `:zip` write tiles to a zip file
6+
# * `:szi` write to a szi file
7+
8+
class ForeignDzContainer < Symbol
9+
end
10+
end
11+
12+
13+
14+
15+
16+

lib/vips/foreign_dz_depth.rb

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
module Vips
2+
# How many pyramid layers to create.
3+
#
4+
# * `:onepixel` create layers down to 1x1 pixel
5+
# * `:onetile` create layers down to 1x1 tile
6+
# * `:one` only create a single layer
7+
8+
class ForeignDzDepth < Symbol
9+
end
10+
end
11+
12+
13+
14+
15+

lib/vips/foreign_dz_layout.rb

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
module Vips
2+
# What directory layout and metadata standard to use.
3+
#
4+
# * `:dz` use DeepZoom directory layout
5+
# * `:zoomify` use Zoomify directory layout
6+
# * `:google` use Google maps directory layout
7+
# * `:iiif` use IIIF v2 directory layout
8+
# * `:iiif3` use IIIF v3 directory layout
9+
10+
class ForeignDzLayout < Symbol
11+
end
12+
end
13+
14+
15+
16+

lib/vips/foreign_heif_compression.rb

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
module Vips
2+
# The compression format to use inside a HEIF container
3+
#
4+
# * `:hevc` x265
5+
# * `:avc` x264
6+
# * `:jpeg` jpeg
7+
# * `:av1` aom
8+
9+
class ForeignHeifCompression < Symbol
10+
end
11+
end
12+
13+
14+
15+
16+

lib/vips/foreign_heif_encoder.rb

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
module Vips
2+
# The selected encoder to use.
3+
#
4+
# * `:auto` auto
5+
# * `:rav1e` RAV1E
6+
# * `:svt` SVT-AV1
7+
# * `:x265` x265
8+
9+
class ForeignHeifEncoder < Symbol
10+
end
11+
end
12+
13+
14+
15+
16+
17+

lib/vips/foreign_ppm_format.rb

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
module Vips
2+
# The netpbm file format to save as.
3+
#
4+
# * `:pbm` portable bitmap
5+
# * `:pgm` portable greymap
6+
# * `:ppm` portable pixmap
7+
# * `:pfm` portable float map
8+
# * `:pnm` portable anymap
9+
10+
class ForeignPpmFormat < Symbol
11+
end
12+
end
13+
14+

lib/vips/foreign_subsample.rb

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
module Vips
2+
# Set subsampling mode.
3+
#
4+
# * `:auto` prevent subsampling when quality >= 90
5+
# * `:on` always perform subsampling
6+
# * `:off` never perform subsampling
7+
8+
class ForeignSubsample < Symbol
9+
end
10+
end
11+
12+
13+

0 commit comments

Comments
 (0)