mir::input Namespace Reference

Namespaces
	android
	evdev
	receiver
	X

Classes
class	BasicSeat
class	BuiltinCursorImages
class	CompositeEventFilter
class	CursorController
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	DefaultDevice
class	DefaultEventBuilder
class	DefaultInputDeviceHub
class	DefaultInputManager
class	Device
struct	DeviceData
class	DisplayInputRegion
class	EventBuilder
class	EventFilter
class	EventFilterChainDispatcher
class	InputChannel
	Encapsulates a paired set of fd's suitable for input communication. More...
class	InputChannelFactory
class	InputDevice
	Represents an input device. More...
class	InputDeviceHub
struct	InputDeviceInfo
class	InputDeviceObserver
class	InputDeviceRegistry
class	InputDevices
class	InputDispatcher
	The InputDispatchers role is to decide what should happen with user input events. More...
class	InputManager
class	InputRegion
	Interface to the region of valid input coordinates. More...
class	InputReport
class	InputSender
class	InputSink
class	KeyRepeatDispatcher
struct	LegacyInputDispatchable
class	NullInputChannelFactory
class	NullInputDispatcher
class	NullInputManager
struct	NullInputTargeter
class	Platform
	Input Platform is used to discover and access available input devices. More...
struct	PointerConfiguration
struct	PointerSettings
class	Scene
class	Seat
class	SeatInputDeviceTracker
class	Surface
class	SurfaceInputDispatcher
struct	TouchpadConfiguration
struct	TouchpadSettings
class	TouchspotController
	Receives touchspot events out of the input stack and manages appearance of touchspot renderables for visualization. Touchspot visualization is disabled by default and must be enabled through a call to ::enable. More...
class	TouchVisualizer
	An interface for listening to a low level stream of touches, in order to provide. More...
class	Validator
class	VTFilter

Typedefs
using	XKBContextPtr = std::unique_ptr< xkb_context, void(*)(xkb_context *)>
using	XKBKeymapPtr = std::unique_ptr< xkb_keymap, void(*)(xkb_keymap *)>
using	XKBStatePtr = std::unique_ptr< xkb_state, void(*)(xkb_state *)>
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
XKBContextPtr	make_unique_context ()
XKBKeymapPtr	make_unique_keymap (xkb_context *context, std::string const &model, std::string const &layout, std::string const &variant, std::string const &options)
XKBKeymapPtr	make_unique_keymap (xkb_context *context, char const *buffer, size_t size)
XKBStatePtr	make_unique_state (xkb_keymap *keymap)
mir::UniqueModulePtr< Platform >	probe_input_platforms (options::Option const &options, std::shared_ptr< EmergencyCleanupRegistry > const &emergency_cleanup, std::shared_ptr< InputDeviceRegistry > const &device_registry, std::shared_ptr< InputReport > const &input_report, SharedLibraryProberReport &prober_report)
auto	input_platform_from_graphics_module (graphics::Platform const &graphics_platform, options::Option const &options, std::shared_ptr< EmergencyCleanupRegistry > const &emergency_cleanup, std::shared_ptr< InputDeviceRegistry > const &device_registry, std::shared_ptr< InputReport > const &input_report) -> mir::UniqueModulePtr< Platform >
	Tries to create an input platform from the graphics module, otherwise returns a null pointer. More...
MirInputEventModifiers	to_modifiers (int32_t scan_code)
MirInputEventModifiers	expand_modifiers (MirInputEventModifiers modifiers)
DeviceCapability	mir_enable_enum_bit_operators (DeviceCapability)
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)

using mir::input::XKBContextPtr = typedef std::unique_ptr<xkb_context, void(*)(xkb_context*)>

using mir::input::XKBKeymapPtr = typedef std::unique_ptr<xkb_keymap, void (*)(xkb_keymap*)>

using mir::input::XKBStatePtr = typedef std::unique_ptr<xkb_state, void(*)(xkb_state*)>

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

MirInputEventModifiers mir::input::expand_modifiers

(

MirInputEventModifiers

modifiers

)

auto mir::input::input_platform_from_graphics_module	(	graphics::Platform const &	graphics_platform,
		options::Option const &	options,
		std::shared_ptr< EmergencyCleanupRegistry > const &	emergency_cleanup,
		std::shared_ptr< InputDeviceRegistry > const &	device_registry,
		std::shared_ptr< InputReport > const &	input_report
	)		-> mir::UniqueModulePtr<Platform>

Tries to create an input platform from the graphics module, otherwise returns a null pointer.

mi::XKBContextPtr mir::input::make_unique_context

(

)

mi::XKBKeymapPtr mir::input::make_unique_keymap	(	xkb_context *	context,
		std::string const &	model,
		std::string const &	layout,
		std::string const &	variant,
		std::string const &	options
	)

mi::XKBKeymapPtr mir::input::make_unique_keymap	(	xkb_context *	context,
		char const *	buffer,
		size_t	size
	)

mi::XKBStatePtr mir::input::make_unique_state

(

xkb_keymap *

keymap

)

DeviceCapability mir::input::mir_enable_enum_bit_operators

(

DeviceCapability

)

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

inline

mir::UniqueModulePtr<Platform> mir::input::probe_input_platforms	(	options::Option const &	options,
		std::shared_ptr< EmergencyCleanupRegistry > const &	emergency_cleanup,
		std::shared_ptr< InputDeviceRegistry > const &	device_registry,
		std::shared_ptr< InputReport > const &	input_report,
		SharedLibraryProberReport &	prober_report
	)

MirInputEventModifiers mir::input::to_modifiers

(

int32_t

scan_code

)

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