Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
PhosphorScreens::ScreenInfo Struct Reference

Lightweight descriptor for a connected screen, suitable for passing across settings UIs and QML. More...

#include <PhosphorScreens/ScreenInfo.h>

Public Attributes

QString name
bool isPrimary = false
QString manufacturer
QString model
int width = 0
int height = 0
int x = 0
 Screen-space position of the top-left corner, in the compositor's global coordinate space (the same space width/height are measured in).
int y = 0
QString screenId
bool isVirtualScreen = false
QString connectorName
 Physical connector (e.g.
int virtualIndex = -1
 0-based index within the physical screen (-1 = not virtual).
QString virtualDisplayName
 User-facing name for virtual screens (e.g.
QSize pixelSize
 The screen's size in device pixels (a virtual screen's own region share), as the producer's getScreenInfo reply carries it under pixelSize.
bool pixelSizeKnown = false
 True when pixelSize is a size the producer's own rules read: the compositor's accepted report of the output's mode or the size last accepted for that monitor (pixelSizeSource "reported" or "seeded" in the getScreenInfo reply).

Detailed Description

Lightweight descriptor for a connected screen, suitable for passing across settings UIs and QML.

Pure POD — no Qt meta-object plumbing. Apps that produce this data (typically by querying their compositor over D-Bus or via QGuiApplication) can pass lists across language boundaries through screenInfoListToVariantList().

Member Data Documentation

◆ connectorName

QString PhosphorScreens::ScreenInfo::connectorName

Physical connector (e.g.

"DP-2").

◆ height

int PhosphorScreens::ScreenInfo::height = 0

◆ isPrimary

bool PhosphorScreens::ScreenInfo::isPrimary = false

◆ isVirtualScreen

bool PhosphorScreens::ScreenInfo::isVirtualScreen = false

◆ manufacturer

QString PhosphorScreens::ScreenInfo::manufacturer

◆ model

QString PhosphorScreens::ScreenInfo::model

◆ name

QString PhosphorScreens::ScreenInfo::name

◆ pixelSize

QSize PhosphorScreens::ScreenInfo::pixelSize

The screen's size in device pixels (a virtual screen's own region share), as the producer's getScreenInfo reply carries it under pixelSize.

width/height above are logical and this is not. An invalid QSize when the producer reported none. Not emitted by screenInfoListToVariantList().

◆ pixelSizeKnown

bool PhosphorScreens::ScreenInfo::pixelSizeKnown = false

True when pixelSize is a size the producer's own rules read: the compositor's accepted report of the output's mode or the size last accepted for that monitor (pixelSizeSource "reported" or "seeded" in the getScreenInfo reply).

False when it is the producer's estimate from the logical size and scale ("estimated"), which no rule sees, or absent.

◆ screenId

QString PhosphorScreens::ScreenInfo::screenId

◆ virtualDisplayName

QString PhosphorScreens::ScreenInfo::virtualDisplayName

User-facing name for virtual screens (e.g.

"Left").

◆ virtualIndex

int PhosphorScreens::ScreenInfo::virtualIndex = -1

0-based index within the physical screen (-1 = not virtual).

◆ width

int PhosphorScreens::ScreenInfo::width = 0

◆ x

int PhosphorScreens::ScreenInfo::x = 0

Screen-space position of the top-left corner, in the compositor's global coordinate space (the same space width/height are measured in).

Lets a multi-monitor map lay tiles out in their real arrangement. Unlike width/height, 0 is a legitimate value (the primary output typically sits at the origin), so screenInfoListToVariantList() emits x/y unconditionally rather than skipping non-positive values.

◆ y

int PhosphorScreens::ScreenInfo::y = 0

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