UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IDeviceProfileSelectorModule Class Referenceabstract

#include <IDeviceProfileSelectorModule.h>

+ Inheritance diagram for IDeviceProfileSelectorModule:

Public Member Functions

 IDeviceProfileSelectorModule ()
 
virtual const FString GetRuntimeDeviceProfileName ()=0
 
virtual const FString GetDeviceProfileName ()
 
virtual void SetSelectorProperties (const TMap< FName, FString > &SelectorProperties)
 
virtual bool GetSelectorPropertyValue (const FName &PropertyType, FString &PropertyValueOUT)
 
virtual ~IDeviceProfileSelectorModule ()
 
- 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
 

Protected Attributes

float ConstrainedAspectRatio
 
FVector4f SafeZones
 

Detailed Description

Device Profile Selector module

Constructor & Destructor Documentation

◆ IDeviceProfileSelectorModule()

IDeviceProfileSelectorModule::IDeviceProfileSelectorModule ( )
inline

◆ ~IDeviceProfileSelectorModule()

virtual IDeviceProfileSelectorModule::~IDeviceProfileSelectorModule ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ GetDeviceProfileName()

virtual const FString IDeviceProfileSelectorModule::GetDeviceProfileName ( )
inlinevirtual

Run the logic to choose an appropriate device profile for this session.

Parameters
DeviceParametersA map of parameters to be used by device profile logic.
Returns
The name of the device profile to use for this session

◆ GetRuntimeDeviceProfileName()

virtual const FString IDeviceProfileSelectorModule::GetRuntimeDeviceProfileName ( )
pure virtual

Run the logic to choose an appropriate device profile for this session

Returns
The name of the device profile to use for this session

Implemented in IPIEPreviewDeviceModule.

◆ GetSelectorPropertyValue()

virtual bool IDeviceProfileSelectorModule::GetSelectorPropertyValue ( const FName PropertyType,
FString &  PropertyValueOUT 
)
inlinevirtual

◆ SetSelectorProperties()

virtual void IDeviceProfileSelectorModule::SetSelectorProperties ( const TMap< FName, FString > &  SelectorProperties)
inlinevirtual

Set or override the selector specific properties.

Parameters
SelectorPropertiesA map of parameters to be used by device profile matching logic.

Member Data Documentation

◆ ConstrainedAspectRatio

float IDeviceProfileSelectorModule::ConstrainedAspectRatio
protected

◆ SafeZones

FVector4f IDeviceProfileSelectorModule::SafeZones
protected

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