From 0e6fa5764cf64464f26a30ee733a4a89dd59da33 Mon Sep 17 00:00:00 2001 From: Dirk Farin Date: Wed, 11 Oct 2023 11:55:42 +0200 Subject: [PATCH] clarify comment about only_use_preferred_chroma_algorithm semantics --- libheif/heif.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/libheif/heif.h b/libheif/heif.h index 4497220c9a..8da044bab8 100644 --- a/libheif/heif.h +++ b/libheif/heif.h @@ -1501,7 +1501,12 @@ struct heif_color_conversion_options enum heif_chroma_downsampling_algorithm preferred_chroma_downsampling_algorithm; enum heif_chroma_upsampling_algorithm preferred_chroma_upsampling_algorithm; - // When set to 'false', libheif may also use a different algorithm if the preferred one is not available. + // When set to 'false' libheif may also use a different algorithm if the preferred one is not available + // or using a different algorithm is computationally less complex. Note that currently (v1.17.0) this + // means that for RGB input it will usually choose nearest-neighbor sampling because this is computationally + // the simplest. + // Set this field to 'true' if you want to make sure that the specified algorithm is used even + // at the cost of slightly higher computation times. uint8_t only_use_preferred_chroma_algorithm; };