Mir
Public Member Functions | List of all members
mir::scene::Surface Class Referenceabstract

#include <surface.h>

Inheritance diagram for mir::scene::Surface:
[legend]

Public Member Functions

std::string name () const override=0
 
geometry::Size client_size () const override=0
 Size of the client area of the surface (excluding any decorations) More...
 
geometry::Rectangle input_bounds () const override=0
 
virtual geometry::Point top_left () const =0
 Top-left corner (of the window frame if present) More...
 
virtual geometry::Size size () const =0
 Size of the surface including window frame (if any) More...
 
virtual graphics::RenderableList generate_renderables (compositor::CompositorID id) const =0
 
virtual int buffers_ready_for_compositor (void const *compositor_id) const =0
 
virtual float alpha () const =0
 
virtual MirSurfaceType type () const =0
 
virtual MirSurfaceState state () const =0
 
virtual void hide ()=0
 
virtual void show ()=0
 
virtual bool visible () const =0
 
virtual void move_to (geometry::Point const &top_left)=0
 
virtual void set_input_region (std::vector< geometry::Rectangle > const &region)=0
 Sets the input region for this surface. More...
 
virtual void resize (geometry::Size const &size)=0
 
virtual void set_transformation (glm::mat4 const &t)=0
 
virtual void set_alpha (float alpha)=0
 
virtual void set_orientation (MirOrientation orientation)=0
 
virtual void set_cursor_image (std::shared_ptr< graphics::CursorImage > const &image) override=0
 
virtual std::shared_ptr< graphics::CursorImagecursor_image () const override=0
 
virtual void add_observer (std::shared_ptr< SurfaceObserver > const &observer)=0
 
virtual void remove_observer (std::weak_ptr< SurfaceObserver > const &observer)=0
 
virtual std::shared_ptr< input::InputChannelinput_channel () const override=0
 
virtual void set_reception_mode (input::InputReceptionMode mode)=0
 
virtual void request_client_surface_close ()=0
 
virtual std::shared_ptr< Surfaceparent () const =0
 
virtual int configure (MirSurfaceAttrib attrib, int value)=0
 
virtual int query (MirSurfaceAttrib attrib) const =0
 
virtual void set_keymap (MirInputDeviceId id, std::string const &model, std::string const &layout, std::string const &variant, std::string const &options)=0
 
virtual void rename (std::string const &title)=0
 
virtual void set_streams (std::list< StreamInfo > const &streams)=0
 
virtual void set_confine_pointer_state (MirPointerConfinementState state)=0
 
virtual MirPointerConfinementState confine_pointer_state () const =0
 
virtual void placed_relative (geometry::Rectangle const &placement)=0
 
- Public Member Functions inherited from mir::input::Surface
virtual bool input_area_contains (geometry::Point const &point) const =0
 
virtual InputReceptionMode reception_mode () const =0
 
virtual void consume (MirEvent const *event)=0
 
- Public Member Functions inherited from mir::frontend::Surface
virtual ~Surface ()=default
 
virtual std::shared_ptr< frontend::BufferStreamprimary_buffer_stream () const =0
 
virtual bool supports_input () const =0
 
virtual int client_input_fd () const =0
 
virtual void set_cursor_stream (std::shared_ptr< frontend::BufferStream > const &image, geometry::Displacement const &hotspot)=0
 

Additional Inherited Members

- Protected Member Functions inherited from mir::input::Surface
 Surface ()=default
 
virtual ~Surface ()=default
 
 Surface (const Surface &)=delete
 
Surfaceoperator= (const Surface &)=delete
 
- Protected Member Functions inherited from mir::frontend::Surface
 Surface ()=default
 
 Surface (Surface const &)=delete
 
Surfaceoperator= (Surface const &)=delete
 

Member Function Documentation

§ add_observer()

virtual void mir::scene::Surface::add_observer ( std::shared_ptr< SurfaceObserver > const &  observer)
pure virtual

§ alpha()

virtual float mir::scene::Surface::alpha ( ) const
pure virtual

§ buffers_ready_for_compositor()

virtual int mir::scene::Surface::buffers_ready_for_compositor ( void const *  compositor_id) const
pure virtual

§ client_size()

geometry::Size mir::scene::Surface::client_size ( ) const
overridepure virtual

Size of the client area of the surface (excluding any decorations)

Implements mir::frontend::Surface.

§ configure()

virtual int mir::scene::Surface::configure ( MirSurfaceAttrib  attrib,
int  value 
)
pure virtual

§ confine_pointer_state()

virtual MirPointerConfinementState mir::scene::Surface::confine_pointer_state ( ) const
pure virtual

§ cursor_image()

virtual std::shared_ptr<graphics::CursorImage> mir::scene::Surface::cursor_image ( ) const
overridepure virtual

Implements mir::input::Surface.

§ generate_renderables()

virtual graphics::RenderableList mir::scene::Surface::generate_renderables ( compositor::CompositorID  id) const
pure virtual

§ hide()

virtual void mir::scene::Surface::hide ( )
pure virtual

§ input_bounds()

geometry::Rectangle mir::scene::Surface::input_bounds ( ) const
overridepure virtual

Implements mir::input::Surface.

§ input_channel()

virtual std::shared_ptr<input::InputChannel> mir::scene::Surface::input_channel ( ) const
overridepure virtual

Implements mir::input::Surface.

§ move_to()

virtual void mir::scene::Surface::move_to ( geometry::Point const &  top_left)
pure virtual

§ name()

std::string mir::scene::Surface::name ( ) const
overridepure virtual

Implements mir::input::Surface.

§ parent()

virtual std::shared_ptr<Surface> mir::scene::Surface::parent ( ) const
pure virtual

§ placed_relative()

virtual void mir::scene::Surface::placed_relative ( geometry::Rectangle const &  placement)
pure virtual

§ query()

virtual int mir::scene::Surface::query ( MirSurfaceAttrib  attrib) const
pure virtual

§ remove_observer()

virtual void mir::scene::Surface::remove_observer ( std::weak_ptr< SurfaceObserver > const &  observer)
pure virtual

§ rename()

virtual void mir::scene::Surface::rename ( std::string const &  title)
pure virtual

§ request_client_surface_close()

virtual void mir::scene::Surface::request_client_surface_close ( )
pure virtual

§ resize()

virtual void mir::scene::Surface::resize ( geometry::Size const &  size)
pure virtual

§ set_alpha()

virtual void mir::scene::Surface::set_alpha ( float  alpha)
pure virtual

§ set_confine_pointer_state()

virtual void mir::scene::Surface::set_confine_pointer_state ( MirPointerConfinementState  state)
pure virtual

§ set_cursor_image()

virtual void mir::scene::Surface::set_cursor_image ( std::shared_ptr< graphics::CursorImage > const &  image)
overridepure virtual

§ set_input_region()

virtual void mir::scene::Surface::set_input_region ( std::vector< geometry::Rectangle > const &  region)
pure virtual

Sets the input region for this surface.

The input region is expressed in coordinates relative to the surface (i.e., use (0,0) for the top left point of the surface).

By default the input region is the whole surface. To unset a custom input region and revert to the default set an empty input region, i.e., set_input_region({}). To disable input set a non-empty region containing an empty rectangle, i.e., set_input_region({Rectangle{}}).

§ set_keymap()

virtual void mir::scene::Surface::set_keymap ( MirInputDeviceId  id,
std::string const &  model,
std::string const &  layout,
std::string const &  variant,
std::string const &  options 
)
pure virtual

§ set_orientation()

virtual void mir::scene::Surface::set_orientation ( MirOrientation  orientation)
pure virtual

§ set_reception_mode()

virtual void mir::scene::Surface::set_reception_mode ( input::InputReceptionMode  mode)
pure virtual

§ set_streams()

virtual void mir::scene::Surface::set_streams ( std::list< StreamInfo > const &  streams)
pure virtual

§ set_transformation()

virtual void mir::scene::Surface::set_transformation ( glm::mat4 const &  t)
pure virtual

§ show()

virtual void mir::scene::Surface::show ( )
pure virtual

§ size()

virtual geometry::Size mir::scene::Surface::size ( ) const
pure virtual

Size of the surface including window frame (if any)

Examples:
server_example_canonical_window_manager.cpp.

§ state()

virtual MirSurfaceState mir::scene::Surface::state ( ) const
pure virtual

§ top_left()

virtual geometry::Point mir::scene::Surface::top_left ( ) const
pure virtual

Top-left corner (of the window frame if present)

Examples:
server_example_canonical_window_manager.cpp.

§ type()

virtual MirSurfaceType mir::scene::Surface::type ( ) const
pure virtual

§ visible()

virtual bool mir::scene::Surface::visible ( ) const
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