UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
IHardwareSurveyModule Class Referenceabstract

#include <IHardwareSurveyModule.h>

+ Inheritance diagram for IHardwareSurveyModule:

Public Member Functions

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

Static Public Member Functions

static IHardwareSurveyModule & Get ()
 
static bool IsAvailable ()
 

Detailed Description

Interface for the hardware survey module.

Constructor & Destructor Documentation

◆ ~IHardwareSurveyModule()

virtual IHardwareSurveyModule::~IHardwareSurveyModule ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ Get()

static IHardwareSurveyModule & IHardwareSurveyModule::Get ( )
inlinestatic

Singleton-like access to this module's interface. Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.

Returns
Returns singleton instance, loading the module on demand if needed

◆ IsAvailable()

static bool IHardwareSurveyModule::IsAvailable ( )
inlinestatic

Checks to see if this module is loaded and ready.

Returns
True if the module is loaded and ready to use

◆ StartHardwareSurvey()

virtual void IHardwareSurveyModule::StartHardwareSurvey ( IAnalyticsProvider &  AnalyticsProvider)
pure virtual

Init and begin the async platform hardware survey.

Parameters
AnalyticsProviderThe analytics provider to use when sending survey info.

Implemented in FHardwareSurveyModule.

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