History

Lee2vv 0b82373111 init		2024-05-05 13:46:50 +08:00
..
dist	init	2024-05-05 13:46:50 +08:00
src	init	2024-05-05 13:46:50 +08:00
test	init	2024-05-05 13:46:50 +08:00
CHANGELOG.md	Backup	2023-08-18 21:52:54 +08:00
LICENSE	Backup	2023-08-18 21:52:54 +08:00
README.md	Backup	2023-08-18 21:52:54 +08:00
index.d.ts	Backup	2023-08-18 21:52:54 +08:00
package.json	Backup	2023-08-18 21:52:54 +08:00

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);
}