Interface to the display subsystem.
More...
#include <display.h>
Interface to the display subsystem.
- Examples:
- render_surfaces.cpp.
§ Display()
mir::graphics::Display::Display |
( |
| ) |
|
|
default |
§ ~Display()
virtual mir::graphics::Display::~Display |
( |
| ) |
|
|
virtualdefault |
§ apply_if_configuration_preserves_display_buffers()
virtual bool mir::graphics::Display::apply_if_configuration_preserves_display_buffers |
( |
DisplayConfiguration const & |
conf | ) |
|
|
pure virtual |
Applying a display configuration only if it will not invalidate existing DisplayBuffers.
The Display must guarantee that the references to the DisplayBuffer acquired via DisplaySyncGroup::for_each_display_buffer() remain valid until the Display is destroyed or Display::configure() is called.
If this function returns true
then the new display configuration has been applied. If this function returns false
then the new display configuration has not been applied.
In either case this function guarantees that existing DisplayBuffer references will remain valid.
- Parameters
-
conf | [in] Configuration to possibly apply. |
- Returns
true
if conf
has been applied as the new output configuration.
§ configuration()
Gets a copy of the current output configuration.
§ configure()
Sets a new output configuration.
§ create_hardware_cursor()
virtual std::shared_ptr<Cursor> mir::graphics::Display::create_hardware_cursor |
( |
std::shared_ptr< CursorImage > const & |
initial_image | ) |
|
|
pure virtual |
Create a hardware cursor object.
§ create_virtual_output()
virtual std::unique_ptr<VirtualOutput> mir::graphics::Display::create_virtual_output |
( |
int |
width, |
|
|
int |
height |
|
) |
| |
|
pure virtual |
Creates a virtual output.
- Returns
- null if the implementation does not support virtual outputs
§ for_each_display_sync_group()
virtual void mir::graphics::Display::for_each_display_sync_group |
( |
std::function< void(DisplaySyncGroup &)> const & |
f | ) |
|
|
pure virtual |
§ last_frame_on()
virtual Frame mir::graphics::Display::last_frame_on |
( |
unsigned |
output_id | ) |
const |
|
pure virtual |
Returns timing information for the last frame displayed on a given output.
Frame timing will be provided to clients only when they request it. This is to ensure idle clients never get woken by unwanted events. It is also distinctly separate from the display configuration as this timing information changes many times per second and should not interfere with the more static display configuration.
Note: Using unsigned here because DisplayConfigurationOutputId is troublesome (can't be forward declared) and including display_configuration.h to get it would be an overkill.
§ native_display()
virtual NativeDisplay* mir::graphics::Display::native_display |
( |
| ) |
|
|
pure virtual |
Returns a pointer to the native display object backing this display.
The pointer to the native display remains valid as long as the display object is valid.
- Examples:
- render_surfaces.cpp.
§ pause()
virtual void mir::graphics::Display::pause |
( |
| ) |
|
|
pure virtual |
Pauses the display.
This method may temporarily (until resumed) release any resources associated with the display subsystem.
§ register_configuration_change_handler()
Registers a handler for display configuration changes.
Note that the handler is called only for hardware changes (e.g. monitor plugged/unplugged), not for changes initiated by software (e.g. modesetting).
The implementation should use the functionality provided by the MainLoop to register the handlers in a way appropriate for the platform.
§ register_pause_resume_handlers()
Registers handlers for pausing and resuming the display subsystem.
The implementation should use the functionality provided by the EventHandlerRegister to register the handlers in a way appropriate for the platform.
§ resume()
virtual void mir::graphics::Display::resume |
( |
| ) |
|
|
pure virtual |
The documentation for this class was generated from the following file:
Copyright © 2012-2016 Canonical Ltd.
Generated on Sat Dec 3 12:48:59 UTC 2016