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

#include <display.h>

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

Public Member Functions

 Display (std::shared_ptr< BasicPlatform > const &basic_platform, std::shared_ptr< DisplayConfigurationPolicy > const &initial_conf_policy, std::shared_ptr< DisplayReport > const &listener)
 
 ~Display () noexcept
 
void for_each_display_buffer (std::function< void(DisplayBuffer &)> const &f)
 
std::unique_ptr
< graphics::DisplayConfiguration
configuration () const override
 Gets a copy of the current output configuration. More...
 
void configure (graphics::DisplayConfiguration const &conf) override
 Sets a new output configuration. More...
 
void register_configuration_change_handler (EventHandlerRegister &handlers, DisplayConfigurationChangeHandler const &conf_change_handler)
 Registers a handler for display configuration changes. More...
 
void register_pause_resume_handlers (EventHandlerRegister &handlers, DisplayPauseHandler const &pause_handler, DisplayResumeHandler const &resume_handler)
 Registers handlers for pausing and resuming the display subsystem. More...
 
void pause ()
 Pauses the display. More...
 
void resume ()
 Resumes the display. More...
 
std::weak_ptr< Cursorthe_cursor ()
 Gets the hardware cursor object. More...
 
std::unique_ptr< GLContextcreate_gl_context ()
 Creates a GLContext object that shares resources with the Display's GL context. More...
 
- Public Member Functions inherited from mir::graphics::Display
virtual void for_each_display_buffer (std::function< void(DisplayBuffer &)> const &f)=0
 Executes a functor for each output framebuffer. More...
 

Additional Inherited Members

- Protected Member Functions inherited from mir::graphics::Display
 Display ()=default
 

Constructor & Destructor Documentation

mir::graphics::offscreen::Display::Display ( std::shared_ptr< BasicPlatform > const &  basic_platform,
std::shared_ptr< DisplayConfigurationPolicy > const &  initial_conf_policy,
std::shared_ptr< DisplayReport > const &  listener 
)
mir::graphics::offscreen::Display::~Display ( )
virtualnoexcept

Reimplemented from mir::graphics::Display.

Member Function Documentation

std::unique_ptr<graphics::DisplayConfiguration> mir::graphics::offscreen::Display::configuration ( ) const
overridevirtual

Gets a copy of the current output configuration.

Implements mir::graphics::Display.

void mir::graphics::offscreen::Display::configure ( graphics::DisplayConfiguration const &  conf)
overridevirtual

Sets a new output configuration.

Implements mir::graphics::Display.

std::unique_ptr<GLContext> mir::graphics::offscreen::Display::create_gl_context ( )
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.

Implements mir::graphics::Display.

void mir::graphics::offscreen::Display::for_each_display_buffer ( std::function< void(DisplayBuffer &)> const &  f)
void mir::graphics::offscreen::Display::pause ( )
virtual

Pauses the display.

This method may temporarily (until resumed) release any resources associated with the display subsystem.

Implements mir::graphics::Display.

void mir::graphics::offscreen::Display::register_configuration_change_handler ( EventHandlerRegister handlers,
DisplayConfigurationChangeHandler const &  conf_change_handler 
)
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.

Implements mir::graphics::Display.

void mir::graphics::offscreen::Display::register_pause_resume_handlers ( EventHandlerRegister handlers,
DisplayPauseHandler const &  pause_handler,
DisplayResumeHandler const &  resume_handler 
)
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.

Implements mir::graphics::Display.

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

Resumes the display.

Implements mir::graphics::Display.

std::weak_ptr<Cursor> mir::graphics::offscreen::Display::the_cursor ( )
virtual

Gets the hardware cursor object.

Implements mir::graphics::Display.


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

Copyright © 2012,2013 Canonical Ltd.
Generated on Fri Apr 11 21:14:53 UTC 2014