stmi::HardwareKeys Namespace Reference

Functions
const std::vector< HARDWARE_KEY > &	get () noexcept
	Returns the defined HARDWARE_KEY values as an ordered vector (HK_NULL excluded). More...
bool	isValid (HARDWARE_KEY eKey) noexcept
	Tells whether a key is valid. More...

Function Documentation

get()

const std::vector<HARDWARE_KEY>& stmi::HardwareKeys::get ( )

noexcept

Returns the defined HARDWARE_KEY values as an ordered vector (HK_NULL excluded).

The singleton vector is only created when this function is first called.

Returns

The hardware keys as a std::vector.

isValid()

bool stmi::HardwareKeys::isValid ( HARDWARE_KEY  eKey )

noexcept

Tells whether a key is valid.

HK_NULL is not considered a valid key by this function!

Parameters

eKey	The key to check.

Returns

Whether the key is valid.