From 28cbdcc65d56d6a805adfb005f4c1cfd9bc29376 Mon Sep 17 00:00:00 2001 From: John Cupitt Date: Sat, 20 Mar 2021 12:23:00 +0000 Subject: [PATCH] revise doc comments --- libvips/foreign/jp2kload.c | 8 +++++++- libvips/foreign/jp2ksave.c | 3 +++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/libvips/foreign/jp2kload.c b/libvips/foreign/jp2kload.c index 8024273d..dbd9d38d 100644 --- a/libvips/foreign/jp2kload.c +++ b/libvips/foreign/jp2kload.c @@ -994,7 +994,13 @@ vips_foreign_load_jp2k_source_init( * * * @page: %gint, load this page * - * Read a JPEG2000 image. + * Read a JPEG2000 image. The loader supports 8, 16 and 32-bit int pixel + * values, signed and unsigned. + * It will read any ICC profile on + * the image. It supports greyscale, RGB, CMYK and + * multispectral images. + * + * It will only load images where all channels are the same size and format. * * Use @page to set the page to load, where page 0 is the base resolution * image, and higher-numbered pages are x2 reductions. Use the metadata item diff --git a/libvips/foreign/jp2ksave.c b/libvips/foreign/jp2ksave.c index 2b41aacb..8712736f 100644 --- a/libvips/foreign/jp2ksave.c +++ b/libvips/foreign/jp2ksave.c @@ -752,6 +752,9 @@ vips_foreign_save_jp2k_target_init( VipsForeignSaveJp2kTarget *target ) * * @tile_height: %gint for tile size * * Write a VIPS image to a file in JPEG2000 format. + * The saver supports 8, 16 and 32-bit int pixel + * values, signed and unsigned. It supports greyscale, RGB, CMYK and + * multispectral images. * * Use @Q to set the compression quality factor. The default value of 45 * produces file with approximately the same size as regular JPEG Q 75.