Skip to main content Module bindings Copy item path Source miracle_application_info_t Describes the properties of an application. miracle_container_t Describes a container in a tree. miracle_freestyle_placement_t Describes a freestyle placement which is fully controlled by the plugin. miracle_keyboard_event_t Describes a keyboard event. miracle_output_t Describes an output. miracle_placement_t miracle_plugin_animation_frame_data_t miracle_plugin_animation_frame_result_t miracle_point_t A 2D point with integer coordinates. miracle_pointer_event_t Describes a pointer event. miracle_size_t A size with integer dimensions. miracle_tiled_placement_t Describes a tiled placement which is controlled by the plugin system. miracle_window_info_t Describes the properties of a window. miracle_workspace_t Describes a workspace. MIRACLE_PLUGIN_VERSION MirDepthLayer_mir_depth_layer_above < For panels or notifications that want to be above normal windows MirDepthLayer_mir_depth_layer_always_on_top < For always-on-top application windows MirDepthLayer_mir_depth_layer_application < For normal application windows MirDepthLayer_mir_depth_layer_background < For desktop backgrounds and alike (lowest layer) MirDepthLayer_mir_depth_layer_below < For panels or other controls/decorations below normal windows MirDepthLayer_mir_depth_layer_overlay < For overlays such as lock screens (heighest layer) MirEdgeAttachment_mir_edge_attachment_any MirEdgeAttachment_mir_edge_attachment_horizontal MirEdgeAttachment_mir_edge_attachment_vertical MirEventType_mir_event_type_close_window MirEventType_mir_event_type_input MirEventType_mir_event_type_input_configuration MirEventType_mir_event_type_input_device_state MirEventType_mir_event_type_key MirEventType_mir_event_type_motion MirEventType_mir_event_type_orientation MirEventType_mir_event_type_prompt_session_state_change MirEventType_mir_event_type_resize MirEventType_mir_event_type_window MirEventType_mir_event_type_window_output MirEventType_mir_event_type_window_placement MirFocusMode_mir_focus_mode_disabled < The surface will never be given focus MirFocusMode_mir_focus_mode_focusable < The surface can gain and lose focus normally MirFocusMode_mir_focus_mode_grabbing < This mode causes the surface to take focus if possible, and prevents focus from
leaving it as long as it has this mode MirFormFactor_mir_form_factor_monitor MirFormFactor_mir_form_factor_phone MirFormFactor_mir_form_factor_projector MirFormFactor_mir_form_factor_tablet MirFormFactor_mir_form_factor_tv MirFormFactor_mir_form_factor_unknown MirInputEventModifier_mir_input_event_modifier_alt MirInputEventModifier_mir_input_event_modifier_alt_left MirInputEventModifier_mir_input_event_modifier_alt_right MirInputEventModifier_mir_input_event_modifier_caps_lock MirInputEventModifier_mir_input_event_modifier_ctrl MirInputEventModifier_mir_input_event_modifier_ctrl_left MirInputEventModifier_mir_input_event_modifier_ctrl_right MirInputEventModifier_mir_input_event_modifier_function MirInputEventModifier_mir_input_event_modifier_meta MirInputEventModifier_mir_input_event_modifier_meta_left MirInputEventModifier_mir_input_event_modifier_meta_right MirInputEventModifier_mir_input_event_modifier_none MirInputEventModifier_mir_input_event_modifier_num_lock MirInputEventModifier_mir_input_event_modifier_scroll_lock MirInputEventModifier_mir_input_event_modifier_shift MirInputEventModifier_mir_input_event_modifier_shift_left MirInputEventModifier_mir_input_event_modifier_shift_right MirInputEventModifier_mir_input_event_modifier_sym MirInputEventType_mir_input_event_type_key MirInputEventType_mir_input_event_type_keyboard_resync MirInputEventType_mir_input_event_type_pointer MirInputEventType_mir_input_event_type_touch MirInputEventType_mir_input_event_types MirKeyboardAction_mir_keyboard_action_down MirKeyboardAction_mir_keyboard_action_modifiers MirKeyboardAction_mir_keyboard_action_repeat MirKeyboardAction_mir_keyboard_action_up MirKeyboardAction_mir_keyboard_actions MirLifecycleState_mir_lifecycle_connection_lost MirLifecycleState_mir_lifecycle_state_resumed MirLifecycleState_mir_lifecycle_state_will_suspend MirMirrorMode_mir_mirror_mode_horizontal MirMirrorMode_mir_mirror_mode_none MirMirrorMode_mir_mirror_mode_vertical MirOrientationMode_mir_orientation_mode_any MirOrientationMode_mir_orientation_mode_landscape MirOrientationMode_mir_orientation_mode_landscape_any MirOrientationMode_mir_orientation_mode_landscape_inverted MirOrientationMode_mir_orientation_mode_portrait MirOrientationMode_mir_orientation_mode_portrait_any MirOrientationMode_mir_orientation_mode_portrait_inverted MirOrientation_mir_orientation_inverted MirOrientation_mir_orientation_left MirOrientation_mir_orientation_normal MirOrientation_mir_orientation_right MirOutputFilter_mir_output_filter_grayscale < Colors are converted to grayscale MirOutputFilter_mir_output_filter_invert < Colors are inverted MirOutputFilter_mir_output_filter_none < No filter applied MirOutputGammaSupported_mir_output_gamma_supported MirOutputGammaSupported_mir_output_gamma_unsupported MirOutputType_mir_output_type_component MirOutputType_mir_output_type_composite MirOutputType_mir_output_type_displayport MirOutputType_mir_output_type_dpi MirOutputType_mir_output_type_dsi MirOutputType_mir_output_type_dvia MirOutputType_mir_output_type_dvid MirOutputType_mir_output_type_dvii MirOutputType_mir_output_type_edp MirOutputType_mir_output_type_hdmia MirOutputType_mir_output_type_hdmib MirOutputType_mir_output_type_lvds MirOutputType_mir_output_type_ninepindin MirOutputType_mir_output_type_svideo MirOutputType_mir_output_type_tv MirOutputType_mir_output_type_unknown MirOutputType_mir_output_type_vga MirOutputType_mir_output_type_virtual MirPixelFormat_mir_pixel_format_abgr_8888 MirPixelFormat_mir_pixel_format_argb_8888 MirPixelFormat_mir_pixel_format_bgr_888 MirPixelFormat_mir_pixel_format_invalid MirPixelFormat_mir_pixel_format_rgb_565 MirPixelFormat_mir_pixel_format_rgb_888 MirPixelFormat_mir_pixel_format_rgba_4444 MirPixelFormat_mir_pixel_format_rgba_5551 MirPixelFormat_mir_pixel_format_xbgr_8888 MirPixelFormat_mir_pixel_format_xrgb_8888 MirPixelFormat_mir_pixel_formats MirPlacementGravity_mir_placement_gravity_center the reference point is at the center. MirPlacementGravity_mir_placement_gravity_east the reference point is at the middle of the right edge. MirPlacementGravity_mir_placement_gravity_north the reference point is in the middle of the top edge. MirPlacementGravity_mir_placement_gravity_northeast the reference point is at the top right corner. MirPlacementGravity_mir_placement_gravity_northwest the reference point is at the top left corner. MirPlacementGravity_mir_placement_gravity_south the reference point is at the middle of the lower edge. MirPlacementGravity_mir_placement_gravity_southeast the reference point is at the lower right corner. MirPlacementGravity_mir_placement_gravity_southwest the reference point is at the lower left corner. MirPlacementGravity_mir_placement_gravity_west the reference point is at the middle of the left edge. MirPlacementHints_mir_placement_hints_antipodes allow flipping aux_anchor to opposite corner MirPlacementHints_mir_placement_hints_flip_any allow flipping anchors on both axes MirPlacementHints_mir_placement_hints_flip_x allow flipping anchors horizontally MirPlacementHints_mir_placement_hints_flip_y allow flipping anchors vertically MirPlacementHints_mir_placement_hints_resize_any allow resizing window on both axes MirPlacementHints_mir_placement_hints_resize_x allow resizing window horizontally MirPlacementHints_mir_placement_hints_resize_y allow resizing window vertically MirPlacementHints_mir_placement_hints_slide_any allow sliding window on both axes MirPlacementHints_mir_placement_hints_slide_x allow sliding window horizontally MirPlacementHints_mir_placement_hints_slide_y allow sliding window vertically MirPointerAction_mir_pointer_action_button_down MirPointerAction_mir_pointer_action_button_up MirPointerAction_mir_pointer_action_enter MirPointerAction_mir_pointer_action_leave MirPointerAction_mir_pointer_action_motion MirPointerAction_mir_pointer_actions MirPointerAxisSource_mir_pointer_axis_source_continuous MirPointerAxisSource_mir_pointer_axis_source_finger MirPointerAxisSource_mir_pointer_axis_source_none MirPointerAxisSource_mir_pointer_axis_source_wheel MirPointerAxisSource_mir_pointer_axis_source_wheel_tilt MirPointerAxis_mir_pointer_axes MirPointerAxis_mir_pointer_axis_hscroll MirPointerAxis_mir_pointer_axis_hscroll_discrete MirPointerAxis_mir_pointer_axis_hscroll_value120 MirPointerAxis_mir_pointer_axis_relative_x MirPointerAxis_mir_pointer_axis_relative_y MirPointerAxis_mir_pointer_axis_vscroll MirPointerAxis_mir_pointer_axis_vscroll_discrete MirPointerAxis_mir_pointer_axis_vscroll_value120 MirPointerAxis_mir_pointer_axis_x MirPointerAxis_mir_pointer_axis_y MirPointerButton_mir_pointer_button_back MirPointerButton_mir_pointer_button_extra MirPointerButton_mir_pointer_button_forward MirPointerButton_mir_pointer_button_primary MirPointerButton_mir_pointer_button_secondary MirPointerButton_mir_pointer_button_side MirPointerButton_mir_pointer_button_task MirPointerButton_mir_pointer_button_tertiary MirPointerConfinementState_mir_pointer_confined_oneshot MirPointerConfinementState_mir_pointer_confined_persistent MirPointerConfinementState_mir_pointer_locked_oneshot MirPointerConfinementState_mir_pointer_locked_persistent MirPointerConfinementState_mir_pointer_unconfined MirPowerMode_mir_power_mode_off MirPowerMode_mir_power_mode_on MirPowerMode_mir_power_mode_standby MirPowerMode_mir_power_mode_suspend MirPromptSessionState_mir_prompt_session_state_started MirPromptSessionState_mir_prompt_session_state_stopped MirPromptSessionState_mir_prompt_session_state_suspended MirResizeEdge_mir_resize_edge_east MirResizeEdge_mir_resize_edge_none MirResizeEdge_mir_resize_edge_north MirResizeEdge_mir_resize_edge_northeast MirResizeEdge_mir_resize_edge_northwest MirResizeEdge_mir_resize_edge_south MirResizeEdge_mir_resize_edge_southeast MirResizeEdge_mir_resize_edge_southwest MirResizeEdge_mir_resize_edge_west MirShellChrome_mir_shell_chrome_low MirShellChrome_mir_shell_chrome_normal MirSubpixelArrangement_mir_subpixel_arrangement_horizontal_bgr < Subpixels are arranged horizontally, B, G, R from left to right MirSubpixelArrangement_mir_subpixel_arrangement_horizontal_rgb < Subpixels are arranged horizontally, R, G, B from left to right MirSubpixelArrangement_mir_subpixel_arrangement_none < Device does not have regular subpixels MirSubpixelArrangement_mir_subpixel_arrangement_unknown < Arrangement of subpixels cannot be determined MirSubpixelArrangement_mir_subpixel_arrangement_vertical_bgr < Subpixels are arranged vertically, B, G, R from top to bottom MirSubpixelArrangement_mir_subpixel_arrangement_vertical_rgb < Subpixels are arranged vertically, R, G, B from top to bottom MirTiledEdge_mir_tiled_edge_east MirTiledEdge_mir_tiled_edge_none MirTiledEdge_mir_tiled_edge_north MirTiledEdge_mir_tiled_edge_south MirTiledEdge_mir_tiled_edge_west MirTouchAction_mir_touch_action_change MirTouchAction_mir_touch_action_down MirTouchAction_mir_touch_action_up MirTouchAction_mir_touch_actions MirTouchAxis_mir_touch_axes MirTouchAxis_mir_touch_axis_pressure MirTouchAxis_mir_touch_axis_size MirTouchAxis_mir_touch_axis_touch_major MirTouchAxis_mir_touch_axis_touch_minor MirTouchAxis_mir_touch_axis_x MirTouchAxis_mir_touch_axis_y MirTouchTooltype_mir_touch_tooltype_finger MirTouchTooltype_mir_touch_tooltype_stylus MirTouchTooltype_mir_touch_tooltype_unknown MirTouchTooltype_mir_touch_tooltypes MirWindowAttrib_mir_window_attrib_dpi MirWindowAttrib_mir_window_attrib_focus MirWindowAttrib_mir_window_attrib_preferred_orientation MirWindowAttrib_mir_window_attrib_state MirWindowAttrib_mir_window_attrib_type MirWindowAttrib_mir_window_attrib_visibility MirWindowAttrib_mir_window_attribs MirWindowFocusState_mir_window_focus_state_active < Active but does not have keyboard focus MirWindowFocusState_mir_window_focus_state_focused < Active and has keybaord focus MirWindowFocusState_mir_window_focus_state_unfocused < Inactive and does not have focus MirWindowState_mir_window_state_attached < Used for panels, notifications and other windows attached to output edges MirWindowState_mir_window_state_fullscreen MirWindowState_mir_window_state_hidden MirWindowState_mir_window_state_horizmaximized MirWindowState_mir_window_state_maximized MirWindowState_mir_window_state_minimized MirWindowState_mir_window_state_restored MirWindowState_mir_window_state_unknown MirWindowState_mir_window_state_vertmaximized MirWindowState_mir_window_states MirWindowType_mir_window_type_decoration MirWindowType_mir_window_type_dialog MirWindowType_mir_window_type_freestyle MirWindowType_mir_window_type_gloss MirWindowType_mir_window_type_inputmethod < AKA “OSK” or handwriting etc. MirWindowType_mir_window_type_menu MirWindowType_mir_window_type_normal < AKA “regular” MirWindowType_mir_window_type_satellite < AKA “toolbox”/“toolbar” MirWindowType_mir_window_type_tip < AKA “tooltip” MirWindowType_mir_window_type_utility < AKA “floating” MirWindowType_mir_window_types MirWindowVisibility_mir_window_visibility_exposed MirWindowVisibility_mir_window_visibility_occluded miracle_animation_type_miracle_animation_type_window_close miracle_animation_type_miracle_animation_type_window_move miracle_animation_type_miracle_animation_type_window_none miracle_animation_type_miracle_animation_type_window_open miracle_animation_type_miracle_animation_type_workspace_switch miracle_container_type_miracle_container_type_parent The container has multiple children in it. miracle_container_type_miracle_container_type_window The container has a single window in it. miracle_layout_scheme_miracle_layout_scheme_horizontal A horizontal layout. miracle_layout_scheme_miracle_layout_scheme_none None layout. miracle_layout_scheme_miracle_layout_scheme_stacking A stacked layout. miracle_layout_scheme_miracle_layout_scheme_tabbed A tabbed layout. miracle_layout_scheme_miracle_layout_scheme_vertical A vertical layout. miracle_window_management_strategy_t_miracle_window_management_strategy_freestyle Describes a window whose behavior is entirely determined by
the plugin. miracle_window_management_strategy_t_miracle_window_management_strategy_system If selected, the plugin lets miracle place the window according
to its own strategy. miracle_window_management_strategy_t_miracle_window_management_strategy_tiled Describes a window that will be placed in the tiling grid. MirDepthLayer Depth layer controls Z ordering of surfaces. MirEdgeAttachment MirEventType MirFocusMode Focus mode controls how a surface gains and loses focus. MirFormFactor Form factor associated with a physical output MirInputEventModifier Description of key modifier state. MirInputEventModifiers MirInputEventType MirKeyboardAction Possible actions for changing key state MirLifecycleState MirMirrorMode Describes a mirror transformation that is applied to client surfaces. MirOrientation Describes transformations applied to both outputs and client surfaces.
Rotations are counter-clockwise. MirOrientationMode MirOutputFilter Filters that can be applied to output. MirOutputGammaSupported Supports gamma correction MirOutputType 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. For example; abgr_8888 should be coded as 0xAABBGGRR, which will
end up as R,G,B,A in memory on a little endian system, and as A,B,G,R on a
big endian system. MirPlacementGravity Reference point for aligning a surface relative to a rectangle.
Each element (surface and rectangle) has a MirPlacementGravity assigned. MirPlacementHints Positioning hints for aligning a window relative to a rectangle. MirPointerAction Possible pointer actions MirPointerAxis Identifiers for pointer axis MirPointerAxisSource Identifiers for pointer event source MirPointerButton MirPointerButtons MirPointerConfinementState Pointer Confinement MirPowerMode MirPromptSessionState MirResizeEdge Hints for resizing a window. MirShellChrome Shell chrome MirSubpixelArrangement Physical arrangement of subpixels on the physical output MirTiledEdge Hints describing which edges of a surface are considered adjacent
to another part of the tiling grid. MirTouchAction Possible per touch actions for state changing MirTouchAxis Identifiers for touch axis MirTouchTooltype Identifiers for per-touch tool types MirWindowAttrib Attributes of a window that the client and server/shell may wish to
get or set over the wire. MirWindowFocusState MirWindowState MirWindowType MirWindowVisibility miracle_animation_type miracle_container_type The type of the container. miracle_layout_scheme Describes a layout for a container. miracle_window_management_strategy_t Describes the placement strategy for a window.