Mir
Main Page
Related Pages
Modules
Namespaces
Classes
Files
Examples
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Modules
Pages
include
common
mir_toolkit
common.h
Go to the documentation of this file.
1
/*
2
* Simple definitions common to client and server.
3
*
4
* Copyright © 2013-2014 Canonical Ltd.
5
*
6
* This program is free software: you can redistribute it and/or modify
7
* it under the terms of the GNU Lesser General Public License version 3 as
8
* published by the Free Software Foundation.
9
*
10
* This program is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
* GNU Lesser General Public License for more details.
14
*
15
* You should have received a copy of the GNU Lesser General Public License
16
* along with this program. If not, see <http://www.gnu.org/licenses/>.
17
*
18
* Author: Daniel van Vugt <daniel.van.vugt@canonical.com>
19
*/
20
21
#ifndef MIR_COMMON_H_
22
#define MIR_COMMON_H_
23
24
#include <
mir_toolkit/cursors.h
>
25
30
/* This is C code. Not C++. */
31
36
typedef
enum
MirSurfaceAttrib
37
{
38
/* Do not specify values...code relies on 0...N ordering. */
39
mir_surface_attrib_type
,
40
mir_surface_attrib_state
,
41
mir_surface_attrib_swapinterval
,
42
mir_surface_attrib_focus
,
43
mir_surface_attrib_dpi
,
44
mir_surface_attrib_visibility
,
45
/* Must be last */
46
mir_surface_attribs
47
}
MirSurfaceAttrib
;
48
49
typedef
enum
MirSurfaceType
50
{
51
mir_surface_type_normal
,
52
mir_surface_type_utility
,
53
mir_surface_type_dialog
,
54
mir_surface_type_overlay
,
55
mir_surface_type_freestyle
,
56
mir_surface_type_popover
,
57
mir_surface_type_inputmethod
,
58
mir_surface_types
59
}
MirSurfaceType
;
60
61
typedef
enum
MirSurfaceState
62
{
63
mir_surface_state_unknown
,
64
mir_surface_state_restored
,
65
mir_surface_state_minimized
,
66
mir_surface_state_maximized
,
67
mir_surface_state_vertmaximized
,
68
/* mir_surface_state_semimaximized,
69
Omitted for now, since it's functionally a subset of vertmaximized and
70
differs only in the X coordinate. */
71
mir_surface_state_fullscreen
,
72
mir_surface_states
73
}
MirSurfaceState
;
74
75
/* TODO: MirSurfaceFocusState MirSurfaceVisibility and MirLifecycleState use an inconsistent
76
naming convention. */
77
typedef
enum
MirSurfaceFocusState
78
{
79
mir_surface_unfocused
= 0,
80
mir_surface_focused
81
}
MirSurfaceFocusState
;
82
83
typedef
enum
MirSurfaceVisibility
84
{
85
mir_surface_visibility_occluded
= 0,
86
mir_surface_visibility_exposed
87
}
MirSurfaceVisibility
;
88
89
typedef
enum
MirLifecycleState
90
{
91
mir_lifecycle_state_will_suspend
,
92
mir_lifecycle_state_resumed
,
93
mir_lifecycle_connection_lost
94
}
MirLifecycleState
;
95
96
typedef
enum
MirPowerMode
97
{
98
mir_power_mode_on
,
/* Display in use. */
99
mir_power_mode_standby
,
/* Blanked, low power. */
100
mir_power_mode_suspend
,
/* Blanked, lowest power. */
101
mir_power_mode_off
/* Powered down. */
102
}
MirPowerMode
;
103
104
typedef
enum
MirPromptSessionState
105
{
106
mir_prompt_session_state_stopped
= 0,
107
mir_prompt_session_state_started
108
}
MirPromptSessionState
;
109
119
typedef
enum
MirPixelFormat
120
{
121
mir_pixel_format_invalid
,
122
mir_pixel_format_abgr_8888
,
123
mir_pixel_format_xbgr_8888
,
124
mir_pixel_format_argb_8888
,
125
mir_pixel_format_xrgb_8888
,
126
mir_pixel_format_bgr_888
,
127
mir_pixel_formats
128
}
MirPixelFormat
;
129
130
/* This could be improved... https://bugs.launchpad.net/mir/+bug/1236254 */
131
#define MIR_BYTES_PER_PIXEL(f) (((f) == mir_pixel_format_bgr_888) ? 3 : 4)
132
134
typedef
enum
MirOrientation
135
{
136
mir_orientation_normal
= 0,
137
mir_orientation_left
= 90,
138
mir_orientation_inverted
= 180,
139
mir_orientation_right
= 270
140
}
MirOrientation
;
141
144
#endif
cursors.h
mir_surface_type_inputmethod
Definition:
common.h:57
mir_surface_attrib_state
Definition:
common.h:40
mir_surface_type_freestyle
Definition:
common.h:55
mir_surface_visibility_occluded
Definition:
common.h:85
mir_surface_state_maximized
Definition:
common.h:66
mir_surface_attribs
Definition:
common.h:46
mir_surface_attrib_visibility
Definition:
common.h:44
MirPromptSessionState
MirPromptSessionState
Definition:
common.h:104
mir_surface_attrib_focus
Definition:
common.h:42
mir_lifecycle_connection_lost
Definition:
common.h:93
mir_surface_type_dialog
Definition:
common.h:53
mir_surface_attrib_type
Definition:
common.h:39
mir_lifecycle_state_resumed
Definition:
common.h:92
mir_surface_state_fullscreen
Definition:
common.h:71
mir_lifecycle_state_will_suspend
Definition:
common.h:91
mir_surface_visibility_exposed
Definition:
common.h:86
mir_power_mode_off
Definition:
common.h:101
mir_prompt_session_state_stopped
Definition:
common.h:106
mir_surface_unfocused
Definition:
common.h:79
mir_pixel_format_invalid
Definition:
common.h:121
mir_orientation_normal
Definition:
common.h:136
mir_pixel_format_xrgb_8888
Definition:
common.h:125
MirOrientation
MirOrientation
Direction relative to the "natural" orientation of the display.
Definition:
common.h:134
mir_pixel_format_xbgr_8888
Definition:
common.h:123
mir_orientation_inverted
Definition:
common.h:138
mir_surface_state_vertmaximized
Definition:
common.h:67
mir_prompt_session_state_started
Definition:
common.h:107
mir_orientation_right
Definition:
common.h:139
mir_power_mode_suspend
Definition:
common.h:100
MirSurfaceState
MirSurfaceState
Definition:
common.h:61
mir_orientation_left
Definition:
common.h:137
mir_pixel_format_bgr_888
Definition:
common.h:126
mir_pixel_formats
Definition:
common.h:127
mir_surface_type_utility
Definition:
common.h:52
MirPowerMode
MirPowerMode
Definition:
common.h:96
MirSurfaceAttrib
MirSurfaceAttrib
Attributes of a surface that the client and server/shell may wish to get or set over the wire...
Definition:
common.h:36
mir_surface_types
Definition:
common.h:58
MirSurfaceType
MirSurfaceType
Definition:
common.h:49
mir_surface_type_overlay
Definition:
common.h:54
mir_pixel_format_argb_8888
Definition:
common.h:124
mir_power_mode_standby
Definition:
common.h:99
MirPixelFormat
MirPixelFormat
The order of components in a format enum matches the order of the components as they would be written...
Definition:
common.h:119
mir_surface_states
Definition:
common.h:72
MirLifecycleState
MirLifecycleState
Definition:
common.h:89
mir_surface_state_unknown
Definition:
common.h:63
MirSurfaceFocusState
MirSurfaceFocusState
Definition:
common.h:77
MirSurfaceVisibility
MirSurfaceVisibility
Definition:
common.h:83
mir_surface_type_popover
Definition:
common.h:56
mir_pixel_format_abgr_8888
Definition:
common.h:122
mir_surface_state_restored
Definition:
common.h:64
mir_surface_attrib_swapinterval
Definition:
common.h:41
mir_power_mode_on
Definition:
common.h:98
mir_surface_focused
Definition:
common.h:80
mir_surface_attrib_dpi
Definition:
common.h:43
mir_surface_type_normal
Definition:
common.h:51
mir_surface_state_minimized
Definition:
common.h:65
Copyright © 2012,2013 Canonical Ltd.
Generated on Fri Oct 10 14:07:14 UTC 2014