Mir
Classes | Functions
Mir platform enablement

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

Classes

class  mir::graphics::Platform
 Interface to platform specific support for graphics operations. More...
 

Functions

mir::UniqueModulePtr< mir::graphics::Platformcreate_host_platform (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)
 Function prototype used to return a new host graphics platform. More...
 
mir::UniqueModulePtr< mir::graphics::Platformcreate_guest_platform (std::shared_ptr< mir::graphics::DisplayReport > const &report, std::shared_ptr< mir::graphics::NestedContext > const &nested_context)
 Function prototype used to return a new guest graphics platform. More...
 
void add_graphics_platform_options (boost::program_options::options_description &config)
 Function prototype used to add platform specific options to the platform-independent server options. More...
 
mir::UniqueModulePtr< mir::input::Platformcreate_input_platform (mir::options::Option const &options, std::shared_ptr< mir::EmergencyCleanupRegistry > const &emergency_cleanup_registry, std::shared_ptr< mir::input::InputDeviceRegistry > const &input_device_registry, std::shared_ptr< mir::input::InputReport > const &report)
 Function used to initialize an input platform. More...
 
void add_input_platform_options (boost::program_options::options_description &config)
 Function used to add additional configuration options. More...
 
mir::input::PlatformPriority probe_input_platform (mir::options::Option const &options)
 probe_platform should indicate whether the platform is able to work within the current environment. More...
 
mir::ModuleProperties const * describe_input_module ()
 describe_input_module should return a description of the input platform. More...
 

Detailed Description

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

Function Documentation

void add_graphics_platform_options ( boost::program_options::options_description &  config)

Function prototype used to add platform specific options to the platform-independent 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.

void add_input_platform_options ( boost::program_options::options_description &  config)

Function used to add additional configuration options.

Parameters
[in]configprogram option description that the platform may extend

This function needs to be implemented by each platform.

mir::UniqueModulePtr<mir::graphics::Platform> create_guest_platform ( std::shared_ptr< mir::graphics::DisplayReport > const &  report,
std::shared_ptr< mir::graphics::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.

mir::UniqueModulePtr<mir::graphics::Platform> create_host_platform ( 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 
)

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.

mir::UniqueModulePtr<mir::input::Platform> create_input_platform ( mir::options::Option const &  options,
std::shared_ptr< mir::EmergencyCleanupRegistry > const &  emergency_cleanup_registry,
std::shared_ptr< mir::input::InputDeviceRegistry > const &  input_device_registry,
std::shared_ptr< mir::input::InputReport > const &  report 
)

Function used to initialize an input platform.

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

This factory function needs to be implemented by each platform.

mir::ModuleProperties const* describe_input_module ( )

describe_input_module should return a description of the input platform.

This function needs to be implemented by each platform.

mir::input::PlatformPriority probe_input_platform ( mir::options::Option const &  options)

probe_platform should indicate whether the platform is able to work within the current environment.

Parameters
[in]optionsprogram options of the mir server

This function needs to be implemented by each platform.


Copyright © 2012-2016 Canonical Ltd.
Generated on Fri Dec 20 06:52:43 UTC 2019