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::InputDeviceGamepadWindows Class Reference

Platform specific implementation for Windows game-pad input devices. More...

#include <InputDeviceGamepad_Windows.h>

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

Public Member Functions

 AZ_CLASS_ALLOCATOR (InputDeviceGamepadWindows, AZ::SystemAllocator)
 
 InputDeviceGamepadWindows (InputDeviceGamepad &inputDevice, AZStd::shared_ptr< AZ::DynamicModuleHandle > xinputModuleHandle)
 
 ~InputDeviceGamepadWindows () override
 Destructor.
 
- Public Member Functions inherited from AzFramework::InputDeviceGamepad::Implementation
 AZ_CLASS_ALLOCATOR (Implementation, AZ::SystemAllocator)
 
 Implementation (InputDeviceGamepad &inputDevice)
 
 AZ_DISABLE_COPY_MOVE (Implementation)
 
virtual ~Implementation ()
 Destructor.
 
virtual LocalUserId GetAssignedLocalUserId () const
 
virtual void PromptLocalUserSignIn () const
 Prompt a local user sign-in request from this input device.
 
virtual void SetLightBarColor (const AZ::Color &color)
 
virtual void ResetLightBarColor ()
 Reset the light bar color of the gamepad (if one exists) to it's default.
 
void BroadcastInputDeviceConnectedEvent () const
 Broadcast an event when the input device connects to the system.
 
void BroadcastInputDeviceDisconnectedEvent () const
 Broadcast an event when the input device disconnects from the system.
 

Additional Inherited Members

- Public Types inherited from AzFramework::InputDeviceGamepad::Implementation
using DigitalButtonIdByBitMaskMap = AZStd::unordered_map< AZ::u32, const InputChannelId * >
 Alias for verbose container class.
 
- Static Public Member Functions inherited from AzFramework::InputDeviceGamepad::Implementation
static ImplementationCreate (InputDeviceGamepad &inputDevice)
 
- Protected Member Functions inherited from AzFramework::InputDeviceGamepad::Implementation
void ProcessRawGamepadState (const RawGamepadState &rawGamepadState)
 
void ResetInputChannelStates ()
 Reset the state of all this input device's associated input channels.
 
AZ::u32 GetInputDeviceIndex () const
 AzFramework::InputDeviceId::GetIndex
 

Detailed Description

Platform specific implementation for Windows game-pad input devices.

Constructor & Destructor Documentation

◆ InputDeviceGamepadWindows()

AzFramework::InputDeviceGamepadWindows::InputDeviceGamepadWindows ( InputDeviceGamepad inputDevice,
AZStd::shared_ptr< AZ::DynamicModuleHandle >  xinputModuleHandle 
)

Constructor

Parameters
[in]inputDeviceReference to the input device being implemented
[in]xinputModuleHandleShared pointer to the xinput dynamic module

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