Mir
Classes | Public Types | Public Member Functions | List of all members
miral::Output Class Reference

#include <output.h>

Classes

struct  PhysicalSizeMM
 

Public Types

enum class  Type {
  unknown , vga , dvii , dvid ,
  dvia , composite , svideo , lvds ,
  component , ninepindin , displayport , hdmia ,
  hdmib , tv , edp
}
 

Public Member Functions

 Output (const mir::graphics::DisplayConfigurationOutput &output)
 
 Output (Output const &)
 
Outputoperator= (Output const &)
 
 ~Output ()
 
auto type () const -> Type
 The type of the output. More...
 
auto physical_size_mm () const -> PhysicalSizeMM
 The physical size of the output. More...
 
auto connected () const -> bool
 Whether the output is connected. More...
 
auto used () const -> bool
 Whether the output is used in the configuration. More...
 
auto pixel_format () const -> MirPixelFormat
 The current output pixel format. More...
 
auto refresh_rate () const -> double
 refresh_rate in Hz More...
 
auto power_mode () const -> MirPowerMode
 Current power mode. More...
 
auto orientation () const -> MirOrientation
 
auto scale () const -> float
 Requested scale factor for this output, for HiDPI support. More...
 
auto form_factor () const -> MirFormFactor
 Form factor of this output; phone display, tablet, monitor, TV, projector... More...
 
auto extents () const -> Rectangle
 The logical rectangle occupied by the output, based on its position, current mode and orientation (rotation) More...
 
auto id () const -> int
 Mir's internal output ID mostly useful for matching against a miral::WindowInfo::output_id. More...
 
auto valid () const -> bool
 
auto is_same_output (Output const &other) const -> bool
 
auto logical_group_id () const -> int
 A positive number if this output is part of a logical output group (aka a display wall) A single display area will stretch across all outputs in a group Zero if this output is not part of a logical group. More...
 

Member Enumeration Documentation

◆ Type

enum miral::Output::Type
strong
Enumerator
unknown 
vga 
dvii 
dvid 
dvia 
composite 
svideo 
lvds 
component 
ninepindin 
displayport 
hdmia 
hdmib 
tv 
edp 

Constructor & Destructor Documentation

◆ Output() [1/2]

miral::Output::Output ( const mir::graphics::DisplayConfigurationOutput &  output)
explicit

◆ Output() [2/2]

miral::Output::Output ( Output const &  )

◆ ~Output()

miral::Output::~Output ( )

Member Function Documentation

◆ connected()

auto miral::Output::connected ( ) const -> bool

Whether the output is connected.

◆ extents()

auto miral::Output::extents ( ) const -> Rectangle

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

◆ form_factor()

auto miral::Output::form_factor ( ) const -> MirFormFactor

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

◆ id()

auto miral::Output::id ( ) const -> int

Mir's internal output ID mostly useful for matching against a miral::WindowInfo::output_id.

◆ is_same_output()

auto miral::Output::is_same_output ( Output const &  other) const -> bool

◆ logical_group_id()

auto miral::Output::logical_group_id ( ) const -> int

A positive number if this output is part of a logical output group (aka a display wall) A single display area will stretch across all outputs in a group Zero if this output is not part of a logical group.

◆ operator=()

Output& miral::Output::operator= ( Output const &  )

◆ orientation()

auto miral::Output::orientation ( ) const -> MirOrientation

◆ physical_size_mm()

auto miral::Output::physical_size_mm ( ) const -> PhysicalSizeMM

The physical size of the output.

◆ pixel_format()

auto miral::Output::pixel_format ( ) const -> MirPixelFormat

The current output pixel format.

◆ power_mode()

auto miral::Output::power_mode ( ) const -> MirPowerMode

Current power mode.

◆ refresh_rate()

auto miral::Output::refresh_rate ( ) const -> double

refresh_rate in Hz

◆ scale()

auto miral::Output::scale ( ) const -> float

Requested scale factor for this output, for HiDPI support.

◆ type()

auto miral::Output::type ( ) const -> Type

The type of the output.

◆ used()

auto miral::Output::used ( ) const -> bool

Whether the output is used in the configuration.

◆ valid()

auto miral::Output::valid ( ) const -> bool

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

Copyright © 2012-2022 Canonical Ltd.
Generated on śro, 1 cze 2022, 16:52:55 UTC
This documentation is licensed under the GPL version 2 or 3.