Mir
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
mir::scene::Surface Class Referenceabstract

#include <surface.h>

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

Public Member Functions

std::string name () const =0
 
geometry::Size size () const =0
 
geometry::Point top_left () const =0
 
float alpha () const =0
 
virtual std::shared_ptr
< input::InputChannel
input_channel () const =0
 
virtual void on_change (std::function< void()> change_notification)=0
 
virtual void add_observer (std::shared_ptr< SurfaceObserver > const &observer)=0
 
virtual void remove_observer (std::shared_ptr< SurfaceObserver > const &observer)=0
 
- Public Member Functions inherited from mir::graphics::Renderable
virtual std::shared_ptr< Bufferbuffer (void const *user_id) const =0
 Return the next buffer that should be composited/rendered. More...
 
virtual bool alpha_enabled () const =0
 
virtual geometry::Rectangle screen_position () const =0
 
virtual glm::mat4 transformation () const =0
 Transformation returns the transformation matrix that should be applied to the surface. More...
 
virtual bool visible () const =0
 TODO: Its a bit questionable that we have this member function, why not just trim the renderable from the RenderableList? Its convenient to have this function temporarily while refactoring –kdub. More...
 
virtual bool shaped () const =0
 
virtual int buffers_ready_for_compositor () const =0
 
- Public Member Functions inherited from mir::input::Surface
virtual bool contains (geometry::Point const &point) const =0
 
- Public Member Functions inherited from mir::shell::Surface
virtual MirSurfaceType type () const =0
 
virtual MirSurfaceState state () const =0
 
virtual void hide ()=0
 
virtual void show ()=0
 
virtual void move_to (geometry::Point const &top_left)=0
 
virtual void take_input_focus (std::shared_ptr< InputTargeter > const &targeter)=0
 
virtual void set_input_region (std::vector< geometry::Rectangle > const &region)=0
 
virtual void allow_framedropping (bool)=0
 
virtual void resize (geometry::Size const &size)=0
 
virtual void set_transformation (glm::mat4 const &t)=0
 
virtual void set_alpha (float alpha)=0
 
- Public Member Functions inherited from mir::frontend::Surface
virtual ~Surface ()
 
virtual void force_requests_to_complete ()=0
 
virtual MirPixelFormat pixel_format () const =0
 
virtual void swap_buffers (graphics::Buffer *old_buffer, std::function< void(graphics::Buffer *new_buffer)> complete)=0
 
virtual bool supports_input () const =0
 
virtual int client_input_fd () const =0
 
virtual int configure (MirSurfaceAttrib attrib, int value)=0
 
void swap_buffers_blocking (graphics::Buffer *&buffer)
 swap_buffers_blocking() is a convenience wrapper around swap_buffers() it forces the current thread to block until complete() is called. More...
 
- Public Member Functions inherited from mir::shell::SurfaceBufferAccess
virtual ~SurfaceBufferAccess ()=default
 
virtual void with_most_recent_buffer_do (std::function< void(graphics::Buffer &)> const &exec)=0
 

Additional Inherited Members

- Protected Member Functions inherited from mir::graphics::Renderable
 Renderable ()=default
 
virtual ~Renderable ()=default
 
 Renderable (Renderable const &)=delete
 
Renderableoperator= (Renderable const &)=delete
 
- 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
 
- Protected Member Functions inherited from mir::shell::SurfaceBufferAccess
 SurfaceBufferAccess ()=default
 
 SurfaceBufferAccess (SurfaceBufferAccess const &)=delete
 
SurfaceBufferAccessoperator= (SurfaceBufferAccess const &)=delete
 

Member Function Documentation

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

Implemented in mir::scene::BasicSurface.

float mir::scene::Surface::alpha ( ) const
pure virtual
virtual std::shared_ptr<input::InputChannel> mir::scene::Surface::input_channel ( ) const
pure virtual

Implemented in mir::scene::BasicSurface.

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

Implements mir::input::Surface.

Implemented in mir::scene::BasicSurface.

virtual void mir::scene::Surface::on_change ( std::function< void()>  change_notification)
pure virtual

Implemented in mir::scene::BasicSurface.

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

Implemented in mir::scene::BasicSurface.

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

Implements mir::input::Surface.

Implemented in mir::scene::BasicSurface.

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

Implements mir::input::Surface.

Implemented in mir::scene::BasicSurface.


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