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

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

#include <InputDeviceMouse_Windows.h>

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

Public Member Functions

 AZ_CLASS_ALLOCATOR (InputDeviceMouseWindows, AZ::SystemAllocator)
 
 InputDeviceMouseWindows (InputDeviceMouse &inputDevice)
 
 ~InputDeviceMouseWindows () override
 Destructor.
 
- Public Member Functions inherited from AzFramework::InputDeviceMouse::Implementation
 AZ_CLASS_ALLOCATOR (Implementation, AZ::SystemAllocator)
 
 Implementation (InputDeviceMouse &inputDevice)
 
 AZ_DISABLE_COPY_MOVE (Implementation)
 
virtual ~Implementation ()
 Destructor.
 
void SetRawMovementSampleRate (AZ::u32 sampleRateHertz)
 
void SetCaptureCursor (bool captureCursor)
 

Additional Inherited Members

- Static Public Member Functions inherited from AzFramework::InputDeviceMouse::Implementation
static ImplementationCreate (InputDeviceMouse &inputDevice)
 
- Protected Types inherited from AzFramework::InputDeviceMouse::Implementation
using RawButtonEventQueueByIdMap = AZStd::unordered_map< InputChannelId, AZStd::vector< bool > >
 
using RawMovementEventQueueByIdMap = AZStd::unordered_map< InputChannelId, AZStd::vector< float > >
 
using LastSampleTimeArray = AZStd::array< AZStd::chrono::steady_clock::time_point, InputDeviceMouse::Movement::All.size()>
 
- Protected Member Functions inherited from AzFramework::InputDeviceMouse::Implementation
void QueueRawButtonEvent (const InputChannelId &inputChannelId, bool rawButtonState)
 
void QueueRawMovementEvent (const InputChannelId &inputChannelId, float rawMovementDelta)
 
void ProcessRawEventQueues ()
 
void ResetInputChannelStates ()
 Reset the state of all this input device's associated input channels.
 
- Protected Attributes inherited from AzFramework::InputDeviceMouse::Implementation
bool m_captureCursor
 Should the cursor be captured?
 

Detailed Description

Platform specific implementation for Windows mouse input devices.

Constructor & Destructor Documentation

◆ InputDeviceMouseWindows()

AzFramework::InputDeviceMouseWindows::InputDeviceMouseWindows ( InputDeviceMouse inputDevice)

Constructor

Parameters
[in]inputDeviceReference to the input device being implemented

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