1. Epic GamesDeveloper
  3. FAutomationScreenshotOptions

FAutomationScreenshotOptions

API > API/Developer > API/Developer/FunctionalTesting

   
Name FAutomationScreenshotOptions
Type struct
Header File /Engine/Source/Developer/FunctionalTesting/Public/AutomationScreenshotOptions.h
Include Path #include "AutomationScreenshotOptions.h"

Syntax

USTRUCT (BlueprintType )  
struct FAutomationScreenshotOptions

Constructors

Name Remarks Include Path Unreal Specifiers
  AutomationScreenshotOptions.h  
  AutomationScreenshotOptions.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDisableNoisyRenderingFeatures bool 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. AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Screenshot"
bDisableTonemapping bool Disables Eye Adaptation and sets Tonemapper to fixed gamma curve. AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Screenshot"
  • Meta=(EditCondition="!bDisableNoisyRenderingFeatures", DisplayName="Disable Eye Adaptation")
bIgnoreAntiAliasing bool 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. AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Comparison"
bIgnoreColors bool If this is true, all we compare is luminance of the scene. AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Comparison"
  • AdvancedDisplay
bOverride_OverrideTimeTo bool   AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(PinHiddenByDefault, InlineEditConditionToggle)
Delay float The delay before we take the screenshot (measured in seconds). AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Screenshot"
FrameDelay int32 The delay before we take the screenshot (measured in number of frames). AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Screenshot"
MaximumGlobalError float After you've accounted for color tolerance changes, you now need to control for total acceptable error. AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Comparison"
  • Meta=(ClampMin=0, ClampMax=1, UIMin=0, UIMax=1)
MaximumLocalError float After you've accounted for color tolerance changes, you now need to control for local acceptable error. AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Comparison"
  • Meta=(ClampMin=0, ClampMax=1, UIMin=0, UIMax=1)
OverrideTimeTo double Overrides World Time, Real Time to the value provided. AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Screenshot"
  • Meta=(editcondition="bOverride_OverrideTimeTo")
Resolution FVector2D The desired resolution of the screenshot, if none is provided, it will use the default for the platform setup in the automation settings. AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Screenshot"
Tolerance EComparisonTolerance 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. AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Comparison"
ToleranceAmount FComparisonToleranceAmount For each channel and brightness levels you can control a region where the colors are found to be essentially the same. AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Comparison"
ViewSettings TObjectPtr< UAutomationViewSettings > Assign custom view settings to control which rendering options we allow on while taking the screenshot. AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Screenshot"
VisualizeBuffer FName Allows you to screenshot a buffer other than the default final lit scene image. AutomationScreenshotOptions.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Screenshot"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SetToleranceAmounts ( EComparisonTolerance InTolerance
)

   AutomationScreenshotOptions.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page