Mir
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
basic_surface.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2012-2014 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License version 3,
6  * as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Thomas Voss <thomas.voss@canonical.com>
17  */
18 
19 #ifndef MIR_SCENE_BASIC_SURFACE_H_
20 #define MIR_SCENE_BASIC_SURFACE_H_
21 
22 #include "mir/scene/surface.h"
23 #include "mir/basic_observers.h"
25 
26 #include "mir/geometry/rectangle.h"
27 
28 #include "mir_toolkit/common.h"
29 
30 #include <glm/glm.hpp>
31 #include <vector>
32 #include <memory>
33 #include <mutex>
34 #include <string>
35 
36 namespace mir
37 {
38 namespace compositor
39 {
40 struct BufferIPCPackage;
41 class BufferStream;
42 }
43 namespace frontend { class EventSink; }
44 namespace graphics
45 {
46 class Buffer;
47 }
48 namespace input
49 {
50 class InputChannel;
51 class InputSender;
52 class Surface;
53 }
54 namespace scene
55 {
56 class SceneReport;
57 class SurfaceConfigurator;
58 
59 class SurfaceObservers : public SurfaceObserver, BasicObservers<SurfaceObserver>
60 {
61 public:
64 
65  void attrib_changed(MirSurfaceAttrib attrib, int value) override;
66  void resized_to(geometry::Size const& size) override;
67  void moved_to(geometry::Point const& top_left) override;
68  void hidden_set_to(bool hide) override;
69  void frame_posted(int frames_available) override;
70  void alpha_set_to(float alpha) override;
71  void orientation_set_to(MirOrientation orientation) override;
72  void transformation_set_to(glm::mat4 const& t) override;
74  void cursor_image_set_to(graphics::CursorImage const& image) override;
75 };
76 
77 class BasicSurface : public Surface
78 {
79 public:
81  std::string const& name,
83  bool nonrectangular,
84  std::shared_ptr<compositor::BufferStream> const& buffer_stream,
85  std::shared_ptr<input::InputChannel> const& input_channel,
86  std::shared_ptr<input::InputSender> const& sender,
87  std::shared_ptr<SurfaceConfigurator> const& configurator,
88  std::shared_ptr<graphics::CursorImage> const& cursor_image,
89  std::shared_ptr<SceneReport> const& report);
90 
91  ~BasicSurface() noexcept;
92 
93  std::string name() const override;
94  void move_to(geometry::Point const& top_left) override;
95  float alpha() const override;
96  void set_hidden(bool is_hidden);
97 
98  geometry::Size size() const override;
99  geometry::Size client_size() const override;
100 
102 
103  std::shared_ptr<graphics::Buffer> snapshot_buffer() const;
104  void swap_buffers(graphics::Buffer* old_buffer, std::function<void(graphics::Buffer* new_buffer)> complete);
106 
107  bool supports_input() const;
108  int client_input_fd() const;
109  void allow_framedropping(bool);
110  std::shared_ptr<input::InputChannel> input_channel() const override;
111  input::InputReceptionMode reception_mode() const override;
112  void set_reception_mode(input::InputReceptionMode mode) override;
113 
114  void set_input_region(std::vector<geometry::Rectangle> const& input_rectangles) override;
115 
116  std::shared_ptr<compositor::BufferStream> buffer_stream() const;
117 
118  void resize(geometry::Size const& size) override;
119  geometry::Point top_left() const override;
120  geometry::Rectangle input_bounds() const override;
121  bool input_area_contains(geometry::Point const& point) const override;
122  void consume(MirEvent const& event);
123  void set_alpha(float alpha) override;
124  void set_orientation(MirOrientation orientation) override;
125  void set_transformation(glm::mat4 const&) override;
126 
127  bool visible() const;
128 
129  std::unique_ptr<graphics::Renderable> compositor_snapshot(void const* compositor_id) const;
130 
132  std::function<void(graphics::Buffer&)> const& exec) override;
133 
134  MirSurfaceType type() const override;
135  MirSurfaceState state() const override;
136  void take_input_focus(std::shared_ptr<shell::InputTargeter> const& targeter) override;
137  int configure(MirSurfaceAttrib attrib, int value) override;
138  int query(MirSurfaceAttrib attrib) override;
139  void hide() override;
140  void show() override;
141 
142  void set_cursor_image(std::shared_ptr<graphics::CursorImage> const& image);
143  std::shared_ptr<graphics::CursorImage> cursor_image() const;
144 
145  void add_observer(std::shared_ptr<SurfaceObserver> const& observer) override;
146  void remove_observer(std::weak_ptr<SurfaceObserver> const& observer) override;
147 
148  int dpi() const;
149 
150 private:
151  bool visible(std::unique_lock<std::mutex>&) const;
152  MirSurfaceType set_type(MirSurfaceType t); // Use configure() to make public changes
153  MirSurfaceState set_state(MirSurfaceState s);
154  int set_dpi(int);
155  MirSurfaceVisibility set_visibility(MirSurfaceVisibility v);
156  int set_swap_interval(int);
157  MirSurfaceFocusState set_focus_state(MirSurfaceFocusState f);
158 
159  SurfaceObservers observers;
160  std::mutex mutable guard;
161  std::string const surface_name;
162  geometry::Rectangle surface_rect;
163  glm::mat4 transformation_matrix;
164  float surface_alpha;
165  bool first_frame_posted;
166  bool hidden;
167  input::InputReceptionMode input_mode;
168  const bool nonrectangular;
169  std::vector<geometry::Rectangle> custom_input_rectangles;
170  std::shared_ptr<compositor::BufferStream> const surface_buffer_stream;
171  std::shared_ptr<input::InputChannel> const server_input_channel;
172  std::shared_ptr<input::InputSender> const input_sender;
173  std::shared_ptr<SurfaceConfigurator> const configurator;
174  std::shared_ptr<graphics::CursorImage> cursor_image_;
175  std::shared_ptr<SceneReport> const report;
176 
177  void initialize_attributes();
178  int attrib_values[mir_surface_attribs];
179 };
180 
181 }
182 }
183 
184 #endif // MIR_SCENE_BASIC_SURFACE_H_
Definition: size.h:30
void transformation_set_to(glm::mat4 const &t) override
Definition: basic_surface.cpp:86
geometry::Rectangle input_bounds() const override
Definition: basic_surface.cpp:289
All things Mir.
Definition: aging_buffer.h:24
void frame_posted(int frames_available) override
Definition: basic_surface.cpp:68
int query(MirSurfaceAttrib attrib) override
Definition: basic_surface.cpp:511
void allow_framedropping(bool)
Definition: basic_surface.cpp:223
void set_cursor_image(std::shared_ptr< graphics::CursorImage > const &image)
Definition: basic_surface.cpp:531
std::shared_ptr< input::InputChannel > input_channel() const override
Definition: basic_surface.cpp:247
std::shared_ptr< graphics::Buffer > snapshot_buffer() const
Definition: basic_surface.cpp:228
void hide() override
Definition: basic_surface.cpp:521
void remove_observer(std::weak_ptr< SurfaceObserver > const &observer) override
Definition: basic_surface.cpp:599
Definition: common.h:46
~BasicSurface() noexcept
Definition: basic_surface.cpp:151
Definition: point.h:30
void set_reception_mode(input::InputReceptionMode mode) override
Definition: basic_surface.cpp:364
input::InputReceptionMode reception_mode() const override
Definition: basic_surface.cpp:359
std::string name() const override
Definition: basic_surface.cpp:161
MirPixelFormat pixel_format() const
Definition: basic_surface.cpp:202
void resized_to(geometry::Size const &size) override
Definition: basic_surface.cpp:50
void show() override
Definition: basic_surface.cpp:526
void alpha_set_to(float alpha) override
Definition: basic_surface.cpp:74
int configure(MirSurfaceAttrib attrib, int value) override
Definition: basic_surface.cpp:477
void set_orientation(MirOrientation orientation) override
Definition: basic_surface.cpp:334
void swap_buffers(graphics::Buffer *old_buffer, std::function< void(graphics::Buffer *new_buffer)> complete)
Definition: basic_surface.cpp:207
int dpi() const
Definition: basic_surface.cpp:549
void set_hidden(bool is_hidden)
Definition: basic_surface.cpp:181
void resize(geometry::Size const &size) override
Definition: basic_surface.cpp:258
std::shared_ptr< compositor::BufferStream > buffer_stream() const
Definition: basic_surface.cpp:156
Definition: surface_observer.h:42
geometry::Point top_left() const override
Top-left corner (of the window frame if present)
Definition: basic_surface.cpp:283
void take_input_focus(std::shared_ptr< shell::InputTargeter > const &targeter) override
Definition: basic_surface.cpp:472
void reception_mode_set_to(input::InputReceptionMode mode) override
Definition: basic_surface.cpp:98
MirOrientation
Direction relative to the "natural" orientation of the display.
Definition: common.h:134
void moved_to(geometry::Point const &top_left) override
Definition: basic_surface.cpp:56
bool visible() const
Definition: basic_surface.cpp:348
Definition: cursor_image.h:30
std::shared_ptr< graphics::CursorImage > cursor_image() const
Definition: basic_surface.cpp:542
float alpha() const override
Definition: basic_surface.cpp:175
MirSurfaceState
Definition: common.h:61
void cursor_image_set_to(graphics::CursorImage const &image) override
Definition: basic_surface.cpp:92
BasicSurface(std::string const &name, geometry::Rectangle rect, bool nonrectangular, std::shared_ptr< compositor::BufferStream > const &buffer_stream, std::shared_ptr< input::InputChannel > const &input_channel, std::shared_ptr< input::InputSender > const &sender, std::shared_ptr< SurfaceConfigurator > const &configurator, std::shared_ptr< graphics::CursorImage > const &cursor_image, std::shared_ptr< SceneReport > const &report)
Definition: basic_surface.cpp:105
MirSurfaceState state() const override
Definition: basic_surface.cpp:408
geometry::Size size() const override
Size of the surface including window frame (if any)
Definition: basic_surface.cpp:190
void set_input_region(std::vector< geometry::Rectangle > const &input_rectangles) override
Sets the input region for this surface.
Definition: basic_surface.cpp:252
void orientation_set_to(MirOrientation orientation) override
Definition: basic_surface.cpp:80
MirSurfaceAttrib
Attributes of a surface that the client and server/shell may wish to get or set over the wire...
Definition: common.h:36
void with_most_recent_buffer_do(std::function< void(graphics::Buffer &)> const &exec) override
Definition: basic_surface.cpp:373
MirSurfaceType
Definition: common.h:49
Definition: basic_surface.h:77
MirPixelFormat
The order of components in a format enum matches the order of the components as they would be written...
Definition: common.h:119
int client_input_fd() const
Definition: basic_surface.cpp:240
MirSurfaceFocusState
Definition: common.h:77
bool input_area_contains(geometry::Point const &point) const override
Definition: basic_surface.cpp:296
MirSurfaceVisibility
Definition: common.h:83
void attrib_changed(MirSurfaceAttrib attrib, int value) override
Definition: basic_surface.cpp:44
void set_alpha(float alpha) override
Definition: basic_surface.cpp:325
void set_transformation(glm::mat4 const &) override
Definition: basic_surface.cpp:339
geometry::Size client_size() const override
Size of the client area of the surface (excluding any decorations)
Definition: basic_surface.cpp:196
Definition: rectangle.h:33
Definition: basic_observers.h:30
Definition: basic_surface.h:59
void hidden_set_to(bool hide) override
Definition: basic_surface.cpp:62
std::unique_ptr< graphics::Renderable > compositor_snapshot(void const *compositor_id) const
Definition: basic_surface.cpp:678
Definition: event.h:227
MirSurfaceType type() const override
Definition: basic_surface.cpp:381
Definition: buffer.h:34
InputReceptionMode
Definition: input_reception_mode.h:27
Definition: surface.h:40
void force_requests_to_complete()
Definition: basic_surface.cpp:146
void consume(MirEvent const &event)
Definition: basic_surface.cpp:694
int const size
Definition: make_socket_rpc_channel.cpp:51
bool supports_input() const
Definition: basic_surface.cpp:233
void move_to(geometry::Point const &top_left) override
Definition: basic_surface.cpp:166
void add_observer(std::shared_ptr< SurfaceObserver > const &observer) override
Definition: basic_surface.cpp:594

Copyright © 2012,2013 Canonical Ltd.
Generated on Fri Oct 10 14:07:14 UTC 2014