@jimp/plugin-mask
TypeScript icon, indicating that this package has built-in type declarations

0.22.12 • Public • Published

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

Readme

Keywords

none

Package Sidebar

Install

npm i @jimp/plugin-mask

Weekly Downloads

1,022,998

Version

0.22.12

License

MIT

Unpacked Size

23.8 kB

Total Files

11

Last publish

Collaborators

  • alisowski
  • oliver.moran