From 182beaa4a1cecacef5a74402184020c1017d0d76 Mon Sep 17 00:00:00 2001 From: Lovell Fuller Date: Sun, 20 Dec 2020 17:17:49 +0000 Subject: [PATCH] Docs: add note about AVIF images smaller than 16x16 --- docs/api-output.md | 3 +++ lib/output.js | 3 +++ 2 files changed, 6 insertions(+) diff --git a/docs/api-output.md b/docs/api-output.md index 4d0df918..f61988bf 100644 --- a/docs/api-output.md +++ b/docs/api-output.md @@ -303,6 +303,9 @@ Returns **Sharp** Use these AVIF options for output image. +Whilst it is possible to create AVIF images smaller than 16x16 pixels, +most web browsers do not display these properly. + ### Parameters - `options` **[Object][6]?** output options diff --git a/lib/output.js b/lib/output.js index 222ae3e4..1f9de935 100644 --- a/lib/output.js +++ b/lib/output.js @@ -560,6 +560,9 @@ function tiff (options) { /** * Use these AVIF options for output image. * + * Whilst it is possible to create AVIF images smaller than 16x16 pixels, + * most web browsers do not display these properly. + * * @since 0.27.0 * * @param {Object} [options] - output options