libdonut  2.3.2
Application framework for cross-platform game development in C++20
Public Types | Public Attributes | List of all members
donut::events::KeyEventBase Struct Reference

Keyboard key Event base. More...

#include <donut/events/Event.hpp>

Inheritance diagram for donut::events::KeyEventBase:
donut::events::InputEventBase donut::events::EventBase donut::events::KeyPressRepeatedEvent donut::events::KeyPressedEvent donut::events::KeyReleasedEvent

Public Types

enum  KeyModifier : KeyModifiers {
  MODIFIER_NONE = 0 , MODIFIER_LSHIFT = 1 << 0 , MODIFIER_RSHIFT = 1 << 1 , MODIFIER_LCTRL = 1 << 6 ,
  MODIFIER_RCTRL = 1 << 7 , MODIFIER_LALT = 1 << 8 , MODIFIER_RALT = 1 << 9 , MODIFIER_LSUPER = 1 << 10 ,
  MODIFIER_RSUPER = 1 << 11 , MODIFIER_NUM_LOCK = 1 << 12 , MODIFIER_CAPS_LOCK = 1 << 13 , MODIFIER_MODE = 1 << 14 ,
  MODIFIER_SCROLL_LOCK = 1 << 15 , MODIFIER_CTRL = MODIFIER_LCTRL | MODIFIER_RCTRL , MODIFIER_SHIFT = MODIFIER_LSHIFT | MODIFIER_RSHIFT , MODIFIER_ALT = MODIFIER_LALT | MODIFIER_RALT ,
  MODIFIER_SUPER = MODIFIER_LSUPER | MODIFIER_RSUPER
}
 Key modifier bits. More...
 
using KeyModifiers = std::uint16_t
 Bit set of key modifiers. More...
 

Public Attributes

Input physicalKeyInput
 Physical key input identifier. More...
 
int symbolicKeyCode
 Symbolic identifier of the key. More...
 
KeyModifiers keyModifiers
 Current key modifiers. More...
 
- Public Attributes inherited from donut::events::InputEventBase
std::uint32_t windowId
 Unique identifier of the window that this event belongs to, if any. More...
 

Detailed Description

Keyboard key Event base.

Member Typedef Documentation

◆ KeyModifiers

Bit set of key modifiers.

Member Enumeration Documentation

◆ KeyModifier

Key modifier bits.

Enumerator
MODIFIER_NONE 

No modifiers.

MODIFIER_LSHIFT 

Left shift.

MODIFIER_RSHIFT 

Right shift.

MODIFIER_LCTRL 

Left control.

MODIFIER_RCTRL 

Right control.

MODIFIER_LALT 

Left alt.

MODIFIER_RALT 

Right alt.

MODIFIER_LSUPER 

Left super.

MODIFIER_RSUPER 

Right super.

MODIFIER_NUM_LOCK 

Number lock.

MODIFIER_CAPS_LOCK 

Capital lock.

MODIFIER_MODE 

Mode.

MODIFIER_SCROLL_LOCK 

Scroll lock.

MODIFIER_CTRL 

Left or right control.

MODIFIER_SHIFT 

Left or right shift.

MODIFIER_ALT 

Left or right alt.

MODIFIER_SUPER 

Left or right super.

Member Data Documentation

◆ physicalKeyInput

Input donut::events::KeyEventBase::physicalKeyInput

Physical key input identifier.

◆ symbolicKeyCode

int donut::events::KeyEventBase::symbolicKeyCode

Symbolic identifier of the key.

◆ keyModifiers

KeyModifiers donut::events::KeyEventBase::keyModifiers

Current key modifiers.


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