FDisplayMetrics Struct Reference

#include <GenericApplication.h>

Inheritance diagram for FDisplayMetrics:

Public Member Functions
	FDisplayMetrics ()
APPLICATIONCORE_API FPlatformRect	GetMonitorWorkAreaFromPoint (const FVector2D &Point) const
APPLICATIONCORE_API void	PrintToLog () const

Static Public Member Functions
static void	GetDisplayMetrics (struct FDisplayMetrics &OutDisplayMetrics)
static APPLICATIONCORE_API void	RebuildDisplayMetrics (struct FDisplayMetrics &OutDisplayMetrics)
static APPLICATIONCORE_API float	GetDebugTitleSafeZoneRatio ()

Public Attributes
int32	PrimaryDisplayWidth
int32	PrimaryDisplayHeight
TArray< FMonitorInfo >	MonitorInfo
FPlatformRect	PrimaryDisplayWorkAreaRect
FPlatformRect	VirtualDisplayRect
FVector4	TitleSafePaddingSize
FVector4	ActionSafePaddingSize

Protected Member Functions
bool	TryGetTitleSafeZoneOverwrite (FVector4 &InOutTitleSafePaddingSize)
void	ApplyDefaultSafeZones ()

Static Protected Member Functions
static float	GetDebugActionSafeZoneRatio ()

Detailed Description

Contains metrics information for the desktop area

Constructor & Destructor Documentation

FDisplayMetrics()

FDisplayMetrics::FDisplayMetrics ( )

inline

Member Function Documentation

ApplyDefaultSafeZones()

void FDisplayMetrics::ApplyDefaultSafeZones ( )

protected

GetDebugActionSafeZoneRatio()

float FDisplayMetrics::GetDebugActionSafeZoneRatio ( )

staticprotected

GetDebugTitleSafeZoneRatio()

float FDisplayMetrics::GetDebugTitleSafeZoneRatio ( )

static

GetDisplayMetrics()

static void FDisplayMetrics::GetDisplayMetrics ( struct FDisplayMetrics &  OutDisplayMetrics )

inlinestatic

GetMonitorWorkAreaFromPoint()

FPlatformRect FDisplayMetrics::GetMonitorWorkAreaFromPoint

(

const FVector2D &

Point

)

const

Gets the monitor work area from a position in the global display rect

PrintToLog()

void FDisplayMetrics::PrintToLog

(

)

const

Logs out display metrics

RebuildDisplayMetrics()

void FDisplayMetrics::RebuildDisplayMetrics ( struct FDisplayMetrics &  OutDisplayMetrics )

static

TryGetTitleSafeZoneOverwrite()

bool FDisplayMetrics::TryGetTitleSafeZoneOverwrite ( FVector4 &  InOutTitleSafePaddingSize )

protected

Member Data Documentation

ActionSafePaddingSize

FVector4 FDisplayMetrics::ActionSafePaddingSize

The safe area for less important spill over on TVs (see TitleSafePaddingSize)

MonitorInfo

TArray<FMonitorInfo> FDisplayMetrics::MonitorInfo

Info on connected physical monitors. Only available on platforms where this information is accessible (PC currently)

PrimaryDisplayHeight

int32 FDisplayMetrics::PrimaryDisplayHeight

Height of the primary display in pixels

PrimaryDisplayWidth

int32 FDisplayMetrics::PrimaryDisplayWidth

Width of the primary display in pixels

PrimaryDisplayWorkAreaRect

FPlatformRect FDisplayMetrics::PrimaryDisplayWorkAreaRect

Area of the primary display not covered by task bars or other docked widgets

TitleSafePaddingSize

FVector4 FDisplayMetrics::TitleSafePaddingSize

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

VirtualDisplayRect

FPlatformRect FDisplayMetrics::VirtualDisplayRect

Virtual display coordinate range (includes all active displays)

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericApplication.h
• Engine/Source/Runtime/ApplicationCore/Private/Android/AndroidApplication.cpp
• Engine/Source/Runtime/ApplicationCore/Private/GenericPlatform/GenericApplication.cpp
• Engine/Source/Runtime/ApplicationCore/Private/IOS/IOSApplication.cpp
• Engine/Source/Runtime/ApplicationCore/Private/Linux/LinuxApplication.cpp
• Engine/Source/Runtime/ApplicationCore/Private/Mac/MacApplication.cpp
• Engine/Source/Runtime/ApplicationCore/Private/Windows/WindowsApplication.cpp