Download the PHP package spatie/pixelmatch-php without Composer

On this page you can find all versions of the php package spatie/pixelmatch-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of spatie/pixelmatch-php

Informations about the package pixelmatch-php

Compare images using PHP

Latest Version on Packagist Tests Total Downloads

This package can compare two images and return the percentage of matching pixels. It's a PHP wrapper around the Pixelmatch JavaScript library.

Here's a quick example on how to use the package.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

In your project, or on your server, you must have the JavaScript package Pixelmatch installed.

... or Yarn.

Make sure you have installed Node 16 or higher.

Usage

Here's how you can get the percentage of matching pixels between two images.

To get the amount of matched and mismatched pixels, you can use these methods.

You can use the matches function to check if the images match.

Setting a threshold

To set the threshold for the amount of mismatching pixels, you can use the threshold method. Higher values will make the comparison more sensitive. The threshold should be between 0 and 1.

If you don't set a threshold, we'll use the default value of 0.1.

Ignoring anti-aliasing

To ignore anti-aliased pixels, you can use the includeAa method.

Limitations

The package can only compare png images.

Images with different dimensions cannot be compared. If you try to do this, a Spatie\Pixelmatch\Exceptions\CouldNotCompare exception will be thrown.

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

All versions of pixelmatch-php with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
symfony/process Version ^6.3|^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package spatie/pixelmatch-php contains the following files

Loading the files please wait ....