display_device::SingleDisplayConfiguration Struct Reference

Configuration centered around a single display. More...

#include <src/common/include/display_device/types.h>

Public Types
enum class	DevicePreparation { VerifyOnly , EnsureActive , EnsurePrimary , EnsureOnlyDisplay }
	Enum detailing how to prepare the display device. More...

Public Attributes
std::string	m_device_id {}
DevicePreparation	m_device_prep {}
std::optional< HdrState >	m_hdr_state {}
std::optional< FloatingPoint >	m_refresh_rate {}
std::optional< Resolution >	m_resolution {}

Friends
bool	operator== (const SingleDisplayConfiguration &lhs, const SingleDisplayConfiguration &rhs)
	Comparator for strict equality.

Detailed Description

Configuration centered around a single display.

Allows to easily configure the display without providing a complete configuration for all of the system display devices.

Member Enumeration Documentation

DevicePreparation

enum class display_device::SingleDisplayConfiguration::DevicePreparation

strong

Enum detailing how to prepare the display device.

Enumerator
VerifyOnly	User has to make sure the display device is active, we will only verify.
EnsureActive	Activate the device if needed.
EnsurePrimary	Activate the device if needed and make it a primary display.
EnsureOnlyDisplay	Deactivate other displays and turn on the specified one only.

Member Data Documentation

m_device_id

std::string display_device::SingleDisplayConfiguration::m_device_id {}

Device to perform configuration for (can be empty if primary device should be used).

m_device_prep

DevicePreparation display_device::SingleDisplayConfiguration::m_device_prep {}

Instruction on how to prepare device.

m_hdr_state

std::optional<HdrState> display_device::SingleDisplayConfiguration::m_hdr_state {}

HDR state to configure (if supported by the display).

m_refresh_rate

std::optional<FloatingPoint> display_device::SingleDisplayConfiguration::m_refresh_rate {}

Refresh rate to configure.

m_resolution

std::optional<Resolution> display_device::SingleDisplayConfiguration::m_resolution {}

Resolution to configure.

---

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

• src/common/include/display_device/types.h