Skip to content

Commit eaf31a5

Browse files
committed
Docs: changelog and credit for lovell#4036
1 parent aa1bbcb commit eaf31a5

File tree

4 files changed

+11
-1
lines changed

4 files changed

+11
-1
lines changed

docs/api-output.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -617,6 +617,7 @@ sharp('input.svg')
617617
Use these AVIF options for output image.
618618

619619
AVIF image sequences are not supported.
620+
Prebuilt binaries support a bitdepth of 8 only.
620621

621622

622623
**Throws**:
@@ -632,6 +633,7 @@ AVIF image sequences are not supported.
632633
| [options.lossless] | <code>boolean</code> | <code>false</code> | use lossless compression |
633634
| [options.effort] | <code>number</code> | <code>4</code> | CPU effort, between 0 (fastest) and 9 (slowest) |
634635
| [options.chromaSubsampling] | <code>string</code> | <code>&quot;&#x27;4:4:4&#x27;&quot;</code> | set to '4:2:0' to use chroma subsampling |
636+
| [options.bitdepth] | <code>number</code> | <code>8</code> | set bitdepth to 8, 10 or 12 bit |
635637

636638
**Example**
637639
```js
@@ -670,6 +672,7 @@ globally-installed libvips compiled with support for libheif, libde265 and x265.
670672
| [options.lossless] | <code>boolean</code> | <code>false</code> | use lossless compression |
671673
| [options.effort] | <code>number</code> | <code>4</code> | CPU effort, between 0 (fastest) and 9 (slowest) |
672674
| [options.chromaSubsampling] | <code>string</code> | <code>&quot;&#x27;4:4:4&#x27;&quot;</code> | set to '4:2:0' to use chroma subsampling |
675+
| [options.bitdepth] | <code>number</code> | <code>8</code> | set bitdepth to 8, 10 or 12 bit |
673676

674677
**Example**
675678
```js

docs/changelog.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ Requires libvips v8.15.2
1919
* Ensure `clone` takes a deep copy of existing options.
2020
[#4029](https://github.com/lovell/sharp/issues/4029)
2121

22+
* Add `bitdepth` option to `heif` output (prebuilt binaries support 8-bit only).
23+
[#4036](https://github.com/lovell/sharp/pull/4036)
24+
[@mertalev](https://github.com/mertalev)
25+
2226
### v0.33.2 - 12th January 2024
2327

2428
* Upgrade to libvips v8.15.1 for upstream bug fixes.

docs/humans.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,3 +287,6 @@ GitHub: https://github.com/icetee
287287

288288
Name: Aaron Che
289289
GitHub: https://github.com/yolopunk
290+
291+
Name: Mert Alev
292+
GitHub: https://github.com/mertalev

docs/search-index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)