aboutsummaryrefslogtreecommitdiff
path: root/common/events.h
diff options
context:
space:
mode:
Diffstat (limited to 'common/events.h')
-rw-r--r--common/events.h18
1 files changed, 13 insertions, 5 deletions
diff --git a/common/events.h b/common/events.h
index e5bb8cab50..a514ea291e 100644
--- a/common/events.h
+++ b/common/events.h
@@ -90,22 +90,29 @@ enum EventType {
};
typedef uint32 CustomEventType;
+
/**
* Data structure for an event. A pointer to an instance of Event
* can be passed to pollEvent.
*/
struct Event {
+
/** The type of the event. */
EventType type;
- /** Flag to indicate if the event is real or synthetic. E.g. keyboard
- * repeat events are synthetic.
- */
- bool synthetic;
+
+ /**
+ * True if this is a key down repeat event.
+ *
+ * Only valid for EVENT_KEYDOWN events.
+ */
+ bool kbdRepeat;
+
/**
* Keyboard data; only valid for keyboard events (EVENT_KEYDOWN and
* EVENT_KEYUP). For all other event types, content is undefined.
*/
KeyState kbd;
+
/**
* The mouse coordinates, in virtual screen coordinates. Only valid
* for mouse events.
@@ -120,7 +127,7 @@ struct Event {
CustomEventType customType;
#endif
- Event() : type(EVENT_INVALID), synthetic(false) {
+ Event() : type(EVENT_INVALID), kbdRepeat(false) {
#ifdef ENABLE_KEYMAPPER
customType = 0;
#endif
@@ -383,6 +390,7 @@ public:
* @note called after graphics system has been set up
*/
virtual void init() {}
+
/**
* Get the next event in the event queue.
* @param event point to an Event struct, which will be filled with the event data.