Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > DeviceProfiles > UDeviceProfileManager

Light Theme

Dark Theme

UDeviceProfileManager

Implements a helper class that manages all profiles in the Device

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDeviceProfileManager

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/DeviceProfiles/DeviceProfileManager.h
Include	#include "DeviceProfiles/DeviceProfileManager.h"

Syntax

class UDeviceProfileManager : public UObject

Remarks

Implements a helper class that manages all profiles in the Device

Variables

		Name	Description
	TArray< UObject...	Profiles	Holds the collection of managed profiles.

Functions

	Name	Description
UDeviceProfi...	CreateProfile ( const FString& ProfileName, const FString& ProfileType, const FString& ParentName, const TCHAR* ConfigPlatform )	Create a copy of a device profile from a copy.
void	DeleteProfile ( UDeviceProfile* Profile )	Delete a profile.
bool	DoActiveProfilesReference ( const TSet< FString >& DeviceProfi... )	Examine the currently active or overridden profile for references to entries in DeviceProfilesToQuery
UDeviceProfi...	FindProfile ( const FString& ProfileName, bool bCreateProfileOnFail )	Find a profile based on the name.
UDeviceProfi...	Get ( bool bFromPostCDOContruct )
const FStrin...	GetActiveDeviceProfileName()	Get the current active profile name.
UDeviceProfi...	GetActiveProfile()	Get the selected device profile
void	GetAllPossibleParentProfiles ( const UDeviceProfile* ChildPro..., OUTTArray< UDeviceProfile* >&... )	Get a list of all possible parent profiles for a given device profile
const FStrin...	GetPlatformDeviceProfileName()	Get the selected device profile name, either the platform name, or the name provided by a Device Profile Selector Module.
bool	GetScalabilityCVar ( const FString& CvarName, float& OutValue )	Retrieves the value of a scalability group cvar if it was set by the active device profile.
bool	GetScalabilityCVar ( const FString& CvarName, int32& OutValue )	Retrieves the value of a scalability group cvar if it was set by the active device profile.
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.
void	LoadProfiles()	Load the device profiles from the config file.
FOnActiveDev...	OnActiveDeviceProfileChanged()	Returns a delegate that is invoked when the active device profile changes
FOnDevicePro...	OnManagerUpdated()	Returns a delegate that is invoked when manager is updated.
void	ReapplyDeviceProfile ( bool bForceReload )	Reapplies the device profile.
void	RestoreDefaultDeviceProfile()	Restore the device profile to the default for this device
void	SaveProfiles ( bool bSaveToDefaults )	Save the device profiles.
void	SetOverrideDeviceProfile ( UDeviceProfile* DeviceProfile, bool bIsDeviceProfilePreview )	Overrides the device profile. The original profile can be restored with RestoreDefaultDeviceProfile

Overridden from UObject

		Name	Description
	void	PostCDOContruct()	Called after the C++ constructor has run on the CDO for a class.

Constants

Name	Description
DeviceProfileFileName	Holds the device profile .ini location.
DeviceProfileManagerSingleton
DeviceProfileScalabilityCVars	Stores any scalability group settings set by the active device profile.

Deprecated Functions

		Name	Description
	const FStrin...	GetActiveProfileName()	Use either GetActiveDeviceProfileName to have the current active device profile or GetPlatformDeviceProfileName to have the default one. Note, GetActiveDeviceProfileName will fallback on GetPlatformDeviceProfileName, if there is no active device profile

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss