UUserInterfaceSettings

User Interface settings that control Slate and UMG.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/UserInterfaceSettings.h

Include

#include "Engine/UserInterfaceSettings.h"

Syntax

class UUserInterfaceSettings : public UDeveloperSettings

Remarks

User Interface settings that control Slate and UMG.

Variables

Name Description

Public variable

float

 

ApplicationScale

An optional application scale to apply on top of the custom scaling rules.

Public variable

bool

 

bAllowHighDPIInGameMode

If true, game window on desktop platforms will be created with high-DPI awareness enabled.

Public variable

bool

 

bLoadWidgetsOnDedicatedServer

If false, widget references will be stripped during cook for server builds and not loaded at runtime.

Public variable

FSoftClassPath

 

CustomScalingRuleClass

Set DPI Scale Rule to Custom, and this class will be used instead of any of the built-in rules.

Public variable

FIntPoint

 

DesignScreenSize

Used only with ScaleToFit scaling rule.

Public variable

 

DisplayName

Controls how the UI is scaled at different resolutions based on the DPI Scale Rule

Public variable

TMap< TEnumAsBy...

 

HardwareCursors

Public variable

ERenderFocusRul...

 

RenderFocusRule

Rule to determine if we should render the Focus Brush for widgets that have user focus.

Public variable

TMap< TEnumAsBy...

 

SoftwareCursors

Public variable

EUIScalingRule

 

UIScaleRule

The rule used when trying to decide what scale to apply.

Public variable

 

XAxisName

Public variable

 

YAxisName

Constructors

Name Description

Public function

UUserInterfaceSettings

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

ForceLoadResources

(
    bool bForceLoadEverything
)

Loads assets, if bForceLoadEverything is true it will load despite environment

Public function Const

float

 

GetDPIScaleBasedOnSize

(
    FIntPoint Size
)

Gets the current scale of the UI based on the size of a viewport

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

UObject interface

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Deprecated Variables

Name Description

Public variable

FSoftClassPath

 

CrosshairsCursor_DEPRECATED

DEPRECATED 4.16.

Public variable

FSoftClassPath

 

DefaultCursor_DEPRECATED

DEPRECATED 4.16.

Public variable

FSoftClassPath

 

GrabHandClosedCursor_DEPRECATED

DEPRECATED 4.16.

Public variable

FSoftClassPath

 

GrabHandCursor_DEPRECATED

DEPRECATED 4.16.

Public variable

FSoftClassPath

 

HandCursor_DEPRECATED

DEPRECATED 4.16.

Public variable

FSoftClassPath

 

SlashedCircleCursor_DEPRECATED

DEPRECATED 4.16.

Public variable

FSoftClassPath

 

TextEditBeamCursor_DEPRECATED

DEPRECATED 4.16.