Navigation
Unreal Engine C++ API Reference > Developer > ScreenShotComparisonTools > Interfaces > IScreenShotManager
References
Module | ScreenShotComparisonTools |
Header | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h |
Include | #include "Interfaces/IScreenShotManager.h" |
[TFuture](API\Runtime\Core\Async\TFuture)< [FImageComparisonResult](API\Developer\ScreenShotComparisonTools\FImageComparisonResult) > CompareScreenshotAsync ( const [FString](API\Runtime\Core\Containers\FString) & IncomingPath, const [FAutomationScreenshotMetadata](API\Runtime\AutomationMessages\FAutomationScreenshotMetadata) & MetaData, const [EScreenShotCompareOptions](API\Developer\ScreenShotComparisonTools\Interfaces\EScreenShotCompareOptions) Options )
Remarks
Takes the file at the provided path and uses the metadata to find and compare it with a ground truth version.
TFuture
Parameters
Name | 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) |