Navigation
API > API/Developer > API/Developer/ScreenShotComparisonTools > API/Developer/ScreenShotComparisonTools/Interfaces
References
Module | ScreenShotComparisonTools |
Header | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h |
Include | #include "Interfaces/IScreenShotManager.h" |
Syntax
class IScreenShotManager
Remarks
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.
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
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. |
![]() |
FScreenshotExportResult | ExportScreenshotComparisonResult
(
FString ScreenshotName, |
Exports target screenshot report to the export location specified |
![]() ![]() |
FString | GetIdealApprovedFolderForImage
(
const FAutomationScreenshotMetadata& MetaData |
Calculate the ideal path for already already approved (ground truth) images. |
![]() |
bool | OpenComparisonReports
(
FString ImportPath, |
Imports screenshot comparison data from a given path. |