An object that contains information about an input action such as a mouse click or a key press. More...

#include <CeresEngine/UI/UIEvent.hpp>

Inheritance diagram for CeresEngine::UIEvent:

Public Attributes
UIEventType	type
	The event's type.

double	timestamp = 0.0
	The time when the event occurred in seconds since system startup.

UIWindow *	window = nullptr
	The window object associated with the event.

UIModifierKeys	modifiers = {}
	An integer bit field indicating the event's modifier keys.

Detailed Description

An object that contains information about an input action such as a mouse click or a key press.

CeresEngine associates each user action, such as a mouse click, with a window and reports the event to the application that created the window. The UIEvent object contains pertinent information about each event, such as where the cursor was located or which character was typed. As the framework receives events, it temporarily places them in a buffer called the event queue. When the application is ready to process an event, it takes one from the queue.

Member Data Documentation

◆ modifiers

UIModifierKeys CeresEngine::UIEvent::modifiers = {}

An integer bit field indicating the event's modifier keys.

◆ timestamp

double CeresEngine::UIEvent::timestamp = 0.0

The time when the event occurred in seconds since system startup.

◆ type

UIEventType CeresEngine::UIEvent::type

The event's type.

◆ window

UIWindow* CeresEngine::UIEvent::window = nullptr

The window object associated with the event.

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