DisplayInfo#

Fully qualified name: omni::platforminfo::DisplayInfo

Defined in omni/platforminfo/IDisplayInfo.h

struct DisplayInfo#

Contains information about a single display device.

This includes the name of the display, the adapter it is connected to, the virtual coordinates on the desktop where the display’s image maps to, and the current display mode information.

Public Members

char displayName[128] = {}#

The name of the display device.

This typically maps to a monitor, laptop screen, or other pixel display device. This name should be suitable for display to a user.

char displayId[128] = {}#

The system specific identifier of the display device.

This is suitable for using with other platform specific APIs that accept a display device name.

char adapterName[128] = {}#

The name of the graphics adapter the display is connected to.

Typically this is the name of the GPU or other graphics device that the display is connected to. This name should be suitable for display to a user.

char adapterId[128] = {}#

The system specific identifier of the graphics adapter device.

This is suitable for using with other platform specific APIs that accept a graphics adapter name.

carb::Int2 origin = {}#

The coordinates of the origin of this display device on the desktop’s virtual screen.

In situations where there is only a single display, this will always be (0, 0). It will be in non-mirrored multi-display setups that this can be used to determine how each display’s viewport is positioned relative to each other.

ModeInfo current = {}#

The current display mode in use on the display.

DisplayFlags flags = 0#

Flags to indicate additional information about this display.