Skip to content

Commit 6def9e8

Browse files
committed
add note on new flags API to docs
1 parent 24679e1 commit 6def9e8

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

lib/vips.rb

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,19 @@ module GObject
452452
# like `:uchar`. They are documented as a set of classes for convenience, see
453453
# {Vips::BandFormat}, for example.
454454
#
455+
# # Flags
456+
#
457+
# Some operations take a set of flags as an argument, for example
458+
# {Image#pngsave} can be given a set of filters to use. These are documented
459+
# as a set of classes, see {Vips::ForeignPngFilter}, for
460+
# example.
461+
#
462+
# You can set flag arguments with an array of symbols, perhaps:
463+
#
464+
# ```ruby
465+
# image.pngsave "x.png", filter: [:sub, :up]
466+
# ```
467+
#
455468
# # Draw operations
456469
#
457470
# There are two ways of calling the libvips draw operations, like

0 commit comments

Comments
 (0)