diff options
| -rw-r--r-- | common/events.h | 6 |
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. |