Mir
Macros | Typedefs | Enumerations | Functions | Variables
common.h File Reference
#include <mir_toolkit/deprecations.h>
Include dependency graph for common.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define __has_feature(x)   0
 
#define __has_extension   __has_feature
 
#define MIR_DEPRECATED_ENUM(ENUM, INSTEAD)   ENUM
 
#define MIR_BYTES_PER_PIXEL(f)
 

Typedefs

typedef enum MirWindowAttrib MirWindowAttrib
 Attributes of a window that the client and server/shell may wish to get or set over the wire. More...
 
typedef enum MirWindowType MirWindowType
 
typedef enum MirWindowState MirWindowState
 
typedef enum MirWindowFocusState MirWindowFocusState
 
typedef enum MirWindowVisibility MirWindowVisibility
 
typedef enum MirLifecycleState MirLifecycleState
 
typedef enum MirPowerMode MirPowerMode
 
typedef enum MirOutputType MirOutputType
 
typedef enum MirPromptSessionState MirPromptSessionState
 
typedef enum MirPixelFormat MirPixelFormat
 32-bit pixel formats (8888): The order of components in the enum matches the order of the components as they would be written in an integer representing a pixel value of that format. More...
 
typedef enum MirOrientation MirOrientation
 Direction relative to the "natural" orientation of the display. More...
 
typedef enum MirMirrorMode MirMirrorMode
 Mirroring axis relative to the "natural" orientation of the display. More...
 
typedef enum MirOrientationMode MirOrientationMode
 
typedef enum MirEdgeAttachment MirEdgeAttachment
 
typedef enum MirPlacementGravity MirPlacementGravity
 Reference point for aligning a surface relative to a rectangle. More...
 
typedef enum MirPlacementHints MirPlacementHints
 Positioning hints for aligning a window relative to a rectangle. More...
 
typedef enum MirResizeEdge MirResizeEdge
 Hints for resizing a window. More...
 
typedef enum MirFormFactor MirFormFactor
 Form factor associated with a physical output. More...
 
typedef enum MirSubpixelArrangement MirSubpixelArrangement
 Physical arrangement of subpixels on the physical output. More...
 
typedef enum MirShellChrome MirShellChrome
 Shell chrome. More...
 
typedef enum MirPointerConfinementState MirPointerConfinementState
 Pointer Confinement. More...
 
typedef enum MirOutputGammaSupported MirOutputGammaSupported
 Supports gamma correction. More...
 

Enumerations

enum  MirSurfaceAttrib
 Attributes of a surface that the client and server/shell may wish to get or set over the wire. More...
 
enum  MirWindowAttrib {
  mir_window_attrib_type, mir_window_attrib_state, mir_window_attrib_swapinterval, mir_window_attrib_focus,
  mir_window_attrib_dpi, mir_window_attrib_visibility, mir_window_attrib_preferred_orientation, mir_window_attribs
}
 Attributes of a window that the client and server/shell may wish to get or set over the wire. More...
 
enum  MirSurfaceType
 
enum  MirWindowType {
  mir_window_type_normal, mir_window_type_utility, mir_window_type_dialog, mir_window_type_gloss,
  mir_window_type_freestyle, mir_window_type_menu, mir_window_type_inputmethod, mir_window_type_satellite,
  mir_window_type_tip, mir_window_types
}
 
enum  MirSurfaceState
 
enum  MirWindowState {
  mir_window_state_unknown, mir_window_state_restored, mir_window_state_minimized, mir_window_state_maximized,
  mir_window_state_vertmaximized, mir_window_state_fullscreen, mir_window_state_horizmaximized, mir_window_state_hidden,
  mir_window_states
}
 
enum  MirSurfaceFocusState
 
enum  MirWindowFocusState { mir_window_focus_state_unfocused = 0, mir_window_focus_state_focused }
 
enum  MirSurfaceVisibility
 
enum  MirWindowVisibility { mir_window_visibility_occluded = 0, mir_window_visibility_exposed }
 
enum  MirLifecycleState { mir_lifecycle_state_will_suspend, mir_lifecycle_state_resumed, mir_lifecycle_connection_lost }
 
enum  MirPowerMode { mir_power_mode_on, mir_power_mode_standby, mir_power_mode_suspend, mir_power_mode_off }
 
enum  MirOutputType {
  mir_output_type_unknown = 0, mir_output_type_vga = 1, mir_output_type_dvii = 2, mir_output_type_dvid = 3,
  mir_output_type_dvia = 4, mir_output_type_composite = 5, mir_output_type_svideo = 6, mir_output_type_lvds = 7,
  mir_output_type_component = 8, mir_output_type_ninepindin = 9, mir_output_type_displayport = 10, mir_output_type_hdmia = 11,
  mir_output_type_hdmib = 12, mir_output_type_tv = 13, mir_output_type_edp = 14, mir_output_type_virtual = 15,
  mir_output_type_dsi = 16, mir_output_type_dpi = 17
}
 
enum  MirPromptSessionState { mir_prompt_session_state_stopped = 0, mir_prompt_session_state_started, mir_prompt_session_state_suspended }
 
enum  MirPixelFormat {
  mir_pixel_format_invalid = 0, mir_pixel_format_abgr_8888 = 1, mir_pixel_format_xbgr_8888 = 2, mir_pixel_format_argb_8888 = 3,
  mir_pixel_format_xrgb_8888 = 4, mir_pixel_format_bgr_888 = 5, mir_pixel_format_rgb_888 = 6, mir_pixel_format_rgb_565 = 7,
  mir_pixel_format_rgba_5551 = 8, mir_pixel_format_rgba_4444 = 9, mir_pixel_formats
}
 32-bit pixel formats (8888): The order of components in the enum matches the order of the components as they would be written in an integer representing a pixel value of that format. More...
 
enum  MirOrientation { mir_orientation_normal = 0, mir_orientation_left = 90, mir_orientation_inverted = 180, mir_orientation_right = 270 }
 Direction relative to the "natural" orientation of the display. More...
 
enum  MirMirrorMode { mir_mirror_mode_none, mir_mirror_mode_vertical, mir_mirror_mode_horizontal }
 Mirroring axis relative to the "natural" orientation of the display. More...
 
enum  MirOrientationMode {
  mir_orientation_mode_portrait = 1 << 0, mir_orientation_mode_landscape = 1 << 1, mir_orientation_mode_portrait_inverted = 1 << 2, mir_orientation_mode_landscape_inverted = 1 << 3,
  mir_orientation_mode_portrait_any, mir_orientation_mode_landscape_any, mir_orientation_mode_any
}
 
enum  MirEdgeAttachment { mir_edge_attachment_vertical = 1 << 0, mir_edge_attachment_horizontal = 1 << 1, mir_edge_attachment_any }
 
enum  MirPlacementGravity {
  mir_placement_gravity_center = 0, mir_placement_gravity_west = 1 << 0, mir_placement_gravity_east = 1 << 1, mir_placement_gravity_north = 1 << 2,
  mir_placement_gravity_south = 1 << 3, mir_placement_gravity_northwest = mir_placement_gravity_north | mir_placement_gravity_west, mir_placement_gravity_northeast = mir_placement_gravity_north | mir_placement_gravity_east, mir_placement_gravity_southwest = mir_placement_gravity_south | mir_placement_gravity_west,
  mir_placement_gravity_southeast = mir_placement_gravity_south | mir_placement_gravity_east
}
 Reference point for aligning a surface relative to a rectangle. More...
 
enum  MirPlacementHints {
  mir_placement_hints_flip_x = 1 << 0, mir_placement_hints_flip_y = 1 << 1, mir_placement_hints_slide_x = 1 << 2, mir_placement_hints_slide_y = 1 << 3,
  mir_placement_hints_resize_x = 1 << 4, mir_placement_hints_resize_y = 1 << 5, mir_placement_hints_antipodes = 1 << 6, mir_placement_hints_flip_any = mir_placement_hints_flip_x|mir_placement_hints_flip_y,
  mir_placement_hints_slide_any = mir_placement_hints_slide_x|mir_placement_hints_slide_y, mir_placement_hints_resize_any = mir_placement_hints_resize_x|mir_placement_hints_resize_y
}
 Positioning hints for aligning a window relative to a rectangle. More...
 
enum  MirResizeEdge {
  mir_resize_edge_none = 0, mir_resize_edge_west = 1 << 0, mir_resize_edge_east = 1 << 1, mir_resize_edge_north = 1 << 2,
  mir_resize_edge_south = 1 << 3, mir_resize_edge_northwest = mir_resize_edge_north | mir_resize_edge_west, mir_resize_edge_northeast = mir_resize_edge_north | mir_resize_edge_east, mir_resize_edge_southwest = mir_resize_edge_south | mir_resize_edge_west,
  mir_resize_edge_southeast = mir_resize_edge_south | mir_resize_edge_east
}
 Hints for resizing a window. More...
 
enum  MirFormFactor {
  mir_form_factor_unknown, mir_form_factor_phone, mir_form_factor_tablet, mir_form_factor_monitor,
  mir_form_factor_tv, mir_form_factor_projector
}
 Form factor associated with a physical output. More...
 
enum  MirSubpixelArrangement {
  mir_subpixel_arrangement_unknown, mir_subpixel_arrangement_horizontal_rgb, mir_subpixel_arrangement_horizontal_bgr, mir_subpixel_arrangement_vertical_rgb,
  mir_subpixel_arrangement_vertical_bgr, mir_subpixel_arrangement_none
}
 Physical arrangement of subpixels on the physical output. More...
 
enum  MirShellChrome { mir_shell_chrome_normal, mir_shell_chrome_low }
 Shell chrome. More...
 
enum  MirPointerConfinementState { mir_pointer_unconfined, MIR_DEPRECATED_ENUM =(mir_pointer_confined_to_surface, "mir_pointer_confined_to_window"), mir_pointer_confined_to_window = mir_pointer_confined_to_surface }
 Pointer Confinement. More...
 
enum  MirOutputGammaSupported { mir_output_gamma_unsupported, mir_output_gamma_supported }
 Supports gamma correction. More...
 

Functions

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. More...
 
enum MirSurfaceType MIR_FOR_REMOVAL_IN_VERSION_1 ("use MirWindowType")
 
enum MirSurfaceState MIR_FOR_REMOVAL_IN_VERSION_1 ("use MirWindowState")
 
enum MirSurfaceFocusState MIR_FOR_REMOVAL_IN_VERSION_1 ("use MirWindowFocusState")
 

Variables

 mir_surface_attrib_type
 
 mir_surface_attrib_state
 
 mir_surface_attrib_swapinterval
 
 mir_surface_attrib_focus
 
 mir_surface_attrib_dpi
 
 mir_surface_attrib_visibility
 
 mir_surface_attrib_preferred_orientation
 
 mir_surface_attribs
 
 mir_surface_type_normal
 AKA "regular". More...
 
 mir_surface_type_utility
 AKA "floating". More...
 
 mir_surface_type_dialog
 
 mir_surface_type_overlay
 
 mir_surface_type_gloss = mir_surface_type_overlay
 
 mir_surface_type_freestyle
 
 mir_surface_type_popover
 
 mir_surface_type_menu = mir_surface_type_popover
 
 mir_surface_type_inputmethod
 AKA "OSK" or handwriting etc. More...
 
 mir_surface_type_satellite
 AKA "toolbox"/"toolbar". More...
 
 mir_surface_type_tip
 AKA "tooltip". More...
 
 mir_surface_types
 
 mir_surface_state_unknown
 
 mir_surface_state_restored
 
 mir_surface_state_minimized
 
 mir_surface_state_maximized
 
 mir_surface_state_vertmaximized
 
 mir_surface_state_fullscreen
 
 mir_surface_state_horizmaximized
 
 mir_surface_state_hidden
 
 mir_surface_states
 
 mir_surface_unfocused = 0
 
 mir_surface_focused
 
 mir_surface_visibility_occluded = 0
 
 mir_surface_visibility_exposed
 

Macro Definition Documentation

◆ __has_extension

#define __has_extension   __has_feature

◆ __has_feature

#define __has_feature (   x)    0

◆ MIR_DEPRECATED_ENUM

#define MIR_DEPRECATED_ENUM (   ENUM,
  INSTEAD 
)    ENUM

Variable Documentation

◆ mir_surface_attrib_dpi

mir_surface_attrib_dpi

◆ mir_surface_attrib_focus

mir_surface_attrib_focus

◆ mir_surface_attrib_preferred_orientation

mir_surface_attrib_preferred_orientation

◆ mir_surface_attrib_state

mir_surface_attrib_state

◆ mir_surface_attrib_swapinterval

mir_surface_attrib_swapinterval
Deprecated:
Do not listen for events reporting this attribute.

Use the "mir_*_get_swapinterval()" functions instead if you wish query its value

Deprecated:
Do not listen for events reporting this attribute.

Use the "mir_*_get_swapinterval()" functions instead if you wish query its value

◆ mir_surface_attrib_type

mir_surface_attrib_type

◆ mir_surface_attrib_visibility

mir_surface_attrib_visibility

◆ mir_surface_attribs

mir_surface_attribs

◆ mir_surface_focused

mir_surface_focused

◆ mir_surface_state_fullscreen

mir_surface_state_fullscreen

◆ mir_surface_state_hidden

mir_surface_state_hidden

◆ mir_surface_state_horizmaximized

mir_surface_state_horizmaximized

◆ mir_surface_state_maximized

mir_surface_state_maximized

◆ mir_surface_state_minimized

mir_surface_state_minimized

◆ mir_surface_state_restored

mir_surface_state_restored

◆ mir_surface_state_unknown

mir_surface_state_unknown

◆ mir_surface_state_vertmaximized

mir_surface_state_vertmaximized

◆ mir_surface_states

mir_surface_states

◆ mir_surface_type_dialog

mir_surface_type_dialog

◆ mir_surface_type_freestyle

mir_surface_type_freestyle

◆ mir_surface_type_gloss

mir_surface_type_gloss = mir_surface_type_overlay

◆ mir_surface_type_inputmethod

mir_surface_type_inputmethod

AKA "OSK" or handwriting etc.

◆ mir_surface_type_menu

mir_surface_type_menu = mir_surface_type_popover

◆ mir_surface_type_normal

mir_surface_type_normal

AKA "regular".

◆ mir_surface_type_overlay

mir_surface_type_overlay
Deprecated:
Use "gloss" instead.
Deprecated:
Use "gloss" instead.

◆ mir_surface_type_popover

mir_surface_type_popover
Deprecated:
Choose "menu" or "tip"
Deprecated:
Choose "menu" or "tip"

◆ mir_surface_type_satellite

mir_surface_type_satellite

AKA "toolbox"/"toolbar".

◆ mir_surface_type_tip

mir_surface_type_tip

AKA "tooltip".

◆ mir_surface_type_utility

mir_surface_type_utility

AKA "floating".

◆ mir_surface_types

mir_surface_types

◆ mir_surface_unfocused

mir_surface_unfocused = 0

◆ mir_surface_visibility_exposed

mir_surface_visibility_exposed

◆ mir_surface_visibility_occluded

mir_surface_visibility_occluded = 0

Copyright © 2012-2018 Canonical Ltd.
Generated on Thu Apr 5 15:26:05 UTC 2018