UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FHardwareSurveyModule Class Reference
+ Inheritance diagram for FHardwareSurveyModule:

Public Member Functions

virtual void StartupModule () override
 
virtual void ShutdownModule () override
 
virtual void StartHardwareSurvey (IAnalyticsProvider &AnalyticsProvider) override
 
- Public Member Functions inherited from IHardwareSurveyModule
virtual ~IHardwareSurveyModule ()
 
- Public Member Functions inherited from IModuleInterface
virtual ~IModuleInterface ()
 
virtual void PreUnloadCallback ()
 
virtual void PostLoadCallback ()
 
virtual bool SupportsDynamicReloading ()
 
virtual bool SupportsAutomaticShutdown ()
 
virtual bool IsGameModule () const
 

Protected Member Functions

bool TickHardwareSurvey (float Delta)
 
bool IsHardwareSurveyRequired ()
 
FString HardwareSurveyBucketRAM (uint32 MemoryMB)
 
FString HardwareSurveyBucketVRAM (uint32 VidMemoryMB)
 
FString HardwareSurveyBucketResolution (uint32 DisplayWidth, uint32 DisplayHeight)
 
FString HardwareSurveyGetResolutionClass (uint32 LargestDisplayHeight)
 
void OnHardwareSurveyComplete (const FHardwareSurveyResults &SurveyResults)
 

Additional Inherited Members

- Static Public Member Functions inherited from IHardwareSurveyModule
static IHardwareSurveyModuleGet ()
 
static bool IsAvailable ()
 

Detailed Description

Implements the HardwareSurvey module.

Member Function Documentation

◆ HardwareSurveyBucketRAM()

FString FHardwareSurveyModule::HardwareSurveyBucketRAM ( uint32  MemoryMB)
inlineprotected

◆ HardwareSurveyBucketResolution()

FString FHardwareSurveyModule::HardwareSurveyBucketResolution ( uint32  DisplayWidth,
uint32  DisplayHeight 
)
inlineprotected

◆ HardwareSurveyBucketVRAM()

FString FHardwareSurveyModule::HardwareSurveyBucketVRAM ( uint32  VidMemoryMB)
inlineprotected

◆ HardwareSurveyGetResolutionClass()

FString FHardwareSurveyModule::HardwareSurveyGetResolutionClass ( uint32  LargestDisplayHeight)
inlineprotected

◆ IsHardwareSurveyRequired()

bool FHardwareSurveyModule::IsHardwareSurveyRequired ( )
inlineprotected

◆ OnHardwareSurveyComplete()

void FHardwareSurveyModule::OnHardwareSurveyComplete ( const FHardwareSurveyResults SurveyResults)
inlineprotected

◆ ShutdownModule()

virtual void FHardwareSurveyModule::ShutdownModule ( )
inlineoverridevirtual

Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finish StartupModule(). This means that, as long as a module references dependent modules in it's StartupModule(), it can safely reference those dependencies in ShutdownModule() as well.

Reimplemented from IModuleInterface.

◆ StartHardwareSurvey()

virtual void FHardwareSurveyModule::StartHardwareSurvey ( IAnalyticsProvider AnalyticsProvider)
inlineoverridevirtual

Init and begin the async platform hardware survey.

Parameters
AnalyticsProviderThe analytics provider to use when sending survey info.

Implements IHardwareSurveyModule.

◆ StartupModule()

virtual void FHardwareSurveyModule::StartupModule ( )
inlineoverridevirtual

Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule. ie:

FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

Reimplemented from IModuleInterface.

◆ TickHardwareSurvey()

bool FHardwareSurveyModule::TickHardwareSurvey ( float  Delta)
inlineprotected

The documentation for this class was generated from the following file: