Mir
|
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::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. More... | |
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. 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::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. 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... | |
Classes and functions that need to be implemented to add support for a graphics platform.
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.
[in] | config | a 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.
[in] | config | program 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
[in] | nested_context | the object that contains resources needed from the host platform |
[in] | report | the 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.
[in] | options | options to use for this platform |
[in] | emergency_cleanup_registry | object to register emergency shutdown handlers with |
[in] | report | the 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.
[in] | options | options to use for this platform |
[in] | emergency_cleanup_registry | object to register emergency shutdown handlers with |
[in] | input_device_registry | object to register input devices handled by this platform |
[in] | report | the 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.
[in] | options | program options of the mir server |
This function needs to be implemented by each platform.
Copyright © 2012-2016 Canonical Ltd.
Generated on Mon Jun 5 13:49:26 UTC 2017