From c4d6aec48c55227b28425d8f7e46ff1373861ba9 Mon Sep 17 00:00:00 2001 From: Lovell Fuller Date: Mon, 19 May 2025 22:04:08 +0100 Subject: [PATCH] Docs: Highlight that Windows ARM64 support is experimental --- docs/src/content/docs/api-output.md | 3 +++ docs/src/content/docs/changelog.md | 2 +- docs/src/content/docs/install.md | 2 +- lib/output.js | 3 +++ 4 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/src/content/docs/api-output.md b/docs/src/content/docs/api-output.md index 945da137..9cca1d55 100644 --- a/docs/src/content/docs/api-output.md +++ b/docs/src/content/docs/api-output.md @@ -626,6 +626,9 @@ Use these AVIF options for output image. AVIF image sequences are not supported. Prebuilt binaries support a bitdepth of 8 only. +This feature is experimental on the Windows ARM64 platform +and requires a CPU with ARM64v8.4 or later. + **Throws**: diff --git a/docs/src/content/docs/changelog.md b/docs/src/content/docs/changelog.md index 1cec81bc..e4541406 100644 --- a/docs/src/content/docs/changelog.md +++ b/docs/src/content/docs/changelog.md @@ -15,7 +15,7 @@ Requires libvips v8.16.1 [#4207](https://github.com/lovell/sharp/pull/4207) [#4398](https://github.com/lovell/sharp/issues/4398) -* Add support for prebuilt Windows ARM64 binaries. +* Add experimental support for prebuilt Windows ARM64 binaries. [#4375](https://github.com/lovell/sharp/pull/4375) [@hans00](https://github.com/hans00) diff --git a/docs/src/content/docs/install.md b/docs/src/content/docs/install.md index 3e0a4a01..de8d6df1 100644 --- a/docs/src/content/docs/install.md +++ b/docs/src/content/docs/install.md @@ -53,7 +53,7 @@ Ready-compiled sharp and libvips binaries are provided for use on the most commo * Linux x64 (glibc >= 2.26, musl >= 1.2.2, CPU with SSE4.2) * Windows x64 * Windows x86 -* Windows ARM64 +* Windows ARM64 (experimental, CPU with ARMv8.4 required for all features) This provides support for the JPEG, PNG, WebP, AVIF (limited to 8-bit depth), TIFF, GIF and SVG (input) image formats. diff --git a/lib/output.js b/lib/output.js index 5c2bdf29..08d596ad 100644 --- a/lib/output.js +++ b/lib/output.js @@ -1019,6 +1019,9 @@ function tiff (options) { * AVIF image sequences are not supported. * Prebuilt binaries support a bitdepth of 8 only. * + * This feature is experimental on the Windows ARM64 platform + * and requires a CPU with ARM64v8.4 or later. + * * @example * const data = await sharp(input) * .avif({ effort: 2 })