Navigation
API > API/Developer > API/Developer/ScreenShotComparisonTools
Interface that defines a class which is capable of comparing screenshots at a provided path with checked in ground truth versions and generate results and reports.
| Name | IScreenShotManager |
| Type | class |
| Header File | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h |
| Include Path | #include "Interfaces/IScreenShotManager.h" |
Syntax
class IScreenShotManager
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IScreenShotManager() |
Interfaces/IScreenShotManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FImageComparisonResult > CompareImageSequence
(
const TMap< FString, FString >& Sequence, |
Compare a sequence of images. | Interfaces/IScreenShotManager.h | |
TFuture< FImageComparisonResult > CompareScreenshotAsync
(
const FString& IncomingPath, |
Takes the file at the provided path and uses the metadata to find and compare it with a ground truth version. | Interfaces/IScreenShotManager.h | |
FScreenshotExportResult ExportScreenshotComparisonResult
(
FString ScreenshotName, |
Exports target screenshot report to the export location specified | Interfaces/IScreenShotManager.h | |
| Find the all the files that are approved for the given metadata and file pattern | Interfaces/IScreenShotManager.h | ||
FString GetIdealApprovedFolderForImage
(
const FAutomationScreenshotMetadata& MetaData |
Calculate the ideal path for already already approved (ground truth) images. | Interfaces/IScreenShotManager.h | |
void NotifyAutomationTestFrameworkOfImageComparison
(
const FImageComparisonResult& Result |
Notify the automation test framework of an image comparison result | Interfaces/IScreenShotManager.h | |
TFuture< TSharedPtr< TArray< FComparisonReport > > > OpenComparisonReportsAsync
(
const FString& ImportPath |
Imports screenshot comparison data from a given path asynchronously. | Interfaces/IScreenShotManager.h |