Package Exports
- pixelmatch
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pixelmatch) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
pixelmatch
The smallest, simplest and fastest JavaScript pixel-level image comparison library, primarily designed to be used in regression tests that compare screenshots.
Features anti-aliased pixels detection and perceptual color metrics.
Inspired by Resemble.js and Blink-diff. Unlike these libraries, pixelmatch is around 120 lines of code, has no dependencies, and works on raw arrays of image data, so it's blazing fast and can be used in any environment (Node or browsers).
var numDiffPixels = pixelmatch(img1.data, img2.data, diff.data, 800, 600);API
pixelmatch(img1, img2, output, width, height[, threshold, includeAA])
img1,img2— Image data of the images to compare (BufferorUint8Array).output— Image data to write the diff to.width,height— Width and height of the images. Note that all three images need to have the same dimensions.threshold— Matching threshold, ranges from0to1. Smaller values make the comparison more sensitive.0.005by default.includeAA— Iftrue, disables detecting and ignoring anti-aliased pixels.falseby default.
Compares two images, writes the output diff and returns the number of mismatched pixels.
Command line
Pixelmatch comes with a binary that works with PNG images:
pixelmatch image1.png image2.png output.png 0.005Install
Install with NPM:
npm install pixelmatchTo build a browser-compatible version, clone the repository locally, then run:
npm install -g browserify
browserify -s pixelmatch index.js > pixelmatch.jsExample output
| expected | actual | diff |
|---|---|---|
 |
 |
 |
 |
 |
 |
 |
 |
 |