Mir
common.h
Go to the documentation of this file.
1 /*
2  * Simple definitions common to client and server.
3  *
4  * Copyright © 2013-2016 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 2 or 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 
25 
26 //for clang
27 #ifndef __has_feature
28  #define __has_feature(x) 0 // Compatibility with non-clang
29 #endif
30 
31 //for clang
32 #ifndef __has_extension
33  #define __has_extension __has_feature // Compatibility with pre-3.0
34 #endif
35 
36 #if __GNUC__ >= 6 || \
37  (__has_extension(attribute_deprecated_with_message) && \
38  __has_extension(enumerator_attributes))
39  #define MIR_DEPRECATED_ENUM(ENUM, INSTEAD) \
40  ENUM MIR_FOR_REMOVAL_IN_VERSION_1("Use " #INSTEAD " instead")
41 #else
42  #define MIR_DEPRECATED_ENUM(ENUM, INSTEAD) \
43  ENUM
44 #endif
45 
49 /* This is C code. Not C++. */
50 
55 typedef enum MirSurfaceAttrib
56 {
57  /* Do not specify values...code relies on 0...N ordering. */
68  /* Must be last */
70 } MirSurfaceAttrib MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowAttrib");
71 
76 typedef enum MirWindowAttrib
77 {
78  /* Do not specify values...code relies on 0...N ordering. */
89  /* Must be last */
92 
93 typedef enum MirSurfaceType
94 {
107 } MirSurfaceType MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowType");
108 
109 typedef enum MirWindowType
110 {
122 } MirWindowType;
123 
124 typedef enum MirSurfaceState
125 {
131  /* mir_surface_state_semimaximized,
132  Omitted for now, since it's functionally a subset of vertmaximized and
133  differs only in the X coordinate. */
139 } MirSurfaceState MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowState");
140 
141 typedef enum MirWindowState
142 {
148  /* mir_window_state_semimaximized,
149  Omitted for now, since it's functionally a subset of vertmaximized and
150  differs only in the X coordinate. */
157 
159 {
162 } MirSurfaceFocusState MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowFocusState");
163 
165 {
169 
171 {
174 } MirSurfaceVisibility MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowFocusState");
175 
177 {
181 
182 typedef enum MirLifecycleState
183 {
188 
189 typedef enum MirPowerMode
190 {
191  mir_power_mode_on, /* Display in use. */
192  mir_power_mode_standby, /* Blanked, low power. */
193  mir_power_mode_suspend, /* Blanked, lowest power. */
194  mir_power_mode_off /* Powered down. */
195 } MirPowerMode;
196 
197 typedef enum MirOutputType
198 {
199  mir_output_type_unknown = 0, /* DRM_MODE_CONNECTOR_Unknown */
200  mir_output_type_vga = 1, /* DRM_MODE_CONNECTOR_VGA */
201  mir_output_type_dvii = 2, /* DRM_MODE_CONNECTOR_DVII */
202  mir_output_type_dvid = 3, /* DRM_MODE_CONNECTOR_DVID */
203  mir_output_type_dvia = 4, /* DRM_MODE_CONNECTOR_DVIA */
204  mir_output_type_composite = 5, /* DRM_MODE_CONNECTOR_Composite */
205  mir_output_type_svideo = 6, /* DRM_MODE_CONNECTOR_SVIDEO */
206  mir_output_type_lvds = 7, /* DRM_MODE_CONNECTOR_LVDS */
207  mir_output_type_component = 8, /* DRM_MODE_CONNECTOR_Component */
208  mir_output_type_ninepindin = 9, /* DRM_MODE_CONNECTOR_9PinDIN */
209  mir_output_type_displayport = 10, /* DRM_MODE_CONNECTOR_DisplayPort */
210  mir_output_type_hdmia = 11, /* DRM_MODE_CONNECTOR_HDMIA */
211  mir_output_type_hdmib = 12, /* DRM_MODE_CONNECTOR_HDMIB */
212  mir_output_type_tv = 13, /* DRM_MODE_CONNECTOR_TV */
213  mir_output_type_edp = 14, /* DRM_MODE_CONNECTOR_eDP */
214  mir_output_type_virtual = 15, /* DRM_MODE_CONNECTOR_VIRTUAL */
215  mir_output_type_dsi = 16, /* DRM_MODE_CONNECTOR_DSI */
216  mir_output_type_dpi = 17, /* DRM_MODE_CONNECTOR_DPI */
217 } MirOutputType;
218 
220 {
225 
244 typedef enum MirPixelFormat
245 {
257  /*
258  * TODO: Big endian support would require additional formats in order to
259  * composite software surfaces using OpenGL (GL_RGBA/GL_BGRA_EXT):
260  * mir_pixel_format_rgb[ax]_8888
261  * mir_pixel_format_bgr[ax]_8888
262  */
263  mir_pixel_formats /* Note: This is always max format + 1 */
265 
266 /* This could be improved... https://bugs.launchpad.net/mir/+bug/1236254 */
267 #define MIR_BYTES_PER_PIXEL(f) ((f) == mir_pixel_format_bgr_888 ? 3 : \
268  (f) == mir_pixel_format_rgb_888 ? 3 : \
269  (f) == mir_pixel_format_rgb_565 ? 2 : \
270  (f) == mir_pixel_format_rgba_5551 ? 2 : \
271  (f) == mir_pixel_format_rgba_4444 ? 2 : \
272  4)
273 
275 typedef enum MirOrientation
276 {
282 
284 typedef enum MirMirrorMode
285 {
289 } MirMirrorMode;
290 
291 typedef enum MirOrientationMode
292 {
304 
305 typedef enum MirEdgeAttachment
306 {
312 
313 // Inspired by GdkGravity
319 {
322 
325 
328 
331 
334 
337 
340 
343 
347 
348 // Inspired by GdkAnchorHints
373 typedef enum MirPlacementHints
374 {
377 
380 
383 
386 
389 
392 
395 
398 
401 
405 
406 
413 typedef enum MirResizeEdge
414 {
424 } MirResizeEdge;
425 
429 typedef enum MirFormFactor
430 {
437 } MirFormFactor;
438 
439 
446 {
454 
458 typedef enum MirShellChrome
459 {
463 
468 #pragma GCC diagnostic push
469 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
471 {
473  MIR_DEPRECATED_ENUM(mir_pointer_confined_to_surface, "mir_pointer_confined_to_window"),
474  mir_pointer_confined_to_window = mir_pointer_confined_to_surface,
476 #pragma GCC diagnostic pop
477 
482 {
486 
494 typedef enum MirDepthLayer
495 {
502 } MirDepthLayer;
503 
504 
507 #endif
mir_surface_type_satellite
AKA "toolbox"/"toolbar".
Definition: common.h:47
Definition: common.h:86
the reference point is at the middle of the left edge.
Definition: common.h:324
Arrangement of subpixels cannot be determined.
Definition: common.h:447
Definition: common.h:474
allow resizing window on both axes
Definition: common.h:403
mir_surface_attrib_type
Definition: common.h:41
Definition: common.h:460
mir_surface_attribs
Definition: common.h:41
the reference point is at the lower left corner.
Definition: common.h:342
mir_surface_type_normal
AKA "regular".
Definition: common.h:40
allow sliding window horizontally
Definition: common.h:382
Definition: common.h:90
MirResizeEdge
Hints for resizing a window.
Definition: common.h:413
mir_surface_type_utility
AKA "floating".
Definition: common.h:40
#define MIR_DEPRECATED_ENUM(ENUM, INSTEAD)
Definition: common.h:42
For panels or other controls/decorations below normal windows.
Definition: common.h:497
Definition: common.h:178
Definition: common.h:415
Definition: common.h:204
Definition: common.h:152
Definition: common.h:120
Definition: common.h:85
Definition: common.h:483
mir_surface_type_popover
Definition: common.h:44
mir_surface_state_hidden
Definition: common.h:40
Definition: common.h:213
allow sliding window vertically
Definition: common.h:385
allow resizing window horizontally
Definition: common.h:388
Definition: common.h:216
mir_surface_type_tip
AKA "tooltip".
Definition: common.h:47
Used for panels, notifications and other windows attached to output edges.
Definition: common.h:154
Definition: common.h:433
allow flipping aux_anchor to opposite corner
Definition: common.h:394
the reference point is at the center.
Definition: common.h:321
MirPlacementHints
Positioning hints for aligning a window relative to a rectangle.
Definition: common.h:373
Definition: common.h:484
MirPromptSessionState
Definition: common.h:219
Definition: common.h:223
MirWindowAttrib
Attributes of a window that the client and server/shell may wish to get or set over the wire...
Definition: common.h:76
Definition: common.h:472
Definition: common.h:80
mir_surface_visibility_exposed
Definition: common.h:40
Definition: common.h:167
Definition: common.h:212
Definition: common.h:252
Definition: common.h:199
Definition: common.h:186
mir_surface_type_inputmethod
AKA "OSK" or handwriting etc.
Definition: common.h:47
Definition: common.h:200
AKA "floating".
Definition: common.h:112
Definition: common.h:185
MirWindowFocusState
Definition: common.h:164
Definition: common.h:143
Definition: common.h:113
Definition: common.h:184
mir_surface_type_gloss
Definition: common.h:44
MirWindowVisibility
Definition: common.h:176
MirPointerConfinementState
Pointer Confinement.
Definition: common.h:470
Definition: common.h:203
mir_surface_attrib_focus
Definition: common.h:41
AKA "regular".
Definition: common.h:111
Definition: common.h:416
Definition: common.h:256
Definition: common.h:194
Definition: common.h:221
mir_surface_type_overlay
Definition: common.h:40
mir_surface_state_vertmaximized
Definition: common.h:40
enum MirSurfaceAttrib MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowAttrib")
Attributes of a surface that the client and server/shell may wish to get or set over the wire...
Definition: common.h:246
Definition: common.h:207
For always-on-top application windows.
Definition: common.h:499
Definition: common.h:155
Definition: common.h:420
mir_surface_state_horizmaximized
Definition: common.h:40
Definition: common.h:307
Definition: common.h:277
AKA "OSK" or handwriting etc.
Definition: common.h:117
Definition: common.h:208
Definition: common.h:250
Definition: common.h:294
MirOrientation
Direction relative to the "natural" orientation of the display.
Definition: common.h:275
Definition: common.h:297
Definition: common.h:248
the reference point is at the middle of the lower edge.
Definition: common.h:333
MirSubpixelArrangement
Physical arrangement of subpixels on the physical output.
Definition: common.h:445
Definition: common.h:279
mir_surface_attrib_state
Definition: common.h:41
Definition: common.h:293
Definition: common.h:222
Definition: common.h:286
mir_surface_attrib_dpi
Definition: common.h:41
Subpixels are arranged vertically, R, G, B from top to bottom.
Definition: common.h:450
the reference point is in the middle of the top edge.
Definition: common.h:330
mir_surface_state_restored
Definition: common.h:40
Definition: common.h:280
Definition: common.h:193
Definition: common.h:461
Definition: common.h:255
MirSurfaceState
Definition: common.h:124
mir_surface_attrib_visibility
Definition: common.h:41
Definition: common.h:146
Definition: common.h:278
Definition: common.h:287
allow resizing window vertically
Definition: common.h:391
Definition: common.h:115
Definition: common.h:251
mir_surface_state_unknown
Definition: common.h:40
mir_surface_types
Definition: common.h:47
MirOutputGammaSupported
Supports gamma correction.
Definition: common.h:481
mir_surface_attrib_preferred_orientation
Definition: common.h:41
the reference point is at the top right corner.
Definition: common.h:339
Definition: common.h:263
Definition: common.h:435
For desktop backgrounds and alike (lowest layer)
Definition: common.h:496
Definition: common.h:147
Definition: common.h:87
Definition: common.h:422
Definition: common.h:79
MirWindowType
Definition: common.h:109
MirMirrorMode
Mirroring axis relative to the "natural" orientation of the display.
Definition: common.h:284
Definition: common.h:254
For panels or notifications that want to be above normal windows.
Definition: common.h:500
MirPowerMode
Definition: common.h:189
Definition: common.h:144
the reference point is at the top left corner.
Definition: common.h:336
the reference point is at the lower right corner.
Definition: common.h:345
Definition: common.h:418
MirSurfaceAttrib
Attributes of a surface that the client and server/shell may wish to get or set over the wire...
Definition: common.h:55
mir_surface_states
Definition: common.h:40
Definition: common.h:206
MirSurfaceType
Definition: common.h:93
mir_surface_type_menu
Definition: common.h:47
mir_surface_state_attached
Used for panels, notifications and other windows attached to output edges.
Definition: common.h:40
Definition: common.h:249
MirDepthLayer
Depth layer controls Z ordering of surfaces.
Definition: common.h:494
Definition: common.h:192
MirFormFactor
Form factor associated with a physical output.
Definition: common.h:429
Definition: common.h:436
MirPixelFormat
32-bit pixel formats (8888): The order of components in the enum matches the order of the components ...
Definition: common.h:244
MirLifecycleState
Definition: common.h:182
Definition: common.h:288
MirSurfaceFocusState
Definition: common.h:158
MirSurfaceVisibility
Definition: common.h:170
Definition: common.h:202
allow flipping anchors horizontally
Definition: common.h:376
Definition: common.h:166
Definition: common.h:431
For overlays such as lock screens (heighest layer)
Definition: common.h:501
Definition: common.h:419
MirShellChrome
Shell chrome.
Definition: common.h:458
mir_surface_unfocused
Definition: common.h:40
Definition: common.h:434
Definition: common.h:145
Definition: common.h:247
Definition: common.h:299
Device does not have regular subpixels.
Definition: common.h:452
mir_surface_type_freestyle
Definition: common.h:44
mir_surface_state_maximized
Definition: common.h:40
Definition: common.h:114
Definition: common.h:205
Definition: common.h:121
allow sliding window on both axes
Definition: common.h:400
Definition: common.h:201
Definition: common.h:209
Definition: common.h:308
mir_surface_type_dialog
Definition: common.h:40
Definition: common.h:253
Definition: common.h:301
allow flipping anchors vertically
Definition: common.h:379
Definition: common.h:210
Definition: common.h:423
mir_surface_focused
Definition: common.h:40
AKA "tooltip".
Definition: common.h:119
MirOrientationMode
Definition: common.h:291
Definition: common.h:421
Definition: common.h:191
MirWindowState
Definition: common.h:141
MirOutputType
Definition: common.h:197
Definition: common.h:151
the reference point is at the middle of the right edge.
Definition: common.h:327
Definition: common.h:211
Definition: common.h:179
Definition: common.h:215
Definition: common.h:153
AKA "toolbox"/"toolbar".
Definition: common.h:118
Definition: common.h:432
Definition: common.h:81
Subpixels are arranged vertically, B, G, R from top to bottom.
Definition: common.h:451
mir_surface_attrib_swapinterval
Definition: common.h:41
mir_surface_visibility_occluded
Definition: common.h:40
Definition: common.h:417
For normal application windows.
Definition: common.h:498
Definition: common.h:309
allow flipping anchors on both axes
Definition: common.h:397
Definition: common.h:214
mir_surface_state_fullscreen
Definition: common.h:40
Subpixels are arranged horizontally, R, G, B from left to right.
Definition: common.h:448
MirPlacementGravity
Reference point for aligning a surface relative to a rectangle.
Definition: common.h:318
Definition: common.h:116
Subpixels are arranged horizontally, B, G, R from left to right.
Definition: common.h:449
MirEdgeAttachment
Definition: common.h:305
mir_surface_state_minimized
Definition: common.h:40

Copyright © 2012-2021 Canonical Ltd.
Generated on Wed Mar 31 14:57:31 UTC 2021
This documentation is licensed under the GPL version 2 or 3.