Base class for platform specific implementations of keyboard input devices.
More...
#include <InputDeviceKeyboard.h>
Inherited by AzFramework::XcbInputDeviceKeyboard.
|
using | RawKeyEventQueueByIdMap = AZStd::unordered_map< InputChannelId, AZStd::vector< bool > > |
| Alias for verbose container class.
|
|
|
InputDeviceKeyboard & | m_inputDevice |
| Reference to the input device.
|
|
RawKeyEventQueueByIdMap | m_rawKeyEventQueuesById |
| Raw key event queues by id.
|
|
AZStd::vector< AZStd::string > | m_rawTextEventQueue |
| Raw text event queue.
|
|
Base class for platform specific implementations of keyboard input devices.
◆ Implementation()
AzFramework::InputDeviceKeyboard::Implementation::Implementation |
( |
InputDeviceKeyboard & |
inputDevice | ) |
|
Constructor
- Parameters
-
[in] | inputDevice | Reference to the input device being implemented |
◆ Create()
Default factory create function
- Parameters
-
[in] | inputDevice | Reference to the input device being implemented |
◆ GetPhysicalKeyOrButtonText()
virtual void AzFramework::InputDeviceKeyboard::Implementation::GetPhysicalKeyOrButtonText |
( |
const InputChannelId & |
, |
|
|
AZStd::string & |
|
|
) |
| const |
|
inlinevirtual |
Get the text displayed on the physical key/button associated with an input channel. In the case of keyboard keys, we must take into account the current keyboard layout.
- Parameters
-
[in] | inputChannelId | The input channel id whose key or button text to return |
[out] | o_keyOrButtonText | The text displayed on the physical key/button if found |
◆ HasTextEntryStarted()
virtual bool AzFramework::InputDeviceKeyboard::Implementation::HasTextEntryStarted |
( |
| ) |
const |
|
pure virtual |
◆ IsConnected()
virtual bool AzFramework::InputDeviceKeyboard::Implementation::IsConnected |
( |
| ) |
const |
|
pure virtual |
◆ ProcessRawEventQueues()
void AzFramework::InputDeviceKeyboard::Implementation::ProcessRawEventQueues |
( |
| ) |
|
|
protected |
Process raw input events that have been queued since the last call to this function. This function is not thread safe, and so should only be called from the main thread.
◆ QueueRawKeyEvent()
void AzFramework::InputDeviceKeyboard::Implementation::QueueRawKeyEvent |
( |
const InputChannelId & |
inputChannelId, |
|
|
bool |
rawKeyState |
|
) |
| |
|
protected |
Queue raw key events to be processed in the next call to ProcessRawEventQueues. This function is not thread safe and so should only be called from the main thread.
- Parameters
-
[in] | inputChannelId | The input channel id |
[in] | rawKeyState | The raw key state |
◆ QueueRawTextEvent()
void AzFramework::InputDeviceKeyboard::Implementation::QueueRawTextEvent |
( |
const AZStd::string & |
textUTF8 | ) |
|
|
protected |
Queue raw text events to be processed in the next call to ProcessRawEventQueues. This function is not thread safe and so should only be called from the main thread.
- Parameters
-
[in] | textUTF8 | The text to queue (encoded using UTF-8) |
◆ TextEntryStart()
virtual void AzFramework::InputDeviceKeyboard::Implementation::TextEntryStart |
( |
const VirtualKeyboardOptions & |
options | ) |
|
|
pure virtual |
Inform input device that text input is expected to start (pair with StopTextInput)
- Parameters
-
[in] | options | Used to specify the appearance/behavior of any virtual keyboard |
◆ TextEntryStop()
virtual void AzFramework::InputDeviceKeyboard::Implementation::TextEntryStop |
( |
| ) |
|
|
pure virtual |
◆ TickInputDevice()
virtual void AzFramework::InputDeviceKeyboard::Implementation::TickInputDevice |
( |
| ) |
|
|
pure virtual |
The documentation for this class was generated from the following file:
- Code/Framework/AzFramework/AzFramework/Input/Devices/Keyboard/InputDeviceKeyboard.h