Mir
surface_creation_parameters.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 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: Alan Griffiths <alan@octopull.co.uk>
17  */
18 
19 #ifndef MIR_SCENE_SURFACE_CREATION_PARAMETERS_H_
20 #define MIR_SCENE_SURFACE_CREATION_PARAMETERS_H_
21 
22 #include "mir_toolkit/common.h"
23 #include "mir/geometry/point.h"
24 #include "mir/geometry/size.h"
27 #include "mir/scene/depth_id.h"
30 #include "mir/optional_value.h"
32 
33 #include <memory>
34 #include <string>
35 
36 namespace mir
37 {
38 namespace scene
39 {
40 class Surface;
41 
43 {
45 
47 
49 
51 
53 
55 
57 
59 
61 
63 
65 
67 
69 
71 
73 
75 
77 
86 
94 
95  std::weak_ptr<Surface> parent;
96 
105 
107 };
108 
111 
113 }
114 }
115 
116 #endif /* MIR_SCENE_SURFACE_CREATION_PARAMETERS_H_ */
Definition: size.h:30
mir::optional_value< geometry::DeltaY > height_inc
Definition: surface_creation_parameters.h:102
SurfaceCreationParameters & of_size(geometry::Size new_size)
Definition: surface_creation_parameters.cpp:41
All things Mir.
Definition: atomic_callback.h:25
mir::optional_value< MirSurfaceState > state
Definition: surface_creation_parameters.h:87
SurfaceCreationParameters & of_type(MirSurfaceType type)
Definition: surface_creation_parameters.cpp:103
input::InputReceptionMode input_mode
Definition: surface_creation_parameters.h:84
mir::optional_value< MirOrientationMode > preferred_orientation
Definition: surface_creation_parameters.h:89
geometry::Size size
Definition: surface_creation_parameters.h:79
std::string name
Definition: surface_creation_parameters.h:78
mir::optional_value< MirEdgeAttachment > edge_attachment
Definition: surface_creation_parameters.h:93
SurfaceCreationParameters & with_preferred_orientation(MirOrientationMode mode)
Definition: surface_creation_parameters.cpp:115
SurfaceCreationParameters & with_input_mode(input::InputReceptionMode const &new_mode)
Definition: surface_creation_parameters.cpp:87
Definition: point.h:30
MirPixelFormat pixel_format
Definition: surface_creation_parameters.h:82
mir::optional_value< shell::SurfaceAspectRatio > max_aspect
Definition: surface_creation_parameters.h:104
bool operator==(const SurfaceCreationParameters &lhs, const SurfaceCreationParameters &rhs)
Definition: surface_creation_parameters.cpp:145
SurfaceCreationParameters & with_output_id(graphics::DisplayConfigurationOutputId const &output_id)
Definition: surface_creation_parameters.cpp:94
scene::DepthId depth
Definition: surface_creation_parameters.h:83
mir::optional_value< MirSurfaceType > type
Definition: surface_creation_parameters.h:88
SurfaceCreationParameters & with_state(MirSurfaceState state)
Definition: surface_creation_parameters.cpp:109
SurfaceCreationParameters & with_edge_attachment(MirEdgeAttachment edge)
Definition: surface_creation_parameters.cpp:133
mir::optional_value< geometry::Rectangle > aux_rect
Definition: surface_creation_parameters.h:92
geometry::Point top_left
Definition: surface_creation_parameters.h:80
optional_value< geometry::Height > min_height
Definition: surface_creation_parameters.h:98
SurfaceCreationParameters a_surface()
Definition: surface_creation_parameters.cpp:171
SurfaceCreationParameters & of_name(std::string const &new_name)
Definition: surface_creation_parameters.cpp:34
mir::optional_value< frontend::BufferStreamId > content_id
Definition: surface_creation_parameters.h:91
SurfaceCreationParameters & of_depth(scene::DepthId const &new_depth)
Definition: surface_creation_parameters.cpp:79
SurfaceCreationParameters()
Definition: surface_creation_parameters.cpp:27
SurfaceCreationParameters & with_aux_rect(geometry::Rectangle const &rect)
Definition: surface_creation_parameters.cpp:127
SurfaceCreationParameters & of_position(geometry::Point const &top_left)
Definition: surface_creation_parameters.cpp:56
unsigned int width
Definition: black_arrow.c:4
MirSurfaceState
Definition: common.h:64
BufferUsage
How a buffer is going to be used.
Definition: buffer_properties.h:36
graphics::BufferUsage buffer_usage
Definition: surface_creation_parameters.h:81
optional_value< geometry::Height > max_height
Definition: surface_creation_parameters.h:100
mir::optional_value< std::vector< geometry::Rectangle > > input_shape
Definition: surface_creation_parameters.h:106
SurfaceCreationParameters & with_buffer_stream(frontend::BufferStreamId const &id)
Definition: surface_creation_parameters.cpp:139
graphics::DisplayConfigurationOutputId output_id
Definition: surface_creation_parameters.h:85
MirSurfaceType
Definition: common.h:48
MirPixelFormat
32-bit pixel formats (8888): The order of components in the enum matches the order of the components ...
Definition: common.h:134
bool operator!=(const SurfaceCreationParameters &lhs, const SurfaceCreationParameters &rhs)
Definition: surface_creation_parameters.cpp:164
SurfaceCreationParameters & of_buffer_usage(graphics::BufferUsage new_buffer_usage)
Definition: surface_creation_parameters.cpp:63
unsigned int height
Definition: black_arrow.c:5
mir::optional_value< frontend::SurfaceId > parent_id
Definition: surface_creation_parameters.h:90
Definition: surface_creation_parameters.h:42
SurfaceCreationParameters & of_pixel_format(MirPixelFormat new_pixel_format)
Definition: surface_creation_parameters.cpp:71
Definition: rectangle.h:33
std::weak_ptr< Surface > parent
Definition: surface_creation_parameters.h:95
mir::optional_value< geometry::DeltaX > width_inc
Definition: surface_creation_parameters.h:101
optional_value< geometry::Width > min_width
Definition: surface_creation_parameters.h:97
MirOrientationMode
Definition: common.h:172
InputReceptionMode
Definition: input_reception_mode.h:27
optional_value< geometry::Width > max_width
Definition: surface_creation_parameters.h:99
SurfaceCreationParameters & with_parent_id(frontend::SurfaceId const &id)
Definition: surface_creation_parameters.cpp:121
MirEdgeAttachment
Definition: common.h:186
mir::optional_value< shell::SurfaceAspectRatio > min_aspect
Definition: surface_creation_parameters.h:103

Copyright © 2012-2015 Canonical Ltd.
Generated on Thu Oct 8 16:20:16 UTC 2015