Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-12-19 07:15:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs: clarify that flatten removes alpha channel #2601

Browse Source
This commit is contained in:
Lovell Fuller
2021-03-25 14:38:55 +00:00
parent 9fc611f257
commit f1f18fbb4a
3 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
lib/operation.js
View File

@@ -268,7 +268,13 @@ function blur (sigma) {
}
/**
* Merge alpha transparency channel, if any, with a background.
* Merge alpha transparency channel, if any, with a background, then remove the alpha channel.
*
* @example
* await sharp(rgbaInput)
* .flatten('#F0A703')
* .toBuffer();
*
* @param {Object} [options]
* @param {string|Object} [options.background={r: 0, g: 0, b: 0}] - background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to black.
* @returns {Sharp}