shichen b6c5ecc67a init		10 maanden geleden
..
dist	b6c5ecc67a init	10 maanden geleden
es	b6c5ecc67a init	10 maanden geleden
node_modules	b6c5ecc67a init	10 maanden geleden
src	b6c5ecc67a init	10 maanden geleden
test	b6c5ecc67a init	10 maanden geleden
CHANGELOG.md	b6c5ecc67a init	10 maanden geleden
LICENSE	b6c5ecc67a init	10 maanden geleden
README.md	b6c5ecc67a init	10 maanden geleden
index.d.ts	b6c5ecc67a init	10 maanden geleden
package.json	b6c5ecc67a init	10 maanden geleden

@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.md

@jimp/plugin-mask

Usage