Codeuctivity.SkiaSharpCompare 0.0.37-prerelease

Prefix Reserved
This is a prerelease version of Codeuctivity.SkiaSharpCompare.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Codeuctivity.SkiaSharpCompare --version 0.0.37-prerelease                
NuGet\Install-Package Codeuctivity.SkiaSharpCompare -Version 0.0.37-prerelease                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Codeuctivity.SkiaSharpCompare" Version="0.0.37-prerelease" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Codeuctivity.SkiaSharpCompare --version 0.0.37-prerelease                
#r "nuget: Codeuctivity.SkiaSharpCompare, 0.0.37-prerelease"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Codeuctivity.SkiaSharpCompare as a Cake Addin
#addin nuget:?package=Codeuctivity.SkiaSharpCompare&version=0.0.37-prerelease&prerelease

// Install Codeuctivity.SkiaSharpCompare as a Cake Tool
#tool nuget:?package=Codeuctivity.SkiaSharpCompare&version=0.0.37-prerelease&prerelease                

SkiaSharpCompare

Compares images

.NET build and test Nuget Donate

Inspired by the image compare feature "Visual verification API" of TestApi this code supports comparing images by using a tolerance mask image. That tolerance mask image is a valid image by itself and can be manipulated.

SkiaSharpCompare focus on os agnostic support and therefore depends on SkiaSharp.

NOTE: The Alpha-channel is ignored.

Example simple show cases

Compares each RGB value of each pixel to determine the equality

bool isEqual = Compare.ImagesAreEqual("actual.png", "expected.png");

Calculates diff

var calcDiff = Compare.CalcDiff("2x2PixelBlack.png", "2x2PixelWhite.png");
Console.WriteLine($"PixelErrorCount: {diff.PixelErrorCount}");
Console.WriteLine($"PixelErrorPercentage: {diff.PixelErrorPercentage}");
Console.WriteLine($"AbsoluteError: {diff.AbsoluteError}");
Console.WriteLine($"MeanError: {diff.MeanError}");
// PixelErrorCount: 4
// PixelErrorPercentage: 100
// AbsoluteError: 3060
// MeanError: 765

Example show case allowing some tolerated diff

Imagine two images you want to compare, and want to accept the found difference as at state of allowed difference.

Reference Image

actual image

Actual Image

actual image

Tolerance mask image

Using CalcDiffMaskImage you can calc a diff mask from actual and reference image

Example - Create difference image

using (var fileStreamDifferenceMask = File.Create("differenceMask.png"))
using (var maskImage = SkiaSharpCompare.CalcDiffMaskImage(pathPic1, pathPic2))
var encodedData = maskImage.Encode(SKEncodedImageFormat.Png, 100);
encodedData.SaveTo(fileStreamDifferenceMask);

differenceMask.png

Example - Compare two images using the created difference image. Add white pixels to differenceMask.png where you want to allow difference.

var maskedDiff = SkiaSharpCompare.CalcDiff(pathPic1, pathPic2, "differenceMask.png");
Assert.That(maskedDiff.AbsoluteError, Is.EqualTo(0));
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.144 42 11/12/2024
2.0.126 8,840 4/22/2024
2.0.114 2,749 1/27/2024
2.0.109 97 1/27/2024
2.0.93 234 11/17/2023
1.0.82 410 9/24/2023
1.0.59 175 8/26/2023
1.0.43 198 7/15/2023
0.0.37-prerelease 164 5/17/2023
0.0.2-prerelease 192 9/30/2022

Implemented an enhancement by adding overloads to methods, enabling the comparison of images with varying dimensions.