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

Light Theme

Dark Theme

IScreenShotManager::CompareScreenshotAsync

Takes the file at the provided path and uses the metadata to find and compare it with a ground truth version.

Windows

MacOS

Linux

References

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

Syntax

TFuture< FImageComparisonResult > CompareScreenshotAsync
(
    const FString & IncomingPath,
    const FAutomationScreenshotMetadata & MetaData,
    const EScreenShotCompareOptions Options
)

Remarks

Takes the file at the provided path and uses the metadata to find and compare it with a ground truth version.

Returns

Parameters

Parameter	Description
IncomingPath	Path to the file. The file can reside anywhere but for best practices it should be under FPaths::AutomationTransientDir()
MetaData	Meta data for the image. This should have been created when the image was captured and is usually at the same path but with a json extension
Options	Comparison options. Use EScreenShotCompareOptions::DiscardImage if the incoming image does not need to be preserved (implicit if the path is under a transient dir)

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

Take our survey

Dismiss