Open 3D Engine AzFramework API Reference 25.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzFramework::InputDeviceKeyboardWindows Class Reference

Platform specific implementation for Windows keyboard input devices. More...

#include <InputDeviceKeyboard_Windows.h>

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

Public Member Functions

 AZ_CLASS_ALLOCATOR (InputDeviceKeyboardWindows, AZ::SystemAllocator)
 
 InputDeviceKeyboardWindows (InputDeviceKeyboard &inputDevice)
 
 ~InputDeviceKeyboardWindows () override
 Destructor.
 
- 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 void TextEntryStart (const VirtualKeyboardOptions &options)=0
 

Additional Inherited Members

- Static Public Member Functions inherited from AzFramework::InputDeviceKeyboard::Implementation
static ImplementationCreate (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
InputDeviceKeyboardm_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.
 

Detailed Description

Platform specific implementation for Windows keyboard input devices.

Constructor & Destructor Documentation

◆ InputDeviceKeyboardWindows()

AzFramework::InputDeviceKeyboardWindows::InputDeviceKeyboardWindows ( InputDeviceKeyboard inputDevice)

Constructor

Parameters
[in]inputDeviceReference to the input device being implemented

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