Mir
Namespaces | Classes | Typedefs | Enumerations | Functions
mir::graphics Namespace Reference

Graphics subsystem. Mediates interaction between core system and the graphics environment. More...

Namespaces

 detail
 

Classes

class  AtomicFrame
 
class  Buffer
 
class  BufferBasic
 
struct  BufferProperties
 Buffer creation properties. More...
 
class  CloneDisplayConfigurationPolicy
 All screens placed at (0, 0) More...
 
class  Cursor
 
class  CursorImage
 
class  Display
 Interface to the display subsystem. More...
 
class  DisplayBuffer
 Interface to an output framebuffer. More...
 
class  DisplayConfiguration
 Interface to a configuration of display cards and outputs. More...
 
struct  DisplayConfigurationCard
 Configuration information for a display card. More...
 
struct  DisplayConfigurationMode
 Configuration information for a display output mode. More...
 
struct  DisplayConfigurationOutput
 Configuration information for a display output. More...
 
class  DisplayConfigurationPolicy
 
class  DisplayConfigurationReport
 
class  DisplaySyncGroup
 DisplaySyncGroup represents a group of displays that need to be output in unison as a single post() call. More...
 
class  EventHandlerRegister
 
struct  Frame
 Frame is a unique identifier for a frame displayed on an output. More...
 
class  GammaCurves
 
class  GLConfig
 Interface for customizing aspects of the GL config used by the server. More...
 
class  GraphicBufferAllocator
 Interface to graphic buffer allocation. More...
 
class  NativeBuffer
 
class  NativeBufferBase
 
class  NativeDisplay
 
class  NativeDisplayBuffer
 
class  Platform
 Interface to platform specific support for graphics operations. More...
 
class  PlatformIpcOperations
 
struct  PlatformIPCPackage
 Platform data to be sent to the clients over IPC. More...
 
struct  PlatformOperationMessage
 
class  Renderable
 
class  SideBySideDisplayConfigurationPolicy
 Each screen placed to the right of the previous one. More...
 
class  SingleDisplayConfigurationPolicy
 Just use the first screen. More...
 
struct  UserDisplayConfigurationOutput
 Mirror of a DisplayConfigurationOutput, with some fields limited to being read-only, preventing users from changing things they shouldn't. More...
 
class  VirtualOutput
 Interface to a virtual output. More...
 

Typedefs

typedef IntWrapper< BufferIdTag, uint32_t > BufferID
 
typedef std::function< bool()> DisplayPauseHandler
 
typedef std::function< bool()> DisplayResumeHandler
 
typedef std::function< void()> DisplayConfigurationChangeHandler
 
typedef IntWrapper< detail::GraphicsConfCardIdTag > DisplayConfigurationCardId
 
typedef IntWrapper< detail::GraphicsConfOutputIdTag > DisplayConfigurationOutputId
 
typedef std::vector< uint16_t > GammaCurve
 
typedef mir::UniqueModulePtr< mir::graphics::Platform >(* CreateHostPlatform) (std::shared_ptr< mir::options::Option > const &options, std::shared_ptr< mir::EmergencyCleanupRegistry > const &emergency_cleanup_registry, std::shared_ptr< mir::graphics::DisplayReport > const &report, std::shared_ptr< mir::logging::Logger > const &logger)
 
typedef mir::UniqueModulePtr< mir::graphics::Platform >(* CreateGuestPlatform) (std::shared_ptr< mir::graphics::DisplayReport > const &report, std::shared_ptr< mir::graphics::NestedContext > const &nested_context)
 
typedef void(* AddPlatformOptions) (boost::program_options::options_description &config)
 
typedef mir::graphics::PlatformPriority(* PlatformProbe) (mir::options::ProgramOption const &options)
 
typedef mir::ModuleProperties const *(* DescribeModule) ()
 
typedef std::vector< std::shared_ptr< Renderable > > RenderableList
 

Enumerations

enum  BufferUsage { BufferUsage::undefined, BufferUsage::hardware, BufferUsage::software }
 How a buffer is going to be used. More...
 
enum  DisplayConfigurationOutputType {
  DisplayConfigurationOutputType::unknown = mir_output_type_unknown, DisplayConfigurationOutputType::vga = mir_output_type_vga, DisplayConfigurationOutputType::dvii = mir_output_type_dvii, DisplayConfigurationOutputType::dvid = mir_output_type_dvid,
  DisplayConfigurationOutputType::dvia = mir_output_type_dvia, DisplayConfigurationOutputType::composite = mir_output_type_composite, DisplayConfigurationOutputType::svideo = mir_output_type_svideo, DisplayConfigurationOutputType::lvds = mir_output_type_lvds,
  DisplayConfigurationOutputType::component = mir_output_type_component, DisplayConfigurationOutputType::ninepindin = mir_output_type_ninepindin, DisplayConfigurationOutputType::displayport = mir_output_type_displayport, DisplayConfigurationOutputType::hdmia = mir_output_type_hdmia,
  DisplayConfigurationOutputType::hdmib = mir_output_type_hdmib, DisplayConfigurationOutputType::tv = mir_output_type_tv, DisplayConfigurationOutputType::edp = mir_output_type_edp, DisplayConfigurationOutputType::virt = mir_output_type_virtual,
  DisplayConfigurationOutputType::dsi = mir_output_type_dsi, DisplayConfigurationOutputType::dpi = mir_output_type_dpi
}
 The type of a display output. More...
 
enum  PlatformPriority : uint32_t { unsupported = 0, dummy = 1, supported = 128, best = 256 }
 A measure of how well a platform supports a device. More...
 
enum  BufferIpcMsgType { BufferIpcMsgType::full_msg, BufferIpcMsgType::update_msg }
 

Functions

bool operator== (BufferProperties const &lhs, BufferProperties const &rhs)
 
bool operator!= (BufferProperties const &lhs, BufferProperties const &rhs)
 
std::ostream & operator<< (std::ostream &out, DisplayConfigurationCard const &val)
 
bool operator== (DisplayConfigurationCard const &val1, DisplayConfigurationCard const &val2)
 
bool operator!= (DisplayConfigurationCard const &val1, DisplayConfigurationCard const &val2)
 
std::ostream & operator<< (std::ostream &out, DisplayConfigurationMode const &val)
 
bool operator== (DisplayConfigurationMode const &val1, DisplayConfigurationMode const &val2)
 
bool operator!= (DisplayConfigurationMode const &val1, DisplayConfigurationMode const &val2)
 
std::ostream & operator<< (std::ostream &out, DisplayConfigurationOutput const &val)
 
bool operator== (DisplayConfigurationOutput const &val1, DisplayConfigurationOutput const &val2)
 
bool operator!= (DisplayConfigurationOutput const &val1, DisplayConfigurationOutput const &val2)
 
bool operator== (DisplayConfiguration const &lhs, DisplayConfiguration const &rhs)
 
bool operator!= (DisplayConfiguration const &lhs, DisplayConfiguration const &rhs)
 
std::ostream & operator<< (std::ostream &out, DisplayConfiguration const &val)
 

Detailed Description

Graphics subsystem. Mediates interaction between core system and the graphics environment.

Typedef Documentation

§ AddPlatformOptions

typedef void(* mir::graphics::AddPlatformOptions) (boost::program_options::options_description &config)

§ BufferID

typedef IntWrapper<BufferIdTag, uint32_t> mir::graphics::BufferID

§ CreateGuestPlatform

typedef mir::UniqueModulePtr<mir::graphics::Platform>(* mir::graphics::CreateGuestPlatform) (std::shared_ptr< mir::graphics::DisplayReport > const &report, std::shared_ptr< mir::graphics::NestedContext > const &nested_context)

§ CreateHostPlatform

typedef mir::UniqueModulePtr<mir::graphics::Platform>(* mir::graphics::CreateHostPlatform) (std::shared_ptr< mir::options::Option > const &options, std::shared_ptr< mir::EmergencyCleanupRegistry > const &emergency_cleanup_registry, std::shared_ptr< mir::graphics::DisplayReport > const &report, std::shared_ptr< mir::logging::Logger > const &logger)

§ DescribeModule

typedef mir::ModuleProperties const*(* mir::graphics::DescribeModule) ()

§ DisplayConfigurationCardId

typedef IntWrapper<detail::GraphicsConfCardIdTag> mir::graphics::DisplayConfigurationCardId

§ DisplayConfigurationChangeHandler

typedef std::function<void()> mir::graphics::DisplayConfigurationChangeHandler

§ DisplayConfigurationOutputId

typedef IntWrapper<detail::GraphicsConfOutputIdTag> mir::graphics::DisplayConfigurationOutputId

§ DisplayPauseHandler

typedef std::function<bool()> mir::graphics::DisplayPauseHandler

§ DisplayResumeHandler

typedef std::function<bool()> mir::graphics::DisplayResumeHandler

§ GammaCurve

typedef std::vector<uint16_t> mir::graphics::GammaCurve

§ PlatformProbe

typedef mir::graphics::PlatformPriority(* mir::graphics::PlatformProbe) (mir::options::ProgramOption const &options)

§ RenderableList

typedef std::vector<std::shared_ptr<Renderable> > mir::graphics::RenderableList

Enumeration Type Documentation

§ BufferIpcMsgType

Enumerator
full_msg 
update_msg 

§ BufferUsage

How a buffer is going to be used.

The usage is not just a hint; for example, depending on the platform, a 'hardware' buffer may not support direct pixel access.

Enumerator
undefined 
hardware 

rendering using GL

software 

rendering using direct pixel access

§ DisplayConfigurationOutputType

The type of a display output.

Enumerator
unknown 
vga 
dvii 
dvid 
dvia 
composite 
svideo 
lvds 
component 
ninepindin 
displayport 
hdmia 
hdmib 
tv 
edp 
virt 
dsi 
dpi 

§ PlatformPriority

A measure of how well a platform supports a device.

Note
This is compared as an integer; best + 1 is a valid PlatformPriority that will be used in preference to a module that reports best. Platform modules distributed with Mir will never use a priority higher than best.
Enumerator
unsupported 

Unable to function at all on this device.

dummy 

Used only for dummy or stub platforms.

supported 

Capable of providing a functioning Platform on this device, possibly with degraded performance or features.

best 

Capable of providing a Platform with the best features and performance this device is capable of.

Function Documentation

§ operator!=() [1/5]

bool mir::graphics::operator!= ( BufferProperties const &  lhs,
BufferProperties const &  rhs 
)
inline

§ operator!=() [2/5]

bool mir::graphics::operator!= ( DisplayConfigurationCard const &  val1,
DisplayConfigurationCard const &  val2 
)

§ operator!=() [3/5]

bool mir::graphics::operator!= ( DisplayConfigurationMode const &  val1,
DisplayConfigurationMode const &  val2 
)

§ operator!=() [4/5]

bool mir::graphics::operator!= ( DisplayConfigurationOutput const &  val1,
DisplayConfigurationOutput const &  val2 
)

§ operator!=() [5/5]

bool mir::graphics::operator!= ( DisplayConfiguration const &  lhs,
DisplayConfiguration const &  rhs 
)

§ operator<<() [1/4]

std::ostream& mir::graphics::operator<< ( std::ostream &  out,
DisplayConfigurationCard const &  val 
)

§ operator<<() [2/4]

std::ostream& mir::graphics::operator<< ( std::ostream &  out,
DisplayConfigurationMode const &  val 
)

§ operator<<() [3/4]

std::ostream& mir::graphics::operator<< ( std::ostream &  out,
DisplayConfigurationOutput const &  val 
)

§ operator<<() [4/4]

std::ostream& mir::graphics::operator<< ( std::ostream &  out,
DisplayConfiguration const &  val 
)

§ operator==() [1/5]

bool mir::graphics::operator== ( BufferProperties const &  lhs,
BufferProperties const &  rhs 
)
inline

§ operator==() [2/5]

bool mir::graphics::operator== ( DisplayConfigurationCard const &  val1,
DisplayConfigurationCard const &  val2 
)

§ operator==() [3/5]

bool mir::graphics::operator== ( DisplayConfigurationMode const &  val1,
DisplayConfigurationMode const &  val2 
)

§ operator==() [4/5]

bool mir::graphics::operator== ( DisplayConfigurationOutput const &  val1,
DisplayConfigurationOutput const &  val2 
)

§ operator==() [5/5]

bool mir::graphics::operator== ( DisplayConfiguration const &  lhs,
DisplayConfiguration const &  rhs 
)

Copyright © 2012-2016 Canonical Ltd.
Generated on Sat Dec 3 12:48:59 UTC 2016