From a812e90332ef618204ef7aba4e2e91e718ec4519 Mon Sep 17 00:00:00 2001 From: John Cupitt Date: Mon, 22 Jun 2015 09:42:53 +0100 Subject: [PATCH] add some docs --- libvips/colour/HSV2sRGB.c | 4 ++++ libvips/colour/colour.c | 3 +++ libvips/colour/sRGB2HSV.c | 6 +++++- 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/libvips/colour/HSV2sRGB.c b/libvips/colour/HSV2sRGB.c index f751b480..519e9a60 100644 --- a/libvips/colour/HSV2sRGB.c +++ b/libvips/colour/HSV2sRGB.c @@ -132,6 +132,10 @@ vips_HSV2sRGB_init( VipsHSV2sRGB *HSV2sRGB ) * * Convert HSV to sRGB. * + * HSV is a crude polar coordinate system for RGB images. It is provided for + * compatibility with other image processing systems. See vips_Lab2LCh() for a + * much better colour space. + * * See also: vips_sRGB2HSV(). * * Returns: 0 on success, -1 on error. diff --git a/libvips/colour/colour.c b/libvips/colour/colour.c index 3a955db8..729f212a 100644 --- a/libvips/colour/colour.c +++ b/libvips/colour/colour.c @@ -128,6 +128,9 @@ * #VIPS_INTERPRETATION_RGB16 is the same, but using three 16-bit values for * RGB. * + * #VIPS_INTERPRETATION_HSV is sRGB, but in polar coordinates. + * #VIPS_INTERPRETATION_LCH is much better, only use HSV if you have to. + * * * #VIPS_INTERPRETATION_B_W -- a monochrome image, roughly G from sRGB. * The grey value is * calculated in #VIPS_INTERPRETATION_scRGB space with the usual 0.2, 0.7, 0.1 diff --git a/libvips/colour/sRGB2HSV.c b/libvips/colour/sRGB2HSV.c index 7a3c3b39..e74634e8 100644 --- a/libvips/colour/sRGB2HSV.c +++ b/libvips/colour/sRGB2HSV.c @@ -150,7 +150,11 @@ vips_sRGB2HSV_init( VipssRGB2HSV *sRGB2HSV ) * * Convert to HSV. * - * See also: vips_HSV2sRGB(). + * HSV is a crude polar coordinate system for RGB images. It is provided for + * compatibility with other image processing systems. See vips_Lab2LCh() for a + * much better colour space. + * + * See also: vips_HSV2sRGB(), vips_Lab2LCh(). * * Returns: 0 on success, -1 on error. */