← Back to branch summary

~raof/mir/wl-implement-bare-minimum-fullscreen

« back to all changes in this revision

Viewing changes to include/miral/miral/window_specification.h

  • Committer: Christopher James Halse Rogers
  • Date: 2017-09-07 05:58:13 UTC
  • mfrom: (4154.58.29 development-branch)
  • Revision ID: christopher.halse.rogers@canonical.com-20170907055813-4qsg25nirybc8jj3
Merge trunk, resolving conflict

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/miral/miral/window_specification.h
 
1
/*
 
2
 * Copyright © 2016 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 2 or 3 as
 
6
 * 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: Alan Griffiths <alan@octopull.co.uk>
 
17
 */
 
18
 
 
19
#ifndef MIRAL_WINDOW_SPECIFICATION_H
 
20
#define MIRAL_WINDOW_SPECIFICATION_H
 
21
 
 
22
#include <mir_toolkit/common.h>
 
23
 
 
24
#include <mir/geometry/displacement.h>
 
25
#include <mir/geometry/rectangles.h>
 
26
#include <mir/optional_value.h>
 
27
#include <mir/int_wrapper.h>
 
28
 
 
29
#include <memory>
 
30
 
 
31
namespace mir
 
32
{
 
33
namespace scene { class Surface; struct SurfaceCreationParameters; }
 
34
namespace shell { struct SurfaceSpecification; }
 
35
}
 
36
 
 
37
namespace miral
 
38
{
 
39
using namespace mir::geometry;
 
40
namespace detail { struct SessionsBufferStreamIdTag; }
 
41
typedef mir::IntWrapper<detail::SessionsBufferStreamIdTag> BufferStreamId;
 
42
 
 
43
class WindowSpecification
 
44
{
 
45
public:
 
46
    enum class BufferUsage
 
47
    {
 
48
        undefined,
 
49
        /** rendering using GL */
 
50
            hardware,
 
51
        /** rendering using direct pixel access */
 
52
            software
 
53
    };
 
54
 
 
55
    enum class InputReceptionMode
 
56
    {
 
57
        normal,
 
58
        receives_all_input
 
59
    };
 
60
 
 
61
    struct AspectRatio { unsigned width; unsigned height; };
 
62
 
 
63
    WindowSpecification();
 
64
    WindowSpecification(WindowSpecification const& that);
 
65
    auto operator=(WindowSpecification const& that) -> WindowSpecification&;
 
66
 
 
67
    WindowSpecification(mir::shell::SurfaceSpecification const& spec);
 
68
    WindowSpecification(mir::scene::SurfaceCreationParameters const& params);
 
69
    void update(mir::scene::SurfaceCreationParameters& params) const;
 
70
 
 
71
    ~WindowSpecification();
 
72
 
 
73
    auto top_left() const -> mir::optional_value<Point> const&;
 
74
    auto size() const -> mir::optional_value<Size> const&;
 
75
    auto name() const -> mir::optional_value<std::string> const&;
 
76
    auto output_id() const -> mir::optional_value<int> const&;
 
77
    auto type() const -> mir::optional_value<MirWindowType> const&;
 
78
    auto state() const -> mir::optional_value<MirWindowState> const&;
 
79
    auto preferred_orientation() const -> mir::optional_value<MirOrientationMode> const&;
 
80
    auto aux_rect() const -> mir::optional_value<Rectangle> const&;
 
81
    auto placement_hints() const -> mir::optional_value<MirPlacementHints> const&;
 
82
    auto window_placement_gravity() const -> mir::optional_value<MirPlacementGravity> const&;
 
83
    auto aux_rect_placement_gravity() const -> mir::optional_value<MirPlacementGravity> const&;
 
84
    auto aux_rect_placement_offset() const -> mir::optional_value<Displacement> const&;
 
85
    auto min_width() const -> mir::optional_value<Width> const&;
 
86
    auto min_height() const -> mir::optional_value<Height> const&;
 
87
    auto max_width() const -> mir::optional_value<Width> const&;
 
88
    auto max_height() const -> mir::optional_value<Height> const&;
 
89
    auto width_inc() const -> mir::optional_value<DeltaX> const&;
 
90
    auto height_inc() const -> mir::optional_value<DeltaY> const&;
 
91
    auto min_aspect() const -> mir::optional_value<AspectRatio> const&;
 
92
    auto max_aspect() const -> mir::optional_value<AspectRatio> const&;
 
93
 
 
94
    auto parent() const -> mir::optional_value<std::weak_ptr<mir::scene::Surface>> const&;
 
95
    auto input_shape() const -> mir::optional_value<std::vector<Rectangle>> const&;
 
96
    auto input_mode() const -> mir::optional_value<InputReceptionMode> const&;
 
97
    auto shell_chrome() const -> mir::optional_value<MirShellChrome> const&;
 
98
    auto confine_pointer() const -> mir::optional_value<MirPointerConfinementState> const&;
 
99
    auto userdata() const -> mir::optional_value<std::shared_ptr<void>> const&;
 
100
 
 
101
    auto top_left() -> mir::optional_value<Point>&;
 
102
    auto size() -> mir::optional_value<Size>&;
 
103
    auto name() -> mir::optional_value<std::string>&;
 
104
    auto output_id() -> mir::optional_value<int>&;
 
105
    auto type() -> mir::optional_value<MirWindowType>&;
 
106
    auto state() -> mir::optional_value<MirWindowState>&;
 
107
    auto preferred_orientation() -> mir::optional_value<MirOrientationMode>&;
 
108
    auto aux_rect() -> mir::optional_value<Rectangle>&;
 
109
    auto placement_hints() -> mir::optional_value<MirPlacementHints>&;
 
110
    auto window_placement_gravity() -> mir::optional_value<MirPlacementGravity>&;
 
111
    auto aux_rect_placement_gravity() -> mir::optional_value<MirPlacementGravity>&;
 
112
    auto aux_rect_placement_offset() -> mir::optional_value<Displacement>&;
 
113
    auto min_width() -> mir::optional_value<Width>&;
 
114
    auto min_height() -> mir::optional_value<Height>&;
 
115
    auto max_width() -> mir::optional_value<Width>&;
 
116
    auto max_height() -> mir::optional_value<Height>&;
 
117
    auto width_inc() -> mir::optional_value<DeltaX>&;
 
118
    auto height_inc() -> mir::optional_value<DeltaY>&;
 
119
    auto min_aspect() -> mir::optional_value<AspectRatio>&;
 
120
    auto max_aspect() -> mir::optional_value<AspectRatio>&;
 
121
    auto parent() -> mir::optional_value<std::weak_ptr<mir::scene::Surface>>&;
 
122
    auto input_shape() -> mir::optional_value<std::vector<Rectangle>>&;
 
123
    auto input_mode() -> mir::optional_value<InputReceptionMode>&;
 
124
    auto shell_chrome() -> mir::optional_value<MirShellChrome>&;
 
125
    auto confine_pointer() -> mir::optional_value<MirPointerConfinementState>&;
 
126
    auto userdata() -> mir::optional_value<std::shared_ptr<void>>&;
 
127
 
 
128
private:
 
129
    struct Self;
 
130
    std::unique_ptr<Self> self;
 
131
};
 
132
}
 
133
 
 
134
#endif //MIRAL_WINDOW_SPECIFICATION_H