Skip to content

Commit c4d6aec

Browse files
committed
Docs: Highlight that Windows ARM64 support is experimental
1 parent e75ae97 commit c4d6aec

File tree

4 files changed

+8
-2
lines changed

4 files changed

+8
-2
lines changed

docs/src/content/docs/api-output.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -626,6 +626,9 @@ Use these AVIF options for output image.
626626
AVIF image sequences are not supported.
627627
Prebuilt binaries support a bitdepth of 8 only.
628628

629+
This feature is experimental on the Windows ARM64 platform
630+
and requires a CPU with ARM64v8.4 or later.
631+
629632

630633
**Throws**:
631634

docs/src/content/docs/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Requires libvips v8.16.1
1515
[#4207](https://github.com/lovell/sharp/pull/4207)
1616
[#4398](https://github.com/lovell/sharp/issues/4398)
1717

18-
* Add support for prebuilt Windows ARM64 binaries.
18+
* Add experimental support for prebuilt Windows ARM64 binaries.
1919
[#4375](https://github.com/lovell/sharp/pull/4375)
2020
[@hans00](https://github.com/hans00)
2121

docs/src/content/docs/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Ready-compiled sharp and libvips binaries are provided for use on the most commo
5353
* Linux x64 (glibc >= 2.26, musl >= 1.2.2, CPU with SSE4.2)
5454
* Windows x64
5555
* Windows x86
56-
* Windows ARM64
56+
* Windows ARM64 (experimental, CPU with ARMv8.4 required for all features)
5757

5858
This provides support for the
5959
JPEG, PNG, WebP, AVIF (limited to 8-bit depth), TIFF, GIF and SVG (input) image formats.

lib/output.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1019,6 +1019,9 @@ function tiff (options) {
10191019
* AVIF image sequences are not supported.
10201020
* Prebuilt binaries support a bitdepth of 8 only.
10211021
*
1022+
* This feature is experimental on the Windows ARM64 platform
1023+
* and requires a CPU with ARM64v8.4 or later.
1024+
*
10221025
* @example
10231026
* const data = await sharp(input)
10241027
* .avif({ effort: 2 })

0 commit comments

Comments
 (0)