Mir
session.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: Robert Carr <racarr@canonical.com>
17  */
18 
19 #ifndef MIR_SCENE_SESSION_H_
20 #define MIR_SCENE_SESSION_H_
21 
22 #include "mir/frontend/session.h"
23 #include "mir/scene/snapshot.h"
24 
25 #include <vector>
26 #include <sys/types.h>
27 
28 namespace mir
29 {
30 namespace frontend { class EventSink; }
31 namespace shell { struct StreamSpecification; }
32 namespace scene
33 {
34 class Surface;
35 struct SurfaceCreationParameters;
36 
37 class Session : public frontend::Session
38 {
39 public:
40  virtual void drop_outstanding_requests() = 0;
41  virtual pid_t process_id() const = 0;
42 
43  virtual void take_snapshot(SnapshotCallback const& snapshot_taken) = 0;
44  virtual std::shared_ptr<Surface> default_surface() const = 0;
45  virtual void set_lifecycle_state(MirLifecycleState state) = 0;
46 
47  virtual void hide() = 0;
48  virtual void show() = 0;
49 
50  virtual void start_prompt_session() = 0;
51  virtual void stop_prompt_session() = 0;
52  virtual void suspend_prompt_session() = 0;
53  virtual void resume_prompt_session() = 0;
54 
55  virtual frontend::SurfaceId create_surface(
56  SurfaceCreationParameters const& params,
57  std::shared_ptr<frontend::EventSink> const& sink) = 0;
58  virtual void destroy_surface(frontend::SurfaceId surface) = 0;
59 
60  virtual std::shared_ptr<Surface> surface(frontend::SurfaceId surface) const = 0;
61  virtual std::shared_ptr<Surface> surface_after(std::shared_ptr<Surface> const&) const = 0;
62 
63  virtual std::shared_ptr<frontend::BufferStream> get_buffer_stream(frontend::BufferStreamId stream) const = 0;
64 
65  virtual frontend::BufferStreamId create_buffer_stream(graphics::BufferProperties const& props) = 0;
66  virtual void destroy_buffer_stream(frontend::BufferStreamId stream) = 0;
67  virtual void configure_streams(Surface& surface, std::vector<shell::StreamSpecification> const& config) = 0;
68  virtual void destroy_surface(std::weak_ptr<Surface> const& surface) = 0;
69 
70  virtual graphics::BufferID create_buffer(graphics::BufferProperties const& properties) = 0;
71  virtual void destroy_buffer(graphics::BufferID) = 0;
72  virtual std::shared_ptr<graphics::Buffer> get_buffer(graphics::BufferID) = 0;
73 };
74 }
75 }
76 
77 #endif // MIR_SCENE_SESSION_H_
Definition: session.h:49
Definition: as_render_target.h:27
Definition: session.h:37
std::function< void(Snapshot const &)> SnapshotCallback
Definition: snapshot.h:39
MirLifecycleState
Definition: common.h:179
Definition: surface_creation_parameters.h:41
Buffer creation properties.
Definition: buffer_properties.h:48
Definition: surface.h:49

Copyright © 2012-2016 Canonical Ltd.
Generated on Tue Oct 31 05:57:28 UTC 2017