@jimp/plugin-displace
TypeScript icon, indicating that this package has built-in type declarations

0.22.12 • Public • Published

@jimp/plugin-displace

Displace an image.

Displaces the image based on the provided displacement map

Usage

  • @param {object} map the source Jimp instance
  • @param {number} offset the maximum displacement value
  • @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");

  // Make me better!
  image.displace(map, 10);
}

main();

Dependencies (1)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i @jimp/plugin-displace

    Weekly Downloads

    1,051,276

    Version

    0.22.12

    License

    MIT

    Unpacked Size

    15.5 kB

    Total Files

    10

    Last publish

    Collaborators

    • alisowski
    • oliver.moran