Navigation
API > API/Developer > API/Developer/FunctionalTesting
Base class for screenshot functional test
| Name | AScreenshotFunctionalTestBase |
| Type | class |
| Header File | /Engine/Source/Developer/FunctionalTesting/Classes/ScreenshotFunctionalTestBase.h |
| Include Path | #include "ScreenshotFunctionalTestBase.h" |
Syntax
UCLASS (MinimalAPI, Blueprintable, Abstract)
class AScreenshotFunctionalTestBase : public AFunctionalTest
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → AFunctionalTest → AScreenshotFunctionalTestBase
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
AScreenshotFunctionalTestBase
(
const FObjectInitializer& ObjectInitializer |
ScreenshotFunctionalTestBase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bNeedsViewportRestore | bool | ScreenshotFunctionalTestBase.h | ||
| bNeedsViewSettingsRestore | bool | ScreenshotFunctionalTestBase.h | ||
| bScreenshotCompleted | bool | ScreenshotFunctionalTestBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanEditChange
(
const FProperty* InProperty |
ScreenshotFunctionalTestBase.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
ScreenshotFunctionalTestBase.h | ||
virtual void Serialize
(
FArchive& Ar |
ScreenshotFunctionalTestBase.h |
Overridden from AFunctionalTest
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void FinishTest
(
EFunctionalTestResult TestResult, |
ScreenshotFunctionalTestBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void OnComparisonComplete
(
const FAutomationScreenshotCompareResults& CompareResults |
Do some logging and trigger OnScreenshotTakenAndCompared. | ScreenshotFunctionalTestBase.h | |
virtual void OnScreenShotCaptured
(
int32 InSizeX, |
Pass screenshot pixels and meta data to FAutomationTestFramework. | ScreenshotFunctionalTestBase.h | |
virtual void OnScreenshotTakenAndCompared() |
Call RestoreViewport and finish this test. | ScreenshotFunctionalTestBase.h | |
void PrepareForScreenshot() |
Resize viewport to screenshot size (if possible) and set up screenshot environment (disable AA, etc.) | ScreenshotFunctionalTestBase.h | |
virtual void RequestScreenshot() |
Doesn't actually request in base class. It simply register OnScreenshotCaptured. | ScreenshotFunctionalTestBase.h | |
void RestoreViewSettings() |
Restore viewport size and original environment settings. | ScreenshotFunctionalTestBase.h |
Overridden from AFunctionalTest
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsReady_Implementation() |
Handle screenshot delay. | ScreenshotFunctionalTestBase.h | |
virtual void OnTimeout() |
ScreenshotFunctionalTestBase.h | ||
virtual void PrepareTest() |
Set player view target to screenshot camera and call PrepareForScreenshot. | ScreenshotFunctionalTestBase.h | |
virtual void StartTest() |
Register OnScreenshotTakenAndCompared and call RequestScreenshot. | ScreenshotFunctionalTestBase.h |