EASYAIuniappNewUI/node_modules/@jimp/plugin-mask
2025-02-08 18:50:38 +08:00
..
dist 2025/2/8第一次更新 2025-02-08 18:50:38 +08:00
es 2025/2/8第一次更新 2025-02-08 18:50:38 +08:00
src 2025/2/8第一次更新 2025-02-08 18:50:38 +08:00
test 2025/2/8第一次更新 2025-02-08 18:50:38 +08:00
CHANGELOG.md 2025/2/8第一次更新 2025-02-08 18:50:38 +08:00
index.d.ts 2025/2/8第一次更新 2025-02-08 18:50:38 +08:00
LICENSE 2025/2/8第一次更新 2025-02-08 18:50:38 +08:00
package.json 2025/2/8第一次更新 2025-02-08 18:50:38 +08:00
README.md 2025/2/8第一次更新 2025-02-08 18:50:38 +08:00

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