README.md 635 B

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