shichen b6c5ecc67a init 10 ay önce
..
dist b6c5ecc67a init 10 ay önce
es b6c5ecc67a init 10 ay önce
node_modules b6c5ecc67a init 10 ay önce
src b6c5ecc67a init 10 ay önce
test b6c5ecc67a init 10 ay önce
CHANGELOG.md b6c5ecc67a init 10 ay önce
LICENSE b6c5ecc67a init 10 ay önce
README.md b6c5ecc67a init 10 ay önce
index.d.ts b6c5ecc67a init 10 ay önce
package.json b6c5ecc67a init 10 ay önce

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