aboutsummaryrefslogtreecommitdiff
path: root/common
diff options
context:
space:
mode:
authorBastien Bouclet2017-11-19 20:09:04 +0100
committerBastien Bouclet2017-11-19 20:16:10 +0100
commitacf87add2751ae68298f4d5b5480635d06b0ec5e (patch)
treed45a9ce19fb670cd09f2944860bb7c641eb0e9f2 /common
parentbc5ac6440ca8e62d40c68b40af2eb49f0da2c633 (diff)
downloadscummvm-rg350-acf87add2751ae68298f4d5b5480635d06b0ec5e.tar.gz
scummvm-rg350-acf87add2751ae68298f4d5b5480635d06b0ec5e.tar.bz2
scummvm-rg350-acf87add2751ae68298f4d5b5480635d06b0ec5e.zip
COMMON: Improve spacing between members in the event structs
Diffstat (limited to 'common')
-rw-r--r--common/events.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/common/events.h b/common/events.h
index d5eb59fdd4..a514ea291e 100644
--- a/common/events.h
+++ b/common/events.h
@@ -90,24 +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;
+
/**
* 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.
@@ -385,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.