@jimp/plugin-mask

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

Changelog

v0.22.7 (Sat Feb 25 2023)

:tada: This release contains work from a new contributor! :tada:

Thank you, MD KHAIRUL ISLAM (@black-turtle), for all your work!

Release Notes