IScreenShotManager

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.

Windows
MacOS
Linux

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

Name Description

Public function Virtual

~IScreenShotManager()

Functions

Name Description

Public function

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.

Public function

FScreenshotE...

 

ExportScreenshotComparisonResult

(
    FString ScreenshotName,
    FString ExportPath
)

Exports target screenshot report to the export location specified

Public function

bool

 

OpenComparisonReports

(
    FString ImportPath,
    TArray< FComparisonReport >& OutRe...
)

Imports screenshot comparison data from a given path.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss