/usr/include/mirserver/mir/compositor/scene.h is in libmirserver-dev 0.26.3+16.04.20170605-0ubuntu1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 | /*
* Copyright © 2012 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authored by: Robert Carr <robert.carr@canonical.com>
*/
#ifndef MIR_COMPOSITOR_SCENE_H_
#define MIR_COMPOSITOR_SCENE_H_
#include "compositor_id.h"
#include <memory>
#include <vector>
namespace mir
{
namespace scene
{
class Observer;
}
namespace compositor
{
class SceneElement;
using SceneElementSequence = std::vector<std::shared_ptr<SceneElement>>;
class Scene
{
public:
virtual ~Scene() {}
/**
* Generate a valid sequence of scene elements based on the current state of the Scene.
* \param [in] id An arbitrary unique identifier used to distinguish
* separate compositors which need to receive a sequence
* for rendering. Calling with the same id will return
* a new (different) sequence to that user each time. For
* consistency, all callers need to determine their id
* in the same way (e.g. always use "this" pointer).
* \returns a sequence of SceneElements for the compositor id. The
* sequence is in stacking order from back to front.
*/
virtual SceneElementSequence scene_elements_for(CompositorID id) = 0;
/**
* Return the number of additional frames that you need to render to get
* fully up to date with the latest data in the scene. For a generic
* "scene change" this will be just 1. For surfaces that have multiple
* frames queued up however, it could be greater than 1. When the result
* reaches zero, you know you have consumed all the latest data from the
* scene.
*/
virtual int frames_pending(CompositorID id) const = 0;
virtual void register_compositor(CompositorID id) = 0;
virtual void unregister_compositor(CompositorID id) = 0;
virtual void add_observer(std::shared_ptr<scene::Observer> const& observer) = 0;
virtual void remove_observer(std::weak_ptr<scene::Observer> const& observer) = 0;
protected:
Scene() = default;
private:
Scene(Scene const&) = delete;
Scene& operator=(Scene const&) = delete;
};
}
}
#endif /* MIR_COMPOSITOR_SCENE_H_ */
|