Public Attributes | List of all members
Displays::Display Struct Reference

Represents a connected display device. More...

Public Attributes

bool isMain
 This will be true if this is the user's main display device. More...
 
Rectangle< inttotalArea
 The total area of this display in logical pixels including any OS-dependent objects like the taskbar, menu bar, etc. More...
 
Rectangle< intuserArea
 The total area of this display in logical pixels which isn't covered by OS-dependent objects like the taskbar, menu bar, etc. More...
 
BorderSize< intsafeAreaInsets
 Represents the area of this display in logical pixels that is not functional for displaying content. More...
 
Point< inttopLeftPhysical
 The top-left of this display in physical coordinates. More...
 
double scale
 The scale factor of this display. More...
 
double dpi
 The DPI of the display. More...
 

Detailed Description

Represents a connected display device.

Member Data Documentation

◆ isMain

bool Displays::Display::isMain

This will be true if this is the user's main display device.

◆ totalArea

Rectangle<int> Displays::Display::totalArea

The total area of this display in logical pixels including any OS-dependent objects like the taskbar, menu bar, etc.

◆ userArea

Rectangle<int> Displays::Display::userArea

The total area of this display in logical pixels which isn't covered by OS-dependent objects like the taskbar, menu bar, etc.

◆ safeAreaInsets

BorderSize<int> Displays::Display::safeAreaInsets

Represents the area of this display in logical pixels that is not functional for displaying content.

On mobile devices this may be the area covered by display cutouts and notches, where you still want to draw a background but should not position important content.

◆ topLeftPhysical

Point<int> Displays::Display::topLeftPhysical

The top-left of this display in physical coordinates.

◆ scale

double Displays::Display::scale

The scale factor of this display.

For higher-resolution displays, or displays with a user-defined scale factor set, this may be a value other than 1.0.

This value is used to convert between physical and logical pixels. For example, a Component with size 10x10 will use 20x20 physical pixels on a display with a scale factor of 2.0.

◆ dpi

double Displays::Display::dpi

The DPI of the display.

This is the number of physical pixels per inch. To get the number of logical pixels per inch, divide this by the Display::scale value.


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