6d6bcf309d
|
||
|---|---|---|
| .. | ||
| dist | ||
| src | ||
| test | ||
| CHANGELOG.md | ||
| LICENSE | ||
| README.md | ||
| index.d.ts | ||
| package.json | ||
README.md
@jimp/plugin-mask
mask an image with another image.
Masks a source image on to this image using average pixel colour. A completely black pixel on the mask will turn a pixel in the image completely transparent.
Usage
- @param {Jimp} src the source Jimp instance
- @param {number} x the horizontal position to blit the image
- @param {number} y the vertical position to blit the image
- @param {function(Error, Jimp)} cb (optional) a callback for when complete
import jimp from "jimp";
async function main() {
const image = await jimp.read("test/image.png");
const mask = await jimp.read("test/mask.png");
image.mask(mask);
}