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 {}
	Device to perform configuration for (can be empty if primary device should be used).
DevicePreparation	m_device_prep {}
	Instruction on how to prepare device.
std::optional< HdrState >	m_hdr_state {}
	HDR state to configure (if supported by the display).
std::optional< FloatingPoint >	m_refresh_rate {}
	Refresh rate to configure.
std::optional< Resolution >	m_resolution {}
	Resolution to configure.

Friends
bool	operator== (const SingleDisplayConfiguration &lhs, const SingleDisplayConfiguration &rhs)=default
	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.

---

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

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