get_modifier_mask


Description:

[ Version ( since = "3.4" ) ]
public ModifierType get_modifier_mask (ModifierIntent intent)

Returns the modifier mask the this’s windowing system backend uses for a particular purpose.

Note that this function always returns real hardware modifiers, not virtual ones (e.g. it will return MOD1_MASK rather than META_MASK if the backend maps MOD1 to META), so there are use cases where the return value of this function has to be transformed by add_virtual_modifiers in order to contain the expected result.

Parameters:

this

a Keymap

intent

the use case for the modifier mask

Returns:

the modifier mask used for intent.