Event Struct Reference

Struct for representing events and informations associated with them. More...

#include <Event.hpp>

Classes
struct	Modifiers
	A struct for storing the state of the keyboard modifier keys. More...

Public Attributes
EventType	type
	The event's type.
union {
Key   keyCode
	The key code associated with a keyPressed, keyReleased or keyRepeated event. More...
MouseInfo   mouse
	The mouse informations associated with mouse events. More...
glm::ivec2   scrollOffset
	The scroll wheel offset in a mouseScrolled event. More...
glm::ivec2   windowSize
	The new size of a window which have been resized. More...
};
Modifiers	mods
	A variable storing the state of the modifier keys.

Detailed Description

Struct for representing events and informations associated with them.

This structure holds information about an event, it is composed of a type, an information and the state of the modifier keys.

Warning

As the information is coded using an union, even though the event has multiple fields, only one is active at a time, so reading from the others is undefined. For example reading the mouse value of a keyPressed event is undefined behaviour. The information for each type of event is documented in the EventType enum documentation.

Definition at line 295 of file Event.hpp.

Member Data Documentation

keyCode

Key keyCode

The key code associated with a keyPressed, keyReleased or keyRepeated event.

Definition at line 320 of file Event.hpp.

mods

Modifiers mods

A variable storing the state of the modifier keys.

This variable stores the state of the modifer keys (alt, shift, ctr, ...) when the event was triggered. Note that not every type of event reports the modifier keys' state

Definition at line 347 of file Event.hpp.

mouse

MouseInfo mouse

The mouse informations associated with mouse events.

Definition at line 324 of file Event.hpp.

scrollOffset

glm::ivec2 scrollOffset

The scroll wheel offset in a mouseScrolled event.

'x' is the horizontal offset, and 'y' the vertical offset (a positive value indicates an upward movement).

Definition at line 331 of file Event.hpp.

type

EventType type

The event's type.

Definition at line 313 of file Event.hpp.

windowSize

glm::ivec2 windowSize

The new size of a window which have been resized.

'x' is the new width and 'y' the new height.

Definition at line 337 of file Event.hpp.

---

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

• Event.hpp