AzFramework::InputChannelId Class Reference

Class that identifies a specific input channel. More...

#include <InputChannelId.h>

Public Member Functions
	AZ_CLASS_ALLOCATOR (InputChannelId, AZ::SystemAllocator)
	AZ_TYPE_INFO (InputChannelId, "{7004B466-F6B4-41EF-AFFD-96A456121271}")
constexpr	InputChannelId (AZStd::string_view name="")
	AZ_DEFAULT_COPY_MOVE (InputChannelId)
	~InputChannelId ()=default
	Default destructor.
constexpr const char *	GetName () const
constexpr const AZ::Crc32 &	GetNameCrc32 () const
constexpr bool	operator== (const InputChannelId &other) const
constexpr bool	operator!= (const InputChannelId &other) const

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

Static Public Attributes
static constexpr int	MAX_NAME_LENGTH = 64

Detailed Description

Class that identifies a specific input channel.

Constructor & Destructor Documentation

InputChannelId()

constexpr AzFramework::InputChannelId::InputChannelId ( AZStd::string_view  name = "" )

inlineexplicitconstexpr

Constructor

Parameters

[in]

name

Name of the input channel (will be truncated if exceeds MAX_NAME_LENGTH)

Member Function Documentation

GetName()

constexpr const char * AzFramework::InputChannelId::GetName ( ) const

inlineconstexpr

Access to the input channel's name

Returns

Name of the input channel

GetNameCrc32()

constexpr const AZ::Crc32 & AzFramework::InputChannelId::GetNameCrc32 ( ) const

inlineconstexpr

Access to the crc32 of the input channel's name

Returns

crc32 of the input channel name

operator!=()

constexpr bool AzFramework::InputChannelId::operator!= ( const InputChannelId &  other ) const

inlineconstexpr

Inequality comparison operator

Parameters

[in]

other

Another instance of the class to compare for inequality

operator==()

constexpr bool AzFramework::InputChannelId::operator== ( const InputChannelId &  other ) const

inlineconstexpr

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/Channels/InputChannelId.h