FAutomationScreenshotOptions

Windows
MacOS
Linux

References

Module

FunctionalTesting

Header

/Engine/Source/Developer/FunctionalTesting/Public/AutomationScreenshotOptions.h

Include

#include "AutomationScreenshotOptions.h"

Syntax

struct FAutomationScreenshotOptions

Variables

Name Description

Public variable

bool

 

bDisableNoisyRenderingFeatures

Disables Anti-Aliasing, Motion Blur, Screen Space Reflections, Eye Adaptation, Tonemapper and Contact Shadows, because those features contribute a lot to the noise in the final rendered image.

Public variable

bool

 

bDisableTonemapping

Disables Eye Adaptation and sets Tonemapper to fixed gamma curve.

Public variable

bool

 

bIgnoreAntiAliasing

If this is true, we search neighboring pixels looking for the expected pixel as what may have happened, is that the pixel shifted a little.

Public variable

bool

 

bIgnoreColors

If this is true, all we compare is luminance of the scene.

Public variable

bool

 

bOverride_OverrideTimeTo

Public variable

float

 

Delay

The delay before we take the screenshot.

Public variable

float

 

MaximumGlobalError

After you've accounted for color tolerance changes, you now need to control for total acceptable error.

Public variable

float

 

MaximumLocalError

After you've accounted for color tolerance changes, you now need to control for local acceptable error.

Public variable

float

 

OverrideTimeTo

Overrides World Time, Real Time to the value provided.

Public variable

FVector2D

 

Resolution

The desired resolution of the screenshot, if none is provided, it will use the default for the platform setup in the automation settings.

Public variable

EComparisonTole...

 

Tolerance

These are quick defaults for tolerance levels, we default to low, because generally there's some constant variability in every pixel's color introduced by TxAA.

Public variable

FComparisonTole...

 

ToleranceAmount

For each channel and brightness levels you can control a region where the colors are found to be essentially the same.

Public variable

UAutomationView...

 

ViewSettings

Assign custom view settings to control which rendering options we allow on while taking the screenshot.

Public variable

FName

 

VisualizeBuffer

Allows you to screenshot a buffer other than the default final lit scene image.

Constructors

Functions

Name Description

Public function

void

 

SetToleranceAmounts

(
    EComparisonTolerance InTolerance
)

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