Mir
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Member Functions | List of all members
mir::graphics::Display Class Referenceabstract

Interface to the display subsystem. More...

#include <display.h>

Inheritance diagram for mir::graphics::Display:
[legend]

Public Member Functions

virtual void for_each_display_buffer (std::function< void(DisplayBuffer &)> const &f)=0
 Executes a functor for each output framebuffer. More...
 
virtual std::unique_ptr
< DisplayConfiguration
configuration () const =0
 Gets a copy of the current output configuration. More...
 
virtual void configure (DisplayConfiguration const &conf)=0
 Sets a new output configuration. More...
 
virtual void register_configuration_change_handler (EventHandlerRegister &handlers, DisplayConfigurationChangeHandler const &conf_change_handler)=0
 Registers a handler for display configuration changes. More...
 
virtual void register_pause_resume_handlers (EventHandlerRegister &handlers, DisplayPauseHandler const &pause_handler, DisplayResumeHandler const &resume_handler)=0
 Registers handlers for pausing and resuming the display subsystem. More...
 
virtual void pause ()=0
 Pauses the display. More...
 
virtual void resume ()=0
 Resumes the display. More...
 
virtual std::shared_ptr< Cursorcreate_hardware_cursor (std::shared_ptr< CursorImage > const &initial_image)=0
 Create a hardware cursor object. More...
 
virtual std::unique_ptr
< GLContext
create_gl_context ()=0
 Creates a GLContext object that shares resources with the Display's GL context. More...
 

Protected Member Functions

 Display ()=default
 
virtual ~Display ()
 

Detailed Description

Interface to the display subsystem.

Constructor & Destructor Documentation

mir::graphics::Display::Display ( )
protecteddefault
virtual mir::graphics::Display::~Display ( )
inlineprotectedvirtual

Member Function Documentation

virtual std::unique_ptr<DisplayConfiguration> mir::graphics::Display::configuration ( ) const
pure virtual
virtual void mir::graphics::Display::configure ( DisplayConfiguration const &  conf)
pure virtual
virtual std::unique_ptr<GLContext> mir::graphics::Display::create_gl_context ( )
pure virtual

Creates a GLContext object that shares resources with the Display's GL context.

This is usually implemented as a shared EGL context. This object can be used to access graphics resources from an arbitrary thread.

Implemented in mir::graphics::nested::NestedDisplay, mir::graphics::offscreen::Display, mir::graphics::mesa::Display, and mir::graphics::android::Display.

virtual std::shared_ptr<Cursor> mir::graphics::Display::create_hardware_cursor ( std::shared_ptr< CursorImage > const &  initial_image)
pure virtual
virtual void mir::graphics::Display::for_each_display_buffer ( std::function< void(DisplayBuffer &)> const &  f)
pure virtual

Executes a functor for each output framebuffer.

Implemented in mir::graphics::nested::NestedDisplay.

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.

Implemented in mir::graphics::nested::NestedDisplay, mir::graphics::offscreen::Display, mir::graphics::mesa::Display, and mir::graphics::android::Display.

virtual void mir::graphics::Display::register_configuration_change_handler ( EventHandlerRegister handlers,
DisplayConfigurationChangeHandler const &  conf_change_handler 
)
pure virtual

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.

Implemented in mir::graphics::nested::NestedDisplay, mir::graphics::offscreen::Display, mir::graphics::mesa::Display, and mir::graphics::android::Display.

virtual void mir::graphics::Display::register_pause_resume_handlers ( EventHandlerRegister handlers,
DisplayPauseHandler const &  pause_handler,
DisplayResumeHandler const &  resume_handler 
)
pure virtual

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.

Implemented in mir::graphics::nested::NestedDisplay, mir::graphics::offscreen::Display, mir::graphics::mesa::Display, and mir::graphics::android::Display.

virtual void mir::graphics::Display::resume ( )
pure virtual

The documentation for this class was generated from the following file:

Copyright © 2012,2013 Canonical Ltd.
Generated on Fri Oct 10 14:07:14 UTC 2014