1. Epic GamesDeveloper
  3. AScreenshotFunctionalTestBase

AScreenshotFunctionalTestBase

Base class for screenshot functional test

API > API/Developer > API/Developer/FunctionalTesting

Inheritance Hierarchy

References

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

Syntax

UCLASS (Blueprintable, Abstract)  
class AScreenshotFunctionalTestBase : public AFunctionalTest

Remarks

Base class for screenshot functional test

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FString Notes  
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< class UCameraComponent > ScreenshotCamera  
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly simpledisplay FAutomationScreenshotOptions ScreenshotOptions  
Protected variable FIntPoint ViewportRestoreSize  

Constructors

  Type Name Description
Public function  

AScreenshotFunctionalTestBase ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

  
Protected function void

OnComparisonComplete ( const FAutomationScreenshotCompareResults& CompareResults
)

 Do some logging and trigger OnScreenshotTakenAndCompared.
Protected function Virtual void

OnScreenShotCaptured ( int32 InSizeX,
int32 InSizeY,
const TArray< FColor >& InImageData
)

 Pass screenshot pixels and meta data to FAutomationTestFramework.
Protected function Virtual void Call RestoreViewport and finish this test.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Protected function void Resize viewport to screenshot size (if possible) and set up screenshot environment (disable AA, etc.)
Protected function Virtual void Doesn't actually request in base class. It simply register OnScreenshotCaptured.
Protected function void Restore viewport size and original environment settings.
Public function Virtual void

Serialize ( FArchive& Ar
)

  

Overridden from AFunctionalTest

  Type Name Description
Public function Virtual void

FinishTest ( EFunctionalTestResult TestResult,
const FString& Message
)

  
Protected function Virtual bool Handle screenshot delay.
Protected function Virtual void  
Protected function Virtual void Set player view target to screenshot camera and call PrepareForScreenshot.
Protected function Virtual void Register OnScreenshotTakenAndCompared and call RequestScreenshot.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page