#include <GHOST_ModifierKeys.h>

Public Member Functions
	GHOST_ModifierKeys ()

	~GHOST_ModifierKeys ()

bool	get (GHOST_TModifierKey mask) const

void	set (GHOST_TModifierKey mask, bool down)

void	clear ()

bool	equals (const GHOST_ModifierKeys &keys) const

Static Public Member Functions
static GHOST_TKey	getModifierKeyCode (GHOST_TModifierKey mask)

Public Attributes
uint8_t	m_LeftShift: 1

uint8_t	m_RightShift: 1

uint8_t	m_LeftAlt: 1

uint8_t	m_RightAlt: 1

uint8_t	m_LeftControl: 1

uint8_t	m_RightControl: 1

uint8_t	m_OS: 1

Detailed Description

Stores the state of modifier keys. Discriminates between left and right modifier keys.

Definition at line 17 of file GHOST_ModifierKeys.h.

Constructor & Destructor Documentation

◆ GHOST_ModifierKeys()

GHOST_ModifierKeys::GHOST_ModifierKeys ( )

Constructor.

Definition at line 14 of file GHOST_ModifierKeys.cpp.

References clear().

◆ ~GHOST_ModifierKeys()

GHOST_ModifierKeys::~GHOST_ModifierKeys ( )

Definition at line 19 of file GHOST_ModifierKeys.cpp.

Member Function Documentation

◆ clear()

void GHOST_ModifierKeys::clear ( )

Sets the state of all modifier keys to up.

Definition at line 107 of file GHOST_ModifierKeys.cpp.

References m_LeftAlt, m_LeftControl, m_LeftShift, m_OS, m_RightAlt, m_RightControl, and m_RightShift.

Referenced by GHOST_ModifierKeys(), and GHOST_SystemWin32::s_wndProc().

◆ equals()

bool GHOST_ModifierKeys::equals ( const GHOST_ModifierKeys & keys ) const

Determines whether to modifier key states are equal.

Parameters

keys	The modifier key state to compare to.

Returns: Indication of equality.

Definition at line 118 of file GHOST_ModifierKeys.cpp.

References m_LeftAlt, m_LeftControl, m_LeftShift, m_OS, m_RightAlt, m_RightControl, and m_RightShift.

◆ get()

bool GHOST_ModifierKeys::get ( GHOST_TModifierKey mask ) const

Returns the state of a single modifier key.

Parameters

mask	Key state to return.

Returns: The state of the key (pressed == true).

Definition at line 56 of file GHOST_ModifierKeys.cpp.

References GHOST_kModifierKeyLeftAlt, GHOST_kModifierKeyLeftControl, GHOST_kModifierKeyLeftShift, GHOST_kModifierKeyOS, GHOST_kModifierKeyRightAlt, GHOST_kModifierKeyRightControl, GHOST_kModifierKeyRightShift, m_LeftAlt, m_LeftControl, m_LeftShift, m_OS, m_RightAlt, m_RightControl, m_RightShift, and mask().

Referenced by GHOST_System::getModifierKeyState(), and GHOST_SystemWin32::hardKey().

◆ getModifierKeyCode()

GHOST_TKey GHOST_ModifierKeys::getModifierKeyCode ( GHOST_TModifierKey mask )

static

Returns the modifier key's key code from a modifier key mask.

Parameters

mask	The mask of the modifier key.

Returns: The modifier key's key code.

Definition at line 23 of file GHOST_ModifierKeys.cpp.

References GHOST_kKeyLeftAlt, GHOST_kKeyLeftControl, GHOST_kKeyLeftShift, GHOST_kKeyOS, GHOST_kKeyRightAlt, GHOST_kKeyRightControl, GHOST_kKeyRightShift, GHOST_kKeyUnknown, GHOST_kModifierKeyLeftAlt, GHOST_kModifierKeyLeftControl, GHOST_kModifierKeyLeftShift, GHOST_kModifierKeyOS, GHOST_kModifierKeyRightAlt, GHOST_kModifierKeyRightControl, GHOST_kModifierKeyRightShift, and mask().

◆ set()

void GHOST_ModifierKeys::set	(	GHOST_TModifierKey	mask,
		bool	down
	)

Updates the state of a single modifier key.

Parameters

mask	Key state to update.
down	The new state of the key.

Definition at line 78 of file GHOST_ModifierKeys.cpp.

References GHOST_kModifierKeyLeftAlt, GHOST_kModifierKeyLeftControl, GHOST_kModifierKeyLeftShift, GHOST_kModifierKeyOS, GHOST_kModifierKeyRightAlt, GHOST_kModifierKeyRightControl, GHOST_kModifierKeyRightShift, m_LeftAlt, m_LeftControl, m_LeftShift, m_OS, m_RightAlt, m_RightControl, m_RightShift, and mask().

Referenced by GHOST_SystemCocoa::getModifierKeys(), GHOST_SystemSDL::getModifierKeys(), GHOST_SystemWin32::getModifierKeys(), GHOST_SystemX11::getModifierKeys(), GHOST_SystemWayland::getModifierKeys(), and GHOST_SystemWin32::hardKey().