AzFramework::InputChannelRequests::BusIdType Class Reference

#include <InputChannelRequestBus.h>

Public Member Functions
	AZ_CLASS_ALLOCATOR (BusIdType, AZ::SystemAllocator)
	AZ_TYPE_INFO (BusIdType, "{FA0B740B-8917-4260-B402-05444C985AB5}")
	BusIdType (const InputChannelId &channelId, AZ::u32 deviceIndex=0)
	BusIdType (const char *channelName, AZ::u32 deviceIndex=0)
constexpr	operator size_t () const
	Size_t conversion operator for std::hash to return a reasonable hash.
bool	operator== (const BusIdType &other) const
bool	operator!= (const BusIdType &other) const

Static Public Member Functions
static void	Reflect (AZ::ReflectContext *context)

Public Attributes
InputChannelId	m_channelId
	Id of the input channel to address requests.
AZ::u32	m_deviceIndex
	Index of the input device to address requests.

Detailed Description

EBus Trait: requests should be addressed to a specific channel id / device index pair. While input channel ids must be unique across different input devices, multiple devices of the same type can exist, so requests must be addressed using an id/device index pair.

Constructor & Destructor Documentation

BusIdType() [1/2]

AzFramework::InputChannelRequests::BusIdType::BusIdType ( const InputChannelId &  channelId, AZ::u32  deviceIndex = 0  )

inline

Constructor

Parameters

[in]	channelId	Id of the input channel to address requests
[in]	deviceIndex	Index of the input device to address requests

BusIdType() [2/2]

AzFramework::InputChannelRequests::BusIdType::BusIdType ( const char *  channelName, AZ::u32  deviceIndex = 0  )

inline

Constructor

Parameters

[in]	channelName	Name of the input channel to address requests
[in]	deviceIndex	Index of the input device to address requests

Member Function Documentation

operator==()

bool AzFramework::InputChannelRequests::BusIdType::operator== ( const BusIdType &  other ) const

inline

Equality comparison operator

Parameters

[in]

other

Another instance of the class to compare for equality

---

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

• Code/Framework/AzFramework/AzFramework/Input/Buses/Requests/InputChannelRequestBus.h