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

#include <scene.h>

Inheritance diagram for mir::compositor::Scene:
Inheritance graph
[legend]

Public Member Functions

virtual ~Scene ()
 
virtual graphics::RenderableList generate_renderable_list () const =0
 Generate a valid list of renderables based on the current state of the Scene. More...
 
virtual void for_each_if (FilterForScene &filter, OperatorForScene &op)=0
 
virtual void set_change_callback (std::function< void()> const &f)=0
 Sets a callback to be called whenever the state of the Scene changes. More...
 
virtual void lock ()=0
 
virtual void unlock ()=0
 

Protected Member Functions

 Scene ()=default
 

Constructor & Destructor Documentation

virtual mir::compositor::Scene::~Scene ( )
inlinevirtual
mir::compositor::Scene::Scene ( )
protecteddefault

Member Function Documentation

virtual void mir::compositor::Scene::for_each_if ( FilterForScene filter,
OperatorForScene op 
)
pure virtual

Implemented in mir::scene::SurfaceStack.

virtual graphics::RenderableList mir::compositor::Scene::generate_renderable_list ( ) const
pure virtual

Generate a valid list of renderables based on the current state of the Scene.

Returns
a list of mg::Renderables. The list is in stacking order from back to front.

Implemented in mir::scene::SurfaceStack.

virtual void mir::compositor::Scene::lock ( )
pure virtual

Implemented in mir::scene::SurfaceStack.

virtual void mir::compositor::Scene::set_change_callback ( std::function< void()> const &  f)
pure virtual

Sets a callback to be called whenever the state of the Scene changes.

The supplied callback should not directly or indirectly (e.g., by changing a property of a surface) change the state of the Scene, otherwise a deadlock may occur.

Implemented in mir::scene::SurfaceStack.

virtual void mir::compositor::Scene::unlock ( )
pure virtual

Implemented in mir::scene::SurfaceStack.


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