Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > ScreenShotComparisonTools > FImageComparisonResult

Light Theme

Dark Theme

FImageComparisonResult

This struct holds the results of comparing an incoming image from a platform with an approved image that exists under the project hierarchy.

Windows

MacOS

Linux

References

Module	ScreenShotComparisonTools
Header	/Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h
Include	#include "ImageComparer.h"

Syntax

struct FImageComparisonResult

Remarks

This struct holds the results of comparing an incoming image from a platform with an approved image that exists under the project hierarchy.

All paths in this structure should be portable. Test results (including this struct) result can be serialized to JSON and stored on the network as during automation runs then opened in the editor to commit / approve changes to the local project.

Variables

	Name	Description
FString	ApprovedFilePath	Path to the file that was considered as the ground-truth. Relative to the project directory
FString	ComparisonFilePath	Path to the delta image between the ground-truth and the incoming file.
FDateTime	CreationTime	Time that the comparison was performed
FText	ErrorMessage	Error message that can be set during a comparison
double	GlobalDifference	Global difference found during comparison
FString	IdealApprovedFolderPath	Path to a folder where the idealized ground-truth for this comparison would be.
FString	IncomingFilePath	Path to the file that was generated in the test.
double	MaxLocalDifference	Largest local difference found during comparison
FString	ReportApprovedFilePath	Name of the approved file saved for the report.
FString	ReportComparisonFilePath	Name of the delta image saved for the report.
FString	ReportIncomingFilePath	Name of the incoming file saved for the report.
FString	SourcePlatform	Platform that the incoming image was generated on
FString	SourceRHI	RHI that the incoming image was generated with
FImageTolerance	Tolerance	Tolerance values for comparison
int32	Version	Error message that can be set during a comparison

Constructors

	Name	Description
	FImageComparisonResult()
	FImageComparisonResult ( const FText& Error )

Functions

	Name	Description
bool	AreSimilar()	Returns true if the images were within the provided tolerance values
bool	IsIdeal()	Returns true if this is am ideal comparison (e.g not using a fallback for comparison)
bool	IsNew()	Returns true if this is a new image with no approved file to compare against
bool	IsValid()	Returns true if this is a new image with no approved file to compare against
void	SetInvalid()	Marks this struct as invalid.

Constants

Name	Description
CurrentVersion

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss