AScreenshotFunctionalTestBase

Base class for screenshot functional test

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

FunctionalTesting

Header

/Engine/Source/Developer/FunctionalTesting/Classes/ScreenshotFunctionalTestBase.h

Include

#include "ScreenshotFunctionalTestBase.h"

Syntax

class AScreenshotFunctionalTestBase : public AFunctionalTest

Remarks

Base class for screenshot functional test

Variables

Name Description

Protected variable

FString

 

Notes

Protected variable

TObjectPtr< cla...

 

ScreenshotCamera

Protected variable

FAutomationScre...

 

ScreenshotOptions

Protected variable

FIntPoint

 

ViewportRestoreSize

Constructors

Name Description

Public function

AScreenshotFunctionalTestBase

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

void

 

OnComparisonComplete

(
    const FAutomationScreenshotCompareR...
)

Do some logging and trigger OnScreenshotTakenAndCompared.

Protected function

void

 

OnScreenShotCaptured

(
    int32 InSizeX,
    int32 InSizeY,
    const TArray< FColor >& InImageDat...
)

Pass screenshot pixels and meta data to FAutomationTestFramework.

Protected function Virtual

void

 

OnScreenshotTakenAndCompared()

Call RestoreViewport and finish this test.

Protected function

void

 

PrepareForScreenshot()

Resize viewport to screenshot size (if possible) and set up screenshot environment (disable AA, etc.)

Protected function Virtual

void

 

RequestScreenshot()

Doesn't actually request in base class. It simply register OnScreenshotCaptured.

Protected function

void

 

RestoreViewSettings()

Restore viewport size and original environment settings.

Overridden from AFunctionalTest

Name Description

Protected function Virtual

bool

 

IsReady_Implementation()

Handle screenshot delay.

Protected function Virtual

void

 

PrepareTest()

Set player view target to screenshot camera and call PrepareForScreenshot.

Protected function Virtual

void

 

StartTest()

Register OnScreenshotTakenAndCompared and call RequestScreenshot.

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

CanEditChange

(
    const FProperty* InProperty
)

Called by the editor to query whether a property of this object is allowed to be modified.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.