Mir
Classes | Typedefs
Mir platform enablement

Classes and functions that need to be implemented to add support for a graphics platform. More...

Classes

class  mir::client::ClientPlatform
 Interface to client-side platform specific support for graphics operations. More...
 
class  mir::graphics::Platform
 Interface to platform specific support for graphics operations. More...
 

Typedefs

typedef std::shared_ptr< Platform >(* mir::graphics::CreateHostPlatform) (std::shared_ptr< options::Option > const &options, std::shared_ptr< EmergencyCleanupRegistry > const &emergency_cleanup_registry, std::shared_ptr< DisplayReport > const &report)
 Function prototype used to return a new host graphics platform. More...
 
typedef std::shared_ptr< Platform >(* mir::graphics::CreateGuestPlatform) (std::shared_ptr< DisplayReport > const &report, std::shared_ptr< NestedContext > const &nested_context)
 Function prototype used to return a new guest graphics platform. More...
 
typedef void(* mir::graphics::AddPlatformOptions) (boost::program_options::options_description &config)
 Function prototype used to add platform specific options to the platform-independant server options. More...
 

Detailed Description

Classes and functions that need to be implemented to add support for a graphics platform.

Typedef Documentation

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

Function prototype used to add platform specific options to the platform-independant server options.

Parameters
[in]configa boost::program_options that can be appended with new options

This factory function needs to be implemented by each platform.

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

Function prototype used to return a new guest graphics platform.

The guest graphics platform exists alongside the host platform and do not output or control the physical displays

Parameters
[in]nested_contextthe object that contains resources needed from the host platform
[in]reportthe object to use to report interesting events from the display subsystem

This factory function needs to be implemented by each platform.

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

Function prototype used to return a new host graphics platform.

The host graphics platform is the system entity that owns the physical display and is a mir host server.

Parameters
[in]optionsoptions to use for this platform
[in]emergency_cleanup_registryobject to register emergency shutdown handlers with
[in]reportthe object to use to report interesting events from the display subsystem

This factory function needs to be implemented by each platform.


Copyright © 2012,2013 Canonical Ltd.
Generated on Tue Mar 24 16:15:19 UTC 2015