Skip to content

Commit

Permalink
Docs: changelog and credit for #4036
Browse files Browse the repository at this point in the history
  • Loading branch information
lovell committed Mar 21, 2024
1 parent aa1bbcb commit eaf31a5
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/api-output.md
Original file line number Diff line number Diff line change
Expand Up @@ -617,6 +617,7 @@ sharp('input.svg')
Use these AVIF options for output image.

AVIF image sequences are not supported.
Prebuilt binaries support a bitdepth of 8 only.


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

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

**Example**
```js
Expand Down
4 changes: 4 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ Requires libvips v8.15.2
* Ensure `clone` takes a deep copy of existing options.
[#4029](https://github.com/lovell/sharp/issues/4029)

* Add `bitdepth` option to `heif` output (prebuilt binaries support 8-bit only).
[#4036](https://github.com/lovell/sharp/pull/4036)
[@mertalev](https://github.com/mertalev)

### v0.33.2 - 12th January 2024

* Upgrade to libvips v8.15.1 for upstream bug fixes.
Expand Down
3 changes: 3 additions & 0 deletions docs/humans.txt
Original file line number Diff line number Diff line change
Expand Up @@ -287,3 +287,6 @@ GitHub: https://github.com/icetee

Name: Aaron Che
GitHub: https://github.com/yolopunk

Name: Mert Alev
GitHub: https://github.com/mertalev
2 changes: 1 addition & 1 deletion docs/search-index.json

Large diffs are not rendered by default.

0 comments on commit eaf31a5

Please sign in to comment.