Socket
Socket
Sign inDemoInstall

@jimp/plugin-mask

Package Overview
Dependencies
32
Maintainers
2
Versions
221
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@jimp/plugin-mask

mask an image.


Version published
Maintainers
2
Weekly downloads
994,739
decreased by-7.73%

Weekly downloads

Readme

Source

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

FAQs

Last updated on 23 Feb 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc