Mir
Typedefs | Enumerations
mir_input_device_types.h File Reference
#include <stdint.h>
Include dependency graph for mir_input_device_types.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef int64_t MirInputDeviceId
 
typedef enum MirPointerHandedness MirPointerHandedness
 
typedef enum MirPointerAcceleration MirPointerAcceleration
 MirPointerAcceleration describes the way pointer movement is filtered: More...
 
typedef enum MirTouchpadClickMode MirTouchpadClickMode
 MirTouchpadClickMode configures how the touchpad itself should generate pointer button events. More...
 
typedef unsigned int MirTouchpadClickModes
 
typedef enum MirTouchpadScrollMode MirTouchpadScrollMode
 MirTouchpadScrollMode configures how the touchpad should generate scroll events. More...
 
typedef unsigned int MirTouchpadScrollModes
 
typedef unsigned int MirInputDeviceCapabilities
 
typedef enum MirTouchscreenMappingMode MirTouchscreenMappingMode
 Mapping modes for touchscreen devices. More...
 

Enumerations

enum  MirPointerHandedness { mir_pointer_handedness_right = 0 , mir_pointer_handedness_left = 1 }
 
enum  MirPointerAcceleration { mir_pointer_acceleration_none = 1 , mir_pointer_acceleration_adaptive = 2 }
 MirPointerAcceleration describes the way pointer movement is filtered: More...
 
enum  MirTouchpadClickMode { mir_touchpad_click_mode_none = 0 , mir_touchpad_click_mode_area_to_click = 1 << 0 , mir_touchpad_click_mode_finger_count = 1 << 1 }
 MirTouchpadClickMode configures how the touchpad itself should generate pointer button events. More...
 
enum  MirTouchpadScrollMode { mir_touchpad_scroll_mode_none = 0 , mir_touchpad_scroll_mode_two_finger_scroll = 1 << 0 , mir_touchpad_scroll_mode_edge_scroll = 1 << 1 , mir_touchpad_scroll_mode_button_down_scroll = 1 << 2 }
 MirTouchpadScrollMode configures how the touchpad should generate scroll events. More...
 
enum  MirInputDeviceCapability {
  mir_input_device_capability_none = 0 , mir_input_device_capability_pointer = 1<<1 , mir_input_device_capability_keyboard = 1<<2 , mir_input_device_capability_touchpad = 1<<3 ,
  mir_input_device_capability_touchscreen = 1<<4 , mir_input_device_capability_gamepad = 1<<5 , mir_input_device_capability_joystick = 1<<6 , mir_input_device_capability_switch = 1<<7 ,
  mir_input_device_capability_multitouch = 1<<8 , mir_input_device_capability_alpha_numeric = 1<<9
}
 
enum  MirTouchscreenMappingMode { mir_touchscreen_mapping_mode_to_output , mir_touchscreen_mapping_mode_to_display_wall }
 Mapping modes for touchscreen devices. More...
 

Typedef Documentation

◆ MirInputDeviceCapabilities

typedef unsigned int MirInputDeviceCapabilities

◆ MirInputDeviceId

typedef int64_t MirInputDeviceId

◆ MirPointerAcceleration

MirPointerAcceleration describes the way pointer movement is filtered:

  • mir_pointer_acceleration_none: (acceleration bias + 1.0) is applied as a factor to the current velocity of the pointer. So a bias of 0 to results to no change of velocity.
  • mir_pointer_acceleration_adaptive: acceleration bias selects an acceleration function based on the current velocity that usually consists of two linear inclines separated by a plateau.

◆ MirPointerHandedness

◆ MirTouchpadClickMode

MirTouchpadClickMode configures how the touchpad itself should generate pointer button events.

The available click modes may be active simultaneously.

  • mir_touchpad_click_mode_none: no active click mode
  • mir_touchpad_click_mode_area_to_click: simulate pointer buttons using click areas on the touchpad
  • mir_touchpad_click_mode_finger_count: simulate pointer buttons using the number of fingers down

◆ MirTouchpadClickModes

typedef unsigned int MirTouchpadClickModes

◆ MirTouchpadScrollMode

MirTouchpadScrollMode configures how the touchpad should generate scroll events.

  • mir_touchpad_scroll_mode_none: no scroll
  • mir_touchpad_scroll_mode_two_finger_scroll: two finger movement generates generates vertical and horizontal scroll events
  • mir_touchpad_scroll_mode_edge_scroll: touch movement at the edge of the touchpad genertes scroll events
  • mir_touchpad_scroll_mode_button_down_scroll: movement on the touchpad generates scroll events when a button is held down simultaneously

◆ MirTouchpadScrollModes

typedef unsigned int MirTouchpadScrollModes

◆ MirTouchscreenMappingMode

Mapping modes for touchscreen devices.

The mode defines how coordinates from the touchscreen frequently referred to as device coordinates are translated into scene coordinates.

This configuration mode is relevant for different classes of input devices, i.e handheld devices with builtin touchscreens or external graphic tablets or external monitors with touchscreen capabilities.

Enumeration Type Documentation

◆ MirInputDeviceCapability

Enumerator
mir_input_device_capability_none 
mir_input_device_capability_pointer 
mir_input_device_capability_keyboard 
mir_input_device_capability_touchpad 
mir_input_device_capability_touchscreen 
mir_input_device_capability_gamepad 
mir_input_device_capability_joystick 
mir_input_device_capability_switch 
mir_input_device_capability_multitouch 
mir_input_device_capability_alpha_numeric 

capable to detect multiple contacts

◆ MirPointerAcceleration

MirPointerAcceleration describes the way pointer movement is filtered:

  • mir_pointer_acceleration_none: (acceleration bias + 1.0) is applied as a factor to the current velocity of the pointer. So a bias of 0 to results to no change of velocity.
  • mir_pointer_acceleration_adaptive: acceleration bias selects an acceleration function based on the current velocity that usually consists of two linear inclines separated by a plateau.
Enumerator
mir_pointer_acceleration_none 
mir_pointer_acceleration_adaptive 

◆ MirPointerHandedness

Enumerator
mir_pointer_handedness_right 
mir_pointer_handedness_left 

◆ MirTouchpadClickMode

MirTouchpadClickMode configures how the touchpad itself should generate pointer button events.

The available click modes may be active simultaneously.

  • mir_touchpad_click_mode_none: no active click mode
  • mir_touchpad_click_mode_area_to_click: simulate pointer buttons using click areas on the touchpad
  • mir_touchpad_click_mode_finger_count: simulate pointer buttons using the number of fingers down
Enumerator
mir_touchpad_click_mode_none 
mir_touchpad_click_mode_area_to_click 
mir_touchpad_click_mode_finger_count 

◆ MirTouchpadScrollMode

MirTouchpadScrollMode configures how the touchpad should generate scroll events.

  • mir_touchpad_scroll_mode_none: no scroll
  • mir_touchpad_scroll_mode_two_finger_scroll: two finger movement generates generates vertical and horizontal scroll events
  • mir_touchpad_scroll_mode_edge_scroll: touch movement at the edge of the touchpad genertes scroll events
  • mir_touchpad_scroll_mode_button_down_scroll: movement on the touchpad generates scroll events when a button is held down simultaneously
Enumerator
mir_touchpad_scroll_mode_none 
mir_touchpad_scroll_mode_two_finger_scroll 
mir_touchpad_scroll_mode_edge_scroll 
mir_touchpad_scroll_mode_button_down_scroll 

◆ MirTouchscreenMappingMode

Mapping modes for touchscreen devices.

The mode defines how coordinates from the touchscreen frequently referred to as device coordinates are translated into scene coordinates.

This configuration mode is relevant for different classes of input devices, i.e handheld devices with builtin touchscreens or external graphic tablets or external monitors with touchscreen capabilities.

Enumerator
mir_touchscreen_mapping_mode_to_output 

Map the device coordinates onto specific output.

mir_touchscreen_mapping_mode_to_display_wall 

Map the device coordinates onto the whole wall of outputs.


Copyright © 2012-2023 Canonical Ltd.
Generated on Tue 2 May 10:01:24 UTC 2023
This documentation is licensed under the GPL version 2 or 3.