From 923fb43ae9928b64dd2468e72a2bea435236d4b8 Mon Sep 17 00:00:00 2001 From: John Cupitt Date: Fri, 22 Jan 2016 15:02:18 +0000 Subject: [PATCH] clear up tiny docs issue not about SEQ behaviour --- libvips/iofuncs/operation.c | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/libvips/iofuncs/operation.c b/libvips/iofuncs/operation.c index 23a330da..2e4c01ca 100644 --- a/libvips/iofuncs/operation.c +++ b/libvips/iofuncs/operation.c @@ -176,13 +176,23 @@ * Flags we associate with an operation. * * @VIPS_OPERATION_SEQUENTIAL means that the operation works like vips_conv(): - * it can happily process images top-to-bottom with only small non-local - * references. + * it can process images top-to-bottom with only small non-local + * references. + * + * Every scan-line must be requested, you are not allowed to skip + * ahead, but as a special case, the very first request can be for a region + * not at the top of the image. In this case, the first part of the image will + * be read and discarded * * @VIPS_OPERATION_SEQUENTIAL_UNBUFFERED means that the operation works like - * vips_copy(): it can happily process images top-to-bottom and makes no + * vips_copy(): it can process images top-to-bottom and makes no * non-local references. * + * Every scan-line must be requested, you are not allowed to skip + * ahead, but as a special case, the very first request can be for a region + * not at the top of the image. In this case, the first part of the image will + * be read and discarded + * * @VIPS_OPERATION_NOCACHE means that the operation must not be cached by * vips. *