1. Epic GamesDeveloper
  3. UDeviceProfileManager

UDeviceProfileManager

Implements a helper class that manages all profiles in the Device

API > API/Runtime > API/Runtime/Engine

Implements a helper class that manages all profiles in the Device

   
Name UDeviceProfileManager
Type class
Header File /Engine/Source/Runtime/Engine/Classes/DeviceProfiles/DeviceProfileManager.h
Include Path #include "DeviceProfiles/DeviceProfileManager.h"

Syntax

UCLASS (Config=DeviceProfiles, Transient, MinimalAPI)  
class UDeviceProfileManager : public UObject

Inheritance Hierarchy

Enums

Public

Name Remarks
EDeviceProfileMode  

Constants

Name Type Remarks Include Path
BackupSuffix FString Add to profile to get load time backup. DeviceProfiles/DeviceProfileManager.h
DeviceProfileManagerSingleton class UDeviceProfileManager *   DeviceProfiles/DeviceProfileManager.h
DeviceProfileScalabilityCVars TMap< FString, FString > Stores any scalability group settings set by the active device profile. DeviceProfiles/DeviceProfileManager.h
PlatformFragmentsSelected TArray< FSelectedFragmentProperties > The list of fragments that have been selected by the active profile. DeviceProfiles/DeviceProfileManager.h
PreviewDeviceProfileScalabilityCVars TMap< FString, FString > Stores any scalability group settings set by the preview device profile. DeviceProfiles/DeviceProfileManager.h
PushedSettings TMap< FString, FPushedCVarSetting > Original values of all the CVars modified by the DP. Used to undo the DP before applying new state. DeviceProfiles/DeviceProfileManager.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Profiles TArray< TObjectPtr< UDeviceProfile > > Holds the collection of managed profiles. DeviceProfiles/DeviceProfileManager.h
  • EditAnywhere
  • Category=Properties

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveDeviceProfile UDeviceProfile * Holds the selected device profile. DeviceProfiles/DeviceProfileManager.h  
ActiveDeviceProfileChangedDelegate FOnActiveDeviceProfileChanged Holds a delegate to be invoked when the active deviceprofile changes. DeviceProfiles/DeviceProfileManager.h  
BackupProfiles TArray< TObjectPtr< UDeviceProfile > > Cached copy of profiles at load. DeviceProfiles/DeviceProfileManager.h  
BaseDeviceProfile UDeviceProfile * Holds the device profile that has been overridden, null no override active. DeviceProfiles/DeviceProfileManager.h  
ManagerUpdatedDelegate FOnDeviceProfileManagerUpdated Holds a delegate to be invoked profiles are updated. DeviceProfiles/DeviceProfileManager.h  
PostReapplyDeviceProfilesDelegate FOnReapplyDeviceProfiles Holds a delegate to be invoked post reapply device profiles. DeviceProfiles/DeviceProfileManager.h  
PreReapplyDeviceProfilesDelegate FWillReapplyDeviceProfiles Holds a delegate to be invoked pre reapply device profiles. DeviceProfiles/DeviceProfileManager.h  
PreviewDeviceProfile UDeviceProfile * Holds the device profile that we are previewing. DeviceProfiles/DeviceProfileManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ChangeTaggedFragmentState ( FName FragmentTag,
bool bNewState
)

 Enable/Disable a tagged fragment of the active device profile. DeviceProfiles/DeviceProfileManager.h  

UDeviceProfile * CreateProfile ( const FString& ProfileName,
const FString& ProfileType,
const FString& ParentName,
const TCHAR* ConfigPlatform
)

 Create a copy of a device profile from a copy. DeviceProfiles/DeviceProfileManager.h  

void DeleteProfile ( UDeviceProfile* Profile
)

 Delete a profile. DeviceProfiles/DeviceProfileManager.h  

bool DoActiveProfilesReference ( const TSet< FString >& DeviceProfilesToQuery
)

 Examine the currently active or overridden profile for references to entries in DeviceProfilesToQuery DeviceProfiles/DeviceProfileManager.h  

UDeviceProfile * FindProfile ( const FString& ProfileName,
bool bCreateProfileOnFail,
FName OptionalPlatformName
)

 Find a profile based on the name. DeviceProfiles/DeviceProfileManager.h  
Return the selected fragment property from the currently active device profile. DeviceProfiles/DeviceProfileManager.h  

const FString GetActiveDeviceProfileMatchedFragmentsString ( bool bEnabledOnly,
bool bIncludeTags,
bool bAlphaSort
)

 Get a string containing the current matched fragment list. DeviceProfiles/DeviceProfileManager.h  

const FString GetActiveDeviceProfileName()

 Get the current active profile name. DeviceProfiles/DeviceProfileManager.h  

UDeviceProfile * GetActiveProfile()

 Get the selected device profile DeviceProfiles/DeviceProfileManager.h  

void GetAllPossibleParentProfiles ( const UDeviceProfile* ChildProfile,
TArray< UDeviceProfile* >& PossibleParentProfiles
) const

 Get a list of all possible parent profiles for a given device profile DeviceProfiles/DeviceProfileManager.h  

TArray< TTuple< FName, FString > > GetDPChain ( const FString& DeviceProfileName,
FConfigCacheIni* ConfigSystem
)

 Gets the parent chain and fragment that make up the final DP settings DeviceProfiles/DeviceProfileManager.h  

TArray< FString > GetLoadableProfileNames ( FName OptionalPlatformName
) const

 Get a list of all a named device profiles that are available to call CreateProfile with. DeviceProfiles/DeviceProfileManager.h  

UDeviceProfile * GetPreviewDeviceProfile()

 Get the currently previewing device profile. Can be null. DeviceProfiles/DeviceProfileManager.h  

void GetProfileConfigFiles ( TArray< FString >& OutConfigFiles
)

 Returns the config files for all loaded device profiles, this will include platform-specific ones DeviceProfiles/DeviceProfileManager.h  

bool HasLoadableProfileName ( const FString& ProfileName,
FName OptionalPlatformName
)

 Tests to see if a named device profile is available to call CreateProfile with. DeviceProfiles/DeviceProfileManager.h  

void LoadProfiles()

 Load the device profiles from the config file. DeviceProfiles/DeviceProfileManager.h  

FOnActiveDeviceProfileChanged & OnActiveDeviceProfileChanged()

 Returns a delegate that is invoked when the active device profile changes DeviceProfiles/DeviceProfileManager.h  

FOnDeviceProfileManagerUpdated & OnManagerUpdated()

 Returns a delegate that is invoked when manager is updated. DeviceProfiles/DeviceProfileManager.h  

FOnReapplyDeviceProfiles & OnReapplyDeviceProfiles()

 Returns a delegate that is invoked post reapply device profiles DeviceProfiles/DeviceProfileManager.h  

void ReapplyDeviceProfile ( bool bForceReload,
TSet< FString >* ModifiedCVars
)

 Reapplies the device profile. DeviceProfiles/DeviceProfileManager.h  

void RestoreDefaultDeviceProfile()

 Restore the device profile to the default for this device DeviceProfiles/DeviceProfileManager.h  

void SaveProfiles ( bool bSaveToDefaults
)

 Save the device profiles. DeviceProfiles/DeviceProfileManager.h  

void SetOverrideDeviceProfile ( UDeviceProfile* DeviceProfile
)

 Overrides the device profile. The original profile can be restored with RestoreDefaultDeviceProfile DeviceProfiles/DeviceProfileManager.h  

FWillReapplyDeviceProfiles & WillReapplyDeviceProfiles()

 Returns a delegate that is invoked pre reapply device profiles DeviceProfiles/DeviceProfileManager.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostCDOContruct()

   DeviceProfiles/DeviceProfileManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static TArray< FString > FindAllReferencedFragmentsFromMatchedRules ( const FString& ParentDP,
FConfigCacheIni* ConfigSystem
)

 Read and discover all of the possible fragments referenced by the matching rules. DeviceProfiles/DeviceProfileManager.h  

static TArray< FSelectedFragmentProperties > FindMatchingFragments ( const FString& ParentDP,
FConfigCacheIni* PreviewConfigSystem
)

 Read and process all of the fragment matching rules. DeviceProfiles/DeviceProfileManager.h  

static const FString FragmentPropertyArrayToFragmentString ( const TArray< FSelectedFragmentProperties >& FragmentProperties,
bool bEnabledOnly,
bool bIncludeTags,
bool bAlphaSort
)

 Convert a FSelectedFragmentProperties array to a string DeviceProfiles/DeviceProfileManager.h  

static TMap< FName, FString > GatherDeviceProfileCVars ( const FString& DeviceProfileName,
EDeviceProfileMode GatherMode
)

 Walk the device profile/fragment chain to get the final set ot CVars in a unified way DeviceProfiles/DeviceProfileManager.h  

static UDeviceProfileManager & Get ( bool bFromPostCDOContruct
)

   DeviceProfiles/DeviceProfileManager.h  

static const FString GetActiveProfileName()

 Get the selected device profile name, either the platform name, or the name provided by a Device Profile Selector Module. DeviceProfiles/DeviceProfileManager.h  

static TMap< FName, TSet< FString > > GetAllReferencedDeviceProfileCVars ( UDeviceProfile* DeviceProfile
)

 Gather all the cvars from the static device profile and then add all of the possible cvars+values from the dynamic/matched rule fragments. DeviceProfiles/DeviceProfileManager.h  

static IDeviceProfileSelectorModule * GetDeviceProfileSelectorModule()

 Get the current platform's the selector module. Can return null DeviceProfiles/DeviceProfileManager.h  

static const FString GetPlatformDeviceProfileName()

 Get the selected device profile name, either the platform name, or the name provided by a Device Profile Selector Module. DeviceProfiles/DeviceProfileManager.h  

static bool GetScalabilityCVar ( const FString& CvarName,
int32& OutValue
)

 Retrieves the value of a scalability group cvar if it was set by the active device profile. DeviceProfiles/DeviceProfileManager.h  

static bool GetScalabilityCVar ( const FString& CvarName,
float& OutValue
)

   DeviceProfiles/DeviceProfileManager.h  

static void InitializeCVarsForActiveDeviceProfile ( bool bPushSettings,
bool bIsDeviceProfilePreview,
bool bForceReload
)

 Startup and select the active device profile Then Init the CVars from this profile and it's Device profile parent tree. DeviceProfiles/DeviceProfileManager.h  

static void SetDeviceProfileCVars ( const FString& DeviceProfileName
)

 Perform the processing of ini sections, going up to parents, etc. DeviceProfiles/DeviceProfileManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page