CeresEngine::MouseEvent Struct Reference

A structure that describes a mouse event. More...

#include <CeresEngine/Input/InputEvent.hpp>

Inheritance diagram for CeresEngine::MouseEvent:

Public Attributes
MouseEventType	type
	The type of mouse event represented by the event structure.
Button	button = Button::None
	The mouse button that has triggered the event.
ModifierButton	modifiers = ModifierButton::None
	The set of modifier keys pressed alongside this mouse button.
Vector2	position
	The position the mouse cursor was when the even got triggered.
Vector2	delta
	TODO: Write docs.
Vector2	scrollAmount
	If the event sub-type is of type scroll this field contains the amount the scroll wheel has moved.
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::Mouse
	A value that determines the type of event represented by this event struct.

Detailed Description

A structure that describes a mouse event.

Member Data Documentation

button

Button CeresEngine::MouseEvent::button = Button::None

The mouse button that has triggered the event.

delta

Vector2 CeresEngine::MouseEvent::delta

TODO: Write docs.

modifiers

ModifierButton CeresEngine::MouseEvent::modifiers = ModifierButton::None

The set of modifier keys pressed alongside this mouse button.

position

Vector2 CeresEngine::MouseEvent::position

The position the mouse cursor was when the even got triggered.

scrollAmount

Vector2 CeresEngine::MouseEvent::scrollAmount

If the event sub-type is of type scroll this field contains the amount the scroll wheel has moved.

structType

constexpr InputEventType CeresEngine::MouseEvent::structType = InputEventType::Mouse

inlinestaticconstexpr

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

type

MouseEventType CeresEngine::MouseEvent::type

The type of mouse event represented by the event structure.

---

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

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