Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AzFramework::XcbInputDeviceKeyboard Class Reference

Inherits AzFramework::InputDeviceKeyboard::Implementation, and XcbEventHandlerBus::Handler.

Public Member Functions

 AZ_CLASS_ALLOCATOR (XcbInputDeviceKeyboard, AZ::SystemAllocator)
 
 XcbInputDeviceKeyboard (InputDeviceKeyboard &inputDevice)
 
bool IsConnected () const override
 
bool HasTextEntryStarted () const override
 
void TextEntryStart (const InputDeviceKeyboard::VirtualKeyboardOptions &options) override
 
void TextEntryStop () override
 Inform input device that text input is expected to stop (pair with StartTextInput)
 
void TickInputDevice () override
 Tick/update the input device to broadcast all input events since the last frame.
 
void HandleXcbEvent (xcb_generic_event_t *event) override
 
- Public Member Functions inherited from AzFramework::InputDeviceKeyboard::Implementation
 AZ_CLASS_ALLOCATOR (Implementation, AZ::SystemAllocator)
 
 Implementation (InputDeviceKeyboard &inputDevice)
 
 AZ_DISABLE_COPY_MOVE (Implementation)
 
virtual ~Implementation ()
 Destructor.
 
virtual LocalUserId GetAssignedLocalUserId () const
 
virtual bool IsConnected () const =0
 
virtual bool HasTextEntryStarted () const =0
 
virtual void TextEntryStart (const VirtualKeyboardOptions &options)=0
 
virtual void TextEntryStop ()=0
 Inform input device that text input is expected to stop (pair with StartTextInput)
 
virtual void TickInputDevice ()=0
 Tick/update the input device to broadcast all input events since the last frame.
 
virtual void GetPhysicalKeyOrButtonText (const InputChannelId &, AZStd::string &) const
 

Additional Inherited Members

- Static Public Member Functions inherited from AzFramework::InputDeviceKeyboard::Implementation
static Implementation * Create (InputDeviceKeyboard &inputDevice)
 
- Protected Types inherited from AzFramework::InputDeviceKeyboard::Implementation
using RawKeyEventQueueByIdMap = AZStd::unordered_map< InputChannelId, AZStd::vector< bool > >
 Alias for verbose container class.
 
- Protected Member Functions inherited from AzFramework::InputDeviceKeyboard::Implementation
void QueueRawKeyEvent (const InputChannelId &inputChannelId, bool rawKeyState)
 
void QueueRawTextEvent (const AZStd::string &textUTF8)
 
void ProcessRawEventQueues ()
 
void ResetInputChannelStates ()
 Reset the state of all this input device's associated input channels.
 
- Protected Attributes inherited from AzFramework::InputDeviceKeyboard::Implementation
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.
 

Member Function Documentation

◆ HasTextEntryStarted()

bool AzFramework::XcbInputDeviceKeyboard::HasTextEntryStarted ( ) const
overridevirtual

Query whether text entry has already been started

Returns
True if text entry has already been started, false otherwise

Implements AzFramework::InputDeviceKeyboard::Implementation.

◆ IsConnected()

bool AzFramework::XcbInputDeviceKeyboard::IsConnected ( ) const
overridevirtual

Query the connected state of the input device

Returns
True if the input device is currently connected, false otherwise

Implements AzFramework::InputDeviceKeyboard::Implementation.

◆ TextEntryStop()

void AzFramework::XcbInputDeviceKeyboard::TextEntryStop ( )
overridevirtual

Inform input device that text input is expected to stop (pair with StartTextInput)

Implements AzFramework::InputDeviceKeyboard::Implementation.

◆ TickInputDevice()

void AzFramework::XcbInputDeviceKeyboard::TickInputDevice ( )
overridevirtual

Tick/update the input device to broadcast all input events since the last frame.

Implements AzFramework::InputDeviceKeyboard::Implementation.

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