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"
31 
32 #include <memory>
33 #include <string>
34 
35 namespace mir
36 {
37 namespace scene
38 {
39 class Surface;
40 
42 {
44 
46 
48 
50 
52 
54 
56 
58 
60 
62 
64 
66 
68 
70 
72 
74 
83 
90 
91  std::weak_ptr<Surface> parent;
92 };
93 
96 
98 }
99 }
100 
101 #endif /* MIR_SCENE_SURFACE_CREATION_PARAMETERS_H_ */
Definition: size.h:30
SurfaceCreationParameters & of_size(geometry::Size new_size)
Definition: surface_creation_parameters.cpp:41
All things Mir.
Definition: buffer_stream.h:37
mir::optional_value< MirSurfaceState > state
Definition: surface_creation_parameters.h:84
SurfaceCreationParameters & of_type(MirSurfaceType type)
Definition: surface_creation_parameters.cpp:103
input::InputReceptionMode input_mode
Definition: surface_creation_parameters.h:81
mir::optional_value< MirOrientationMode > preferred_orientation
Definition: surface_creation_parameters.h:86
geometry::Size size
Definition: surface_creation_parameters.h:76
std::string name
Definition: surface_creation_parameters.h:75
mir::optional_value< MirEdgeAttachment > edge_attachment
Definition: surface_creation_parameters.h:89
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:79
bool operator==(const SurfaceCreationParameters &lhs, const SurfaceCreationParameters &rhs)
Definition: surface_creation_parameters.cpp:139
SurfaceCreationParameters & with_output_id(graphics::DisplayConfigurationOutputId const &output_id)
Definition: surface_creation_parameters.cpp:94
scene::DepthId depth
Definition: surface_creation_parameters.h:80
mir::optional_value< MirSurfaceType > type
Definition: surface_creation_parameters.h:85
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:88
geometry::Point top_left
Definition: surface_creation_parameters.h:77
SurfaceCreationParameters a_surface()
Definition: surface_creation_parameters.cpp:164
SurfaceCreationParameters & of_name(std::string const &new_name)
Definition: surface_creation_parameters.cpp:34
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:66
BufferUsage
How a buffer is going to be used.
Definition: buffer_properties.h:36
graphics::BufferUsage buffer_usage
Definition: surface_creation_parameters.h:78
graphics::DisplayConfigurationOutputId output_id
Definition: surface_creation_parameters.h:82
MirSurfaceType
Definition: common.h:50
MirPixelFormat
The order of components in a format enum matches the order of the components as they would be written...
Definition: common.h:127
bool operator!=(const SurfaceCreationParameters &lhs, const SurfaceCreationParameters &rhs)
Definition: surface_creation_parameters.cpp:157
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:87
Definition: surface_creation_parameters.h:41
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:91
MirOrientationMode
Definition: common.h:150
InputReceptionMode
Definition: input_reception_mode.h:27
SurfaceCreationParameters & with_parent_id(frontend::SurfaceId const &id)
Definition: surface_creation_parameters.cpp:121
MirEdgeAttachment
Definition: common.h:164

Copyright © 2012,2013 Canonical Ltd.
Generated on Tue Mar 24 16:15:19 UTC 2015