AScreenshotFunctionalTestBase

Base class for screenshot functional test

Unreal Engine C++ API Reference > Developer > FunctionalTesting

Inheritance Hierarchy

References

   
Module FunctionalTesting
Header /Engine/Source/Developer/FunctionalTesting/Classes/ScreenshotFunctionalTestBase.h
Include #include "ScreenshotFunctionalTestBase.h"

Syntax

class AScreenshotFunctionalTestBase : public [AFunctionalTest](API\Developer\FunctionalTesting\AFunctionalTest)  

Remarks

Base class for screenshot functional test

Variables

Type Name Description
FString Notes  
TObjectPtr< cla... ScreenshotCamera  
FAutomationScre... ScreenshotOptions  
FIntPoint ViewportRestoreSize  

Constructors

Type Name Description
  AScreenshotFunctionalTestBase ( const FObjectInitializer& ObjectIn... )  

Functions

Type Name Description
void OnComparisonComplete ( const FAutomationScreenshotCompareR... ) Do some logging and trigger OnScreenshotTakenAndCompared.
void OnScreenShotCaptured ( int32 InSizeX, int32 InSizeY, const TArray< FColor >& InImageDat... ) Pass screenshot pixels and meta data to FAutomationTestFramework.
void OnScreenshotTakenAndCompared () Call RestoreViewport and finish this test.
void PrepareForScreenshot () Resize viewport to screenshot size (if possible) and set up screenshot environment (disable AA, etc.)
void RequestScreenshot () Doesn't actually request in base class. It simply register OnScreenshotCaptured.
void RestoreViewSettings () Restore viewport size and original environment settings.

Overridden from AFunctionalTest

Type Name Description
bool IsReady_Implementation () Handle screenshot delay.
void PrepareTest () Set player view target to screenshot camera and call PrepareForScreenshot.
void StartTest () Register OnScreenshotTakenAndCompared and call RequestScreenshot.

Overridden from UObject

Type Name Description
bool CanEditChange ( const FProperty* InProperty ) Called by the editor to query whether a property of this object is allowed to be modified.
void PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... ) Called when a property on this object has been modified externally
void Serialize ( FArchive& Ar ) Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library