Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-07-09 18:40:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document new cutout option of overlayWith feature #435

Browse Source
This commit is contained in:
Lovell Fuller 2016-06-26 13:53:20 +01:00
parent 2e9cd83ed2
commit c3ad4fbdaa
2 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/api.md
View File

@ -432,6 +432,7 @@ Overlay (composite) a image containing an alpha channel over the processed (resi
* `gravity` is a String or an attribute of the `sharp.gravity` Object e.g. `sharp.gravity.north` at which to place the overlay, defaulting to `center`/`centre`. * `gravity` is a String or an attribute of the `sharp.gravity` Object e.g. `sharp.gravity.north` at which to place the overlay, defaulting to `center`/`centre`.
* `tile` is a Boolean, defaulting to `false`. When set to `true` repeats the overlay image across the entire image with the given `gravity`. * `tile` is a Boolean, defaulting to `false`. When set to `true` repeats the overlay image across the entire image with the given `gravity`.
* `cutout` is a Boolean, defaulting to `false`. When set to `true` applies only the alpha channel of the overlay image to the image to be overlaid, giving the appearance of one image being cut out of another.
```javascript ```javascript
sharp('input.png') sharp('input.png')

4
docs/changelog.md
View File

@ -18,6 +18,10 @@ Requires libvips v8.3.1
[#443](https://github.com/lovell/sharp/pull/443) [#443](https://github.com/lovell/sharp/pull/443)
[@lemnisk8](https://github.com/lemnisk8) [@lemnisk8](https://github.com/lemnisk8)
* Add cutout option to overlayWith feature, applies only the alpha channel of the overlay image.
[#448](https://github.com/lovell/sharp/pull/448)
[@kleisauke](https://github.com/kleisauke)
* Ensure scaling factors are calculated independently to prevent rounding errors. * Ensure scaling factors are calculated independently to prevent rounding errors.
[#452](https://github.com/lovell/sharp/issues/452) [#452](https://github.com/lovell/sharp/issues/452)
[@puzrin](https://github.com/puzrin) [@puzrin](https://github.com/puzrin)