CeresEngine::TextEvent Struct Reference

A structure that describes a text input event. More...

#include <CeresEngine/Input/InputEvent.hpp>

Inheritance diagram for CeresEngine::TextEvent:

Public Attributes
String	characters
	The characters associated with a key-up or key-down event.
Public Attributes inherited from CeresEngine::InputEvent
double	timestamp = 0.0
	The time when the event occurred in seconds since system startup.
PlatformWindow *	window = nullptr
	The platform window that triggered the input event, if any.

Static Public Attributes
static constexpr InputEventType	structType = InputEventType::Text
	A value that determines the type of event represented by this event struct.

Detailed Description

A structure that describes a text input event.

Member Data Documentation

characters

String CeresEngine::TextEvent::characters

The characters associated with a key-up or key-down event.

These characters are derived from a keyboard mapping that associates various key combinations with Unicode characters. This property is only valid for key-up and key-down events.

This property is set to an empty string for dead keys, such as ctrl-e. However, for a key combination such as Option-Shift-e this property is set to the standard accent ("´").

structType

constexpr InputEventType CeresEngine::TextEvent::structType = InputEventType::Text

inlinestaticconstexpr

A value that determines the type of event represented by this event struct.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Input/InputEvent.hpp