Navigation
API > API/Runtime > API/Runtime/Engine
User Interface settings that control Slate and UMG.
| Name | UUserInterfaceSettings |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/UserInterfaceSettings.h |
| Include Path | #include "Engine/UserInterfaceSettings.h" |
Syntax
UCLASS (Config=Engine, defaultconfig, Meta=(DisplayName="User Interface"), MinimalAPI)
class UUserInterfaceSettings : public UDeveloperSettings
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDeveloperSettings → UUserInterfaceSettings
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UUserInterfaceSettings
(
const FObjectInitializer& ObjectInitializer |
Engine/UserInterfaceSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ApplicationScale | float | An optional application scale to apply on top of the custom scaling rules. | Engine/UserInterfaceSettings.h |
|
| bAllowHighDPIInGameMode | bool | If true, game window on desktop platforms will be created with high-DPI awareness enabled. | Engine/UserInterfaceSettings.h |
|
| bAuthorizeAutomaticWidgetVariableCreation | bool | Setting to authorize or not automatic variable creation. | Engine/UserInterfaceSettings.h |
|
| bEnableDistanceFieldFontRasterization | bool | Engine/UserInterfaceSettings.h |
|
|
| bLoadWidgetsOnDedicatedServer | bool | If false, widget references will be stripped during cook for server builds and not loaded at runtime. | Engine/UserInterfaceSettings.h |
|
| CustomScalingRuleClass | FSoftClassPath | Set DPI Scale Rule to Custom, and this class will be used instead of any of the built-in rules. | Engine/UserInterfaceSettings.h |
|
| DesignScreenSize | FIntPoint | Used only with ScaleToFit scaling rule. | Engine/UserInterfaceSettings.h |
|
| DisplayName | Controls how the UI is scaled at different resolutions based on the DPI Scale Rule | Engine/UserInterfaceSettings.h |
|
|
| HardwareCursors | TMap< TEnumAsByte< EMouseCursor::Type >, FHardwareCursorReference > | Engine/UserInterfaceSettings.h |
|
|
| RenderFocusRule | ERenderFocusRule | Rule to determine if we should render the Focus Brush for widgets that have user focus. | Engine/UserInterfaceSettings.h |
|
| SoftwareCursors | TMap< TEnumAsByte< EMouseCursor::Type >, FSoftClassPath > | Engine/UserInterfaceSettings.h |
|
|
| UIScaleRule | EUIScalingRule | The rule used when trying to decide what scale to apply. | Engine/UserInterfaceSettings.h |
|
| XAxisName | Engine/UserInterfaceSettings.h |
|
||
| YAxisName | Engine/UserInterfaceSettings.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUseCustomFontDPI | bool | To set your own custom value, check this box, then enter the value in the text box. | Engine/UserInterfaceSettings.h |
|
| CalculatedScale | float | Engine/UserInterfaceSettings.h | ||
| CursorClasses | TArray< TObjectPtr< UObject > > | This is just holding on to references to prevent GC in the Editor (tied to the lifetime of this object) | Engine/UserInterfaceSettings.h |
|
| CustomFontDPI | uint32 | Controls the relationship between UMG font size and pixel height. | Engine/UserInterfaceSettings.h |
|
| CustomScalingRule | TObjectPtr< UDPICustomScalingRule > | Engine/UserInterfaceSettings.h |
|
|
| CustomScalingRuleClassInstance | TObjectPtr< UClass > | Engine/UserInterfaceSettings.h |
|
|
| FontDPIPreset | EFontDPI | Controls the relationship between UMG font size and pixel height. | Engine/UserInterfaceSettings.h |
|
| LastViewportSize | TOptional< FIntPoint > | Engine/UserInterfaceSettings.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ForceLoadResources
(
bool bForceLoadEverything |
Loads assets, if bForceLoadEverything is true it will load despite environment | Engine/UserInterfaceSettings.h | |
float GetDPIScaleBasedOnSize
(
FIntPoint Size |
Gets the current scale of the UI based on the size of a viewport | Engine/UserInterfaceSettings.h | |
uint32 GetFontDisplayDPI() |
Gets the Font DPI that should be used for display | Engine/UserInterfaceSettings.h | |
| Gets the string to use when we need detailed info about the DPI. | Engine/UserInterfaceSettings.h | ||
virtual void PostInitProperties() |
Engine/UserInterfaceSettings.h |
Overridden from UDeveloperSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Engine/UserInterfaceSettings.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static EFontDPI ConvertToEFontDPI
(
uint32 inFontDPI |
Convert from an int to an entry in the EFontDPI enum. | Engine/UserInterfaceSettings.h | |
static uint32 ConvertToFontDPI
(
EFontDPI inFontDPIEntry |
Convert from an entry in the EFontDPI enum to an int | Engine/UserInterfaceSettings.h | |
static bool ShouldDisplayDistanceFieldFontSettings() |
Engine/UserInterfaceSettings.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CrosshairsCursor_DEPRECATED | FSoftClassPath | DEPRECATED 4.16. | Engine/UserInterfaceSettings.h |
|
| DefaultCursor_DEPRECATED | FSoftClassPath | DEPRECATED 4.16. | Engine/UserInterfaceSettings.h |
|
| GrabHandClosedCursor_DEPRECATED | FSoftClassPath | DEPRECATED 4.16. | Engine/UserInterfaceSettings.h |
|
| GrabHandCursor_DEPRECATED | FSoftClassPath | DEPRECATED 4.16. | Engine/UserInterfaceSettings.h |
|
| HandCursor_DEPRECATED | FSoftClassPath | DEPRECATED 4.16. | Engine/UserInterfaceSettings.h |
|
| SlashedCircleCursor_DEPRECATED | FSoftClassPath | DEPRECATED 4.16. | Engine/UserInterfaceSettings.h |
|
| TextEditBeamCursor_DEPRECATED | FSoftClassPath | DEPRECATED 4.16. | Engine/UserInterfaceSettings.h |
|