AzFramework::ModifierKeyStates Struct Reference

Custom data struct to store the current state of all modifier keys. More...

#include <InputChannelDigitalWithSharedModifierKeyStates.h>

Inherits AzFramework::InputChannel::CustomData.

Public Member Functions
	AZ_CLASS_ALLOCATOR (ModifierKeyStates, AZ::SystemAllocator)
	AZ_RTTI (ModifierKeyStates, "{999937EC-6BFD-41F4-A0F2-7990018D3589}", CustomData)
ModifierKeyMask	GetActiveModifierKeys () const
bool	IsActive (ModifierKeyMask modifierKey) const
void	SetActive (ModifierKeyMask modifierKey, bool active)
Public Member Functions inherited from AzFramework::InputChannel::CustomData
	AZ_CLASS_ALLOCATOR (CustomData, AZ::SystemAllocator)
	AZ_RTTI (CustomData, "{887E38BB-64AF-4F4E-A1AE-C1B02371F9EC}")

Detailed Description

Custom data struct to store the current state of all modifier keys.

Member Function Documentation

GetActiveModifierKeys()

ModifierKeyMask AzFramework::ModifierKeyStates::GetActiveModifierKeys ( ) const

inline

Get the bitmask of active modifier keys

Returns

The bitmask of active modifier keys

IsActive()

bool AzFramework::ModifierKeyStates::IsActive

(

ModifierKeyMask

modifierKey

)

const

Query whether the specified modifier key is active

Parameters

[in]

modifierKey

The modifier key to check

Returns

True if the modifier key is active, false otherwise

SetActive()

void AzFramework::ModifierKeyStates::SetActive	(	ModifierKeyMask	modifierKey,
		bool	active
	)

Set the active state of the specified modifier key

Parameters

[in]	modifierKey	The modifier key to set
[in]	active	The active state to set

---

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

• Code/Framework/AzFramework/AzFramework/Input/Channels/InputChannelDigitalWithSharedModifierKeyStates.h