mir::graphics::DisplayConfigurationOutput Struct Reference

Configuration information for a display output. More...

#include <display_configuration.h>

Public Member Functions
geometry::Rectangle	extents () const
	The logical rectangle occupied by the output, based on its position, current mode and orientation (rotation) More...
bool	valid () const

Public Attributes
DisplayConfigurationOutputId	id
	The output's id. More...
DisplayConfigurationCardId	card_id
	The id of the card the output is connected to. More...
DisplayConfigurationOutputType	type
	The type of the output. More...
std::vector< MirPixelFormat >	pixel_formats
	The pixel formats supported by the output. More...
std::vector< DisplayConfigurationMode >	modes
	The modes supported by the output. More...
uint32_t	preferred_mode_index
	The index in the 'modes' vector of the preferred output mode. More...
geometry::Size	physical_size_mm
	The physical size of the output. More...
bool	connected
	Whether the output is connected. More...
bool	used
	Whether the output is used in the configuration. More...
geometry::Point	top_left
	The top left point of this output in the virtual coordinate space. More...
uint32_t	current_mode_index
	The index in the 'modes' vector of the current output mode. More...
MirPixelFormat	current_format
	The current output pixel format. More...
MirPowerMode	power_mode
	Current power mode. More...
MirOrientation	orientation
float	scale
	Requested scale factor for this output, for HiDPI support. More...
MirFormFactor	form_factor
	Form factor of this output; phone display, tablet, monitor, TV, projector... More...

Detailed Description

Configuration information for a display output.

Member Function Documentation

mir::geometry::Rectangle mir::graphics::DisplayConfigurationOutput::extents

(

)

const

The logical rectangle occupied by the output, based on its position, current mode and orientation (rotation)

bool mir::graphics::DisplayConfigurationOutput::valid

(

)

const

Member Data Documentation

DisplayConfigurationCardId mir::graphics::DisplayConfigurationOutput::card_id

The id of the card the output is connected to.

bool mir::graphics::DisplayConfigurationOutput::connected

Whether the output is connected.

MirPixelFormat mir::graphics::DisplayConfigurationOutput::current_format

The current output pixel format.

A matching entry should be found in the 'pixel_formats' vector

uint32_t mir::graphics::DisplayConfigurationOutput::current_mode_index

The index in the 'modes' vector of the current output mode.

MirFormFactor mir::graphics::DisplayConfigurationOutput::form_factor

Form factor of this output; phone display, tablet, monitor, TV, projector...

DisplayConfigurationOutputId mir::graphics::DisplayConfigurationOutput::id

The output's id.

std::vector<DisplayConfigurationMode> mir::graphics::DisplayConfigurationOutput::modes

The modes supported by the output.

MirOrientation mir::graphics::DisplayConfigurationOutput::orientation

geometry::Size mir::graphics::DisplayConfigurationOutput::physical_size_mm

The physical size of the output.

std::vector<MirPixelFormat> mir::graphics::DisplayConfigurationOutput::pixel_formats

The pixel formats supported by the output.

MirPowerMode mir::graphics::DisplayConfigurationOutput::power_mode

Current power mode.

uint32_t mir::graphics::DisplayConfigurationOutput::preferred_mode_index

The index in the 'modes' vector of the preferred output mode.

float mir::graphics::DisplayConfigurationOutput::scale

Requested scale factor for this output, for HiDPI support.

geometry::Point mir::graphics::DisplayConfigurationOutput::top_left

The top left point of this output in the virtual coordinate space.

DisplayConfigurationOutputType mir::graphics::DisplayConfigurationOutput::type

The type of the output.

bool mir::graphics::DisplayConfigurationOutput::used

Whether the output is used in the configuration.

---

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

• include/platform/mir/graphics/display_configuration.h
• src/platform/graphics/display_configuration.cpp