Navigation
Unreal Engine C++ API Reference > 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 |
---|---|---|
~IScreenShotManager () |
Functions
Type | Name | Description |
---|---|---|
TFuture< FIm... | CompareScreenshotAsync ( const FString& IncomingPath, const FAutomationScreenshotMetadata..., const EScreenShotCompareOptions Opt... ) | Takes the file at the provided path and uses the metadata to find and compare it with a ground truth version. |
FScreenshotE... | ExportScreenshotComparisonResult ( FString ScreenshotName, FString ExportPath, bool bOnlyIncoming ) | Exports target screenshot report to the export location specified |
FString | GetIdealApprovedFolderForImage ( const FAutomationScreenshotMetadata... ) | Calculate the ideal path for already already approved (ground truth) images. |
bool | OpenComparisonReports ( FString ImportPath, TArray< FComparisonReport >& OutRe... ) | Imports screenshot comparison data from a given path. |