AzFramework::RawInputNotificationsAndroid Class Reference

#include <RawInputNotificationBus_Android.h>

Inherits AZ::EBusTraits.

Public Member Functions
virtual	~RawInputNotificationsAndroid ()=default
	Default destructor.
virtual void	OnRawInputEvent (const AInputEvent *)
virtual void	OnRawInputTextEvent (const char *)
virtual void	OnRawInputVirtualKeyboardEvent (int, int)

Static Public Attributes
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::Single
	EBus Trait: raw input notifications are addressed to a single address.
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
	EBus Trait: raw input notifications can be handled by multiple listeners.

Detailed Description

EBus interface used to listen for raw android input as broadcast by the system. Applications that want android events to be processed by the AzFramework input system must broadcast all input events received by the native input handle, which is the lowest level we can get input.

It's possible to receive multiple events per index (finger) per frame, and it is likely that android input events will not be dispatched from the main thread, so care should be taken to ensure thread safety when implementing event handlers that connect to this android event bus.

This EBus is intended primarily for the AzFramework input system to process raw input events. Most systems that need to process input should use the generic AzFramework input interfaces, but if necessary it is perfectly valid to connect directly to this EBus for android events.

Member Function Documentation

OnRawInputEvent()

virtual void AzFramework::RawInputNotificationsAndroid::OnRawInputEvent ( const AInputEvent *  )

inlinevirtual

Process raw input events (assumed to be dispatched on any thread)

Parameters

[in]

rawInputEvent

The raw input event data

OnRawInputTextEvent()

virtual void AzFramework::RawInputNotificationsAndroid::OnRawInputTextEvent ( const char *  )

inlinevirtual

Process raw text events (assumed to be dispatched on any thread)

Parameters

[in]

charsModifiedUTF8

The raw chars (encoded using modified UTF-8)

OnRawInputVirtualKeyboardEvent()

virtual void AzFramework::RawInputNotificationsAndroid::OnRawInputVirtualKeyboardEvent ( int  , int    )

inlinevirtual

Process raw virtual keyboard events (assumed to be dispatched on any thread)

Parameters

[in]	keyCode	The key code of the virtual keyboard event
[in]	keyAction	The key action of the virtual keyboard event

---

The documentation for this class was generated from the following file:

• Code/Framework/AzFramework/Platform/Android/AzFramework/Input/Buses/Notifications/RawInputNotificationBus_Android.h