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

Public variable

TArray < UObject ...

 

Profiles

Holds the collection of managed profiles.

Functions

Name Description

Public function

UDeviceProfi ...

 

CreateProfile

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

Create a copy of a device profile from a copy.

Public function

void

 

DeleteProfile

(
    UDeviceProfile * Profile
)

Delete a profile.

Public function

bool

 

DoActiveProfilesReference

(
    const TSet < FString >& DeviceProfi...
)

Examine the currently active or overridden profile for references to entries in DeviceProfilesToQuery

Public function

UDeviceProfi ...

 

FindProfile

(
    const FString & ProfileName,
    bool bCreateProfileOnFail
)

Find a profile based on the name.

Public function Static

UDeviceProfi ...

 

Get

(
    bool bFromPostCDOContruct
)

Public function

const FStrin ...

 

GetActiveDeviceProfileName()

Get the current active profile name.

Public function Const

UDeviceProfi ...

 

GetActiveProfile()

Get the selected device profile

Public function Const

void

 

GetAllPossibleParentProfiles

(
    const UDeviceProfile * ChildPro...,
    OUTTArray < UDeviceProfile * >&...
)

Get a list of all possible parent profiles for a given device profile

Public function Static

const FStrin ...

 

GetPlatformDeviceProfileName()

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

Public function 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.

Public function Static

bool

 

GetScalabilityCVar

(
    const FString & CvarName,
    float& OutValue
)

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

Public function Static

void

 

InitializeCVarsForActiveDeviceProfile

(
    bool bPushSettings
)

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

Public function

void

 

LoadProfiles()

Load the device profiles from the config file.

Public function

FOnDevicePro ...

 

OnManagerUpdated()

Returns a delegate that is invoked when manager is updated.

Public function

void

 

ReapplyDeviceProfile()

Reapplies the device profile.

Public function

void

 

RestoreDefaultDeviceProfile()

Restore the device profile to the default for this device

Public function

void

 

SaveProfiles

(
    bool bSaveToDefaults
)

Save the device profiles.

Public function

void

 

SetOverrideDeviceProfile

(
    UDeviceProfile * DeviceProfile
)

Overrides the device profile. The original profile can be restored with RestoreDefaultDeviceProfile

Overridden from UObject

Name Description

Public function Virtual

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

Public function Static

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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback