Mir
Public Member Functions | List of all members
mir::graphics::X::Display Class Reference

#include <display.h>

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

Public Member Functions

 Display (::Display *x_dpy, mir::geometry::Size const size)
 
 ~Display () noexcept
 
void for_each_display_sync_group (std::function< void(graphics::DisplaySyncGroup &)> const &f) override
 
std::unique_ptr< graphics::DisplayConfigurationconfiguration () const override
 Gets a copy of the current output configuration. More...
 
void configure (graphics::DisplayConfiguration const &) override
 Sets a new output configuration. More...
 
void register_configuration_change_handler (EventHandlerRegister &handlers, DisplayConfigurationChangeHandler const &conf_change_handler) override
 Registers a handler for display configuration changes. More...
 
void register_pause_resume_handlers (EventHandlerRegister &handlers, DisplayPauseHandler const &pause_handler, DisplayResumeHandler const &resume_handler) override
 Registers handlers for pausing and resuming the display subsystem. More...
 
void pause () override
 Pauses the display. More...
 
void resume () override
 Resumes the display. More...
 
std::shared_ptr< Cursorcreate_hardware_cursor (std::shared_ptr< CursorImage > const &initial_image) override
 Create a hardware cursor object. More...
 
std::unique_ptr< graphics::GLContextcreate_gl_context () override
 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_sync_group (std::function< void(DisplaySyncGroup &)> const &f)=0
 Executes a functor for each output group. More...
 

Additional Inherited Members

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

Constructor & Destructor Documentation

mir::graphics::X::Display::Display ( ::Display x_dpy,
mir::geometry::Size const  size 
)
explicit
mir::graphics::X::Display::~Display ( )
virtualnoexcept

Reimplemented from mir::graphics::Display.

Member Function Documentation

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

Gets a copy of the current output configuration.

Implements mir::graphics::Display.

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

Sets a new output configuration.

Implements mir::graphics::Display.

std::unique_ptr<graphics::GLContext> mir::graphics::X::Display::create_gl_context ( )
overridevirtual

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.

std::shared_ptr<Cursor> mir::graphics::X::Display::create_hardware_cursor ( std::shared_ptr< CursorImage > const &  initial_image)
overridevirtual

Create a hardware cursor object.

Implements mir::graphics::Display.

void mir::graphics::X::Display::for_each_display_sync_group ( std::function< void(graphics::DisplaySyncGroup &)> const &  f)
override
void mir::graphics::X::Display::pause ( )
overridevirtual

Pauses the display.

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

Implements mir::graphics::Display.

void mir::graphics::X::Display::register_configuration_change_handler ( EventHandlerRegister handlers,
DisplayConfigurationChangeHandler const &  conf_change_handler 
)
overridevirtual

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::X::Display::register_pause_resume_handlers ( EventHandlerRegister handlers,
DisplayPauseHandler const &  pause_handler,
DisplayResumeHandler const &  resume_handler 
)
overridevirtual

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::X::Display::resume ( )
overridevirtual

Resumes the display.

Implements mir::graphics::Display.


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

Copyright © 2012-2015 Canonical Ltd.
Generated on Thu Oct 8 16:20:16 UTC 2015