mir::input Namespace Reference

Classes
class	CompositeEventFilter
class	CursorImages
class	CursorListener
	An interface for listening to absolute cursor events (without context): For example to update the position of the visible cursor. More...
class	Device
class	EventBuilder
class	EventFilter
class	InputChannel
	Encapsulates a paired set of fd's suitable for input communication. More...
class	InputDevice
	Represents an input device. More...
class	InputDeviceHub
struct	InputDeviceInfo
class	InputDeviceObserver
class	InputDeviceRegistry
class	InputDispatcher
	The InputDispatchers role is to decide what should happen with user input events. More...
class	InputManager
class	InputReport
class	InputSink
struct	Keymap
class	Platform
	Input Platform is used to discover and access available input devices. More...
struct	PointerSettings
class	SeatObserver
class	Surface
struct	TouchpadSettings
class	TouchVisualizer
	An interface for listening to a low level stream of touches, in order to provide. More...

Typedefs
using	DeviceCapabilities = mir::Flags< DeviceCapability >
typedef mir::UniqueModulePtr< Platform >(*	CreatePlatform) (options::Option const &options, std::shared_ptr< EmergencyCleanupRegistry > const &emergency_cleanup_registry, std::shared_ptr< InputDeviceRegistry > const &input_device_registry, std::shared_ptr< InputReport > const &report)
typedef void(*	AddPlatformOptions) (boost::program_options::options_description &config)
typedef PlatformPriority(*	ProbePlatform) (options::Option const &options)
typedef ModuleProperties const *(*	DescribeModule) ()

Enumerations
enum	DeviceCapability : uint32_t {   DeviceCapability::unknown = 0, DeviceCapability::pointer = 1<<1, DeviceCapability::keyboard = 1<<2, DeviceCapability::touchpad = 1<<3,   DeviceCapability::touchscreen = 1<<4, DeviceCapability::gamepad = 1<<5, DeviceCapability::joystick = 1<<6, DeviceCapability::switch_ = 1<<7,   DeviceCapability::multitouch = 1<<8, DeviceCapability::alpha_numeric = 1<<9 }
enum	PlatformPriority : uint32_t { PlatformPriority::unsupported = 0, PlatformPriority::dummy = 1, PlatformPriority::supported = 128, PlatformPriority::best = 256 }
enum	InputReceptionMode { InputReceptionMode::normal, InputReceptionMode::receives_all_input }

Functions
DeviceCapability	mir_enable_enum_bit_operators (DeviceCapability)
bool	operator== (Keymap const &lhs, Keymap const &rhs)
bool	operator!= (Keymap const &lhs, Keymap const &rhs)
std::ostream &	operator<< (std::ostream &out, Keymap const &rhs)
std::string	serialize_input_config (MirInputConfig const &config)
MirInputConfig	deserialize_input_config (std::string const &buffer)
bool	operator== (TouchVisualizer::Spot const &lhs, TouchVisualizer::Spot const &rhs)

Variables
int const	no_scroll_button = 0
geometry::Size const	default_cursor_size {geometry::Width{24}, geometry::Height{24}}
	CursorImages is used to lookup cursor images from the system theme. More...

Typedef Documentation

typedef void(* mir::input::AddPlatformOptions) (boost::program_options::options_description &config)

typedef mir::UniqueModulePtr<Platform>(* mir::input::CreatePlatform) (options::Option const &options, std::shared_ptr< EmergencyCleanupRegistry > const &emergency_cleanup_registry, std::shared_ptr< InputDeviceRegistry > const &input_device_registry, std::shared_ptr< InputReport > const &report)

typedef ModuleProperties const*(* mir::input::DescribeModule) ()

using mir::input::DeviceCapabilities = typedef mir::Flags<DeviceCapability>

typedef PlatformPriority(* mir::input::ProbePlatform) (options::Option const &options)

Enumeration Type Documentation

enum mir::input::DeviceCapability : uint32_t

strong

Enumerator
unknown
pointer
keyboard
touchpad
touchscreen
gamepad
joystick
switch_
multitouch
alpha_numeric

enum mir::input::InputReceptionMode

strong

Enumerator
normal
receives_all_input

enum mir::input::PlatformPriority : uint32_t

strong

Enumerator
unsupported
dummy
supported
best

Function Documentation

MirInputConfig mir::input::deserialize_input_config

(

std::string const &

buffer

)

DeviceCapability mir::input::mir_enable_enum_bit_operators

(

DeviceCapability

)

bool mir::input::operator!= ( Keymap const &  lhs, Keymap const &  rhs  )

inline

std::ostream& mir::input::operator<< ( std::ostream &  out, Keymap const &  rhs  )

inline

bool mir::input::operator== ( Keymap const &  lhs, Keymap const &  rhs  )

inline

bool mir::input::operator== ( TouchVisualizer::Spot const &  lhs, TouchVisualizer::Spot const &  rhs  )

inline

std::string mir::input::serialize_input_config

(

MirInputConfig const &

config

)

Variable Documentation

geometry::Size const mir::input::default_cursor_size {geometry::Width{24}, geometry::Height{24}}

CursorImages is used to lookup cursor images from the system theme.

int const mir::input::no_scroll_button = 0