Meziantou.Framework.SnapshotTesting.SkiaSharp
1.0.2
Prefix Reserved
dotnet add package Meziantou.Framework.SnapshotTesting.SkiaSharp --version 1.0.2
NuGet\Install-Package Meziantou.Framework.SnapshotTesting.SkiaSharp -Version 1.0.2
<PackageReference Include="Meziantou.Framework.SnapshotTesting.SkiaSharp" Version="1.0.2" />
<PackageVersion Include="Meziantou.Framework.SnapshotTesting.SkiaSharp" Version="1.0.2" />
<PackageReference Include="Meziantou.Framework.SnapshotTesting.SkiaSharp" />
paket add Meziantou.Framework.SnapshotTesting.SkiaSharp --version 1.0.2
#r "nuget: Meziantou.Framework.SnapshotTesting.SkiaSharp, 1.0.2"
#:package Meziantou.Framework.SnapshotTesting.SkiaSharp@1.0.2
#addin nuget:?package=Meziantou.Framework.SnapshotTesting.SkiaSharp&version=1.0.2
#tool nuget:?package=Meziantou.Framework.SnapshotTesting.SkiaSharp&version=1.0.2
Meziantou.Framework.SnapshotTesting.SkiaSharp
Meziantou.Framework.SnapshotTesting.SkiaSharp extends Meziantou.Framework.SnapshotTesting with support for SkiaSharp images, enabling snapshot validation of SKImage, SKBitmap, SKPixmap, and SKSurface objects stored as PNG, JPEG, or WebP files.
Setup
Call AddSkiaSharp() on your SnapshotSettings to register the SkiaSharp serializer and comparer:
using System.Runtime.CompilerServices;
using Meziantou.Framework.SnapshotTesting;
using Meziantou.Framework.SnapshotTesting.SkiaSharp;
internal static class SnapshotConfiguration
{
[ModuleInitializer]
internal static void Initialize()
{
SnapshotSettings.Default.AddSkiaSharp();
}
}
Then validate images from your tests:
public sealed class SampleTests
{
[Fact]
public void ValidateImage()
{
using var bitmap = SKBitmap.Decode("sample.png");
Snapshot.Validate(bitmap, SnapshotType.Png);
}
}
Register once for the whole test assembly, not inside a test method. SnapshotSettings.Default is
shared by every test in the process and its collections are not safe for concurrent modification, so
calling AddSkiaSharp() from a test races against any other test that is serializing a snapshot at
the same time. Repeated calls also append a serializer and a converter every time.
Note that SkiaSharp requires the native libraries to be available at runtime. They are included in the SkiaSharp package for Windows and macOS. On Linux, add a reference to SkiaSharp.NativeAssets.Linux.
Image comparison
By default, images are compared pixel-by-pixel (exact comparison). To allow minor rendering differences, configure a Structural Similarity Index (SSIM) threshold:
// In the module initializer shown above
SnapshotSettings.Default.AddSkiaSharp(new ImageComparisonSettings
{
SimilarityThreshold = 0.99f, // 0.0 = completely different, 1.0 = identical
});
When SimilarityThreshold is set, the mean SSIM across the R, G, and B channels is computed and must be greater than or equal to the threshold for the images to be considered equal.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. net11.0 is compatible. |
-
net10.0
- Meziantou.Framework.SnapshotTesting (>= 3.1.1)
- SkiaSharp (>= 4.151.1)
-
net11.0
- Meziantou.Framework.SnapshotTesting (>= 3.1.1)
- SkiaSharp (>= 4.151.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.