Navigation
API > API/Runtime > API/Runtime/ApplicationCore
Contains metrics information for the desktop area
| Name | FDisplayMetrics |
| Type | struct |
| Header File | /Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericApplication.h |
| Include Path | #include "GenericPlatform/GenericApplication.h" |
Syntax
struct FDisplayMetrics
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDisplayMetrics() |
GenericPlatform/GenericApplication.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActionSafePaddingSize | FVector4 | The safe area for less important spill over on TVs (see TitleSafePaddingSize) | GenericPlatform/GenericApplication.h | |
| MonitorInfo | TArray< FMonitorInfo > | Info on connected physical monitors. | GenericPlatform/GenericApplication.h | |
| PrimaryDisplayHeight | int32 | Height of the primary display in pixels | GenericPlatform/GenericApplication.h | |
| PrimaryDisplayWidth | int32 | Width of the primary display in pixels | GenericPlatform/GenericApplication.h | |
| PrimaryDisplayWorkAreaRect | FPlatformRect | Area of the primary display not covered by task bars or other docked widgets | GenericPlatform/GenericApplication.h | |
| TitleSafePaddingSize | FVector4 | The safe area for all content on TVs (see http://en.wikipedia.org/wiki/Safe_area_%28television%29) - content will be inset Left - X Top - Y Right - Z Bottom - W | GenericPlatform/GenericApplication.h | |
| VirtualDisplayRect | FPlatformRect | Virtual display coordinate range (includes all active displays) | GenericPlatform/GenericApplication.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPlatformRect GetMonitorWorkAreaFromPoint
(
const FVector2D& Point |
Gets the monitor work area from a position in the global display rect | GenericPlatform/GenericApplication.h | |
void PrintToLog() |
Logs out display metrics | GenericPlatform/GenericApplication.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ApplyDefaultSafeZones() |
Apply the debug/default safe zones. | GenericPlatform/GenericApplication.h | |
bool TryGetTitleSafeZoneOverwrite
(
FVector4& InOutTitleSafePaddingSize |
Fills the InOutTitleSafePaddingSize with CVar overwrites (Sets padding to 0 for values that are not set). | GenericPlatform/GenericApplication.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static float GetDebugActionSafeZoneRatio() |
The action safe zone ratio that will be returned by FDisplayMetrics::GetDisplayMetrics on platforms that don't have a defined safe zone. | GenericPlatform/GenericApplication.h | |
static float GetDebugTitleSafeZoneRatio() |
The title safe zone ratio that will be returned by FDisplayMetrics::GetDisplayMetrics on platforms that don't have a defined safe zone. | GenericPlatform/GenericApplication.h | |
static void GetDisplayMetrics
(
FDisplayMetrics& OutDisplayMetrics |
GenericPlatform/GenericApplication.h | ||
static void RebuildDisplayMetrics
(
FDisplayMetrics& OutDisplayMetrics |
GenericPlatform/GenericApplication.h |