Module |
|
Header |
/Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h |
Include |
#include "Interfaces/IScreenShotManager.h" |
TFuture< FImageComparisonResult > CompareScreenshotAsync
(
const FString & IncomingPath,
const FAutomationScreenshotMetadata & MetaData,
const EScreenShotCompareOptions Options
)
Takes the file at the provided path and uses the metadata to find and compare it with a ground truth version.
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) |