DefaultInteractiveFramerateDuration

DefaultInteractiveFramerateDuration

#Overview

name: DefaultInteractiveFramerateDuration

The value of this variable can be defined or overridden in .ini config files. 1 .ini config file referencing this setting variable.

It is referenced in 3 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of DefaultInteractiveFramerateDuration is to set a default duration for interactive framerate tests in Unreal Engine’s automation testing system. This variable is primarily used in the Engine’s automation and testing subsystems.

Based on the callsites, this setting variable is relied upon by the Unreal Engine’s automation testing module, specifically within the AutomationCommon and AutomationTestSettings components.

The value of this variable is set in the UAutomationTestSettings constructor (AutomationTestSettings.cpp) with a default value of 5.0 seconds. It can be modified through the engine’s configuration system, as indicated by the ‘config’ specifier in the UPROPERTY macro.

This variable interacts with other automation test settings, such as DefaultInteractiveFramerate and DefaultInteractiveFramerateWaitTime. It’s used in conjunction with these variables to control the behavior of interactive framerate tests.

Developers must be aware that this variable affects the duration of interactive framerate tests in the automation system. Changing this value will impact the length of time these tests run, which could affect the overall duration of the test suite and potentially the accuracy of performance measurements.

Best practices when using this variable include:

  1. Carefully consider the impact on test duration and accuracy before modifying the default value.
  2. Ensure that the duration is long enough to capture meaningful data but not so long as to unnecessarily extend test execution time.
  3. Document any changes to this value in project-specific testing guidelines.
  4. Consider the relationship between this variable and other framerate test settings to maintain consistency in test behavior.
  5. Use project-specific configuration files to override the default value when necessary, rather than modifying the engine source directly.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/BaseEngine.ini:2799, section: [AutomationTesting.StaticMeshEditorTest]

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Source/Runtime/Engine/Classes/Tests/AutomationTestSettings.h:462

Scope (from outer to inner):

file
class        class UAutomationTestSettings : public UObject

Source code excerpt:

	 */
	UPROPERTY(EditAnywhere, config, Category = Automation)
	float DefaultInteractiveFramerateDuration;
};

#Loc: <Workspace>/Engine/Source/Runtime/Engine/Private/Tests/AutomationCommon.cpp:577

Scope (from outer to inner):

file
function     FWaitForInteractiveFrameRate::FWaitForInteractiveFrameRate

Source code excerpt:

	if (Duration == 0)
	{
		Duration = AutomationTestSettings->DefaultInteractiveFramerateDuration;
	}

	if (MaxWaitTime == 0)
	{
		MaxWaitTime = AutomationTestSettings->DefaultInteractiveFramerateWaitTime;
	}

#Loc: <Workspace>/Engine/Source/Runtime/Engine/Private/Tests/AutomationTestSettings.cpp:14

Scope (from outer to inner):

file
function     UAutomationTestSettings::UAutomationTestSettings

Source code excerpt:

	DefaultInteractiveFramerate = 10.f;
	DefaultInteractiveFramerateWaitTime = 10.f * 60.f;		// 10 minutes - assume shaders and other DDC may need to be built
	DefaultInteractiveFramerateDuration = 5.f;
}