ECSTASY
All in the name
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
ecstasy::integration::event::KeyEvent Struct Reference

Event describing a key pressed or released. More...

#include <KeyEvent.hpp>

Inheritance diagram for ecstasy::integration::event::KeyEvent:
Inheritance graph
[legend]

Public Member Functions

constexpr KeyEvent (Keyboard::Key pKey, bool pPressed=true) noexcept
 Construct a new KeyEvent object.
 

Public Attributes

Keyboard::Key key
 Target key.
 
bool pressed
 Whether the key is pressed (down) or not (up).
 

Detailed Description

Event describing a key pressed or released.

Author
Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)
Since
1.0.0 (2022-11-17)

Definition at line 25 of file KeyEvent.hpp.

Constructor & Destructor Documentation

◆ KeyEvent()

constexpr ecstasy::integration::event::KeyEvent::KeyEvent ( Keyboard::Key  pKey,
bool  pPressed = true 
)
inlineconstexprnoexcept

Construct a new KeyEvent object.

Parameters
[in]pKeyTargeted key.
[in]pPressedWhether the key is pressed or not.
Author
Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)
Since
1.0.0 (2022-11-06)

Definition at line 40 of file KeyEvent.hpp.

40 : key(pKey), pressed(pPressed)
41 {
42 }
ecstasy::integration::event::KeyEvent::pressed
bool pressed
Whether the key is pressed (down) or not (up).
Definition KeyEvent.hpp:29
ecstasy::integration::event::KeyEvent::key
Keyboard::Key key
Target key.
Definition KeyEvent.hpp:27

Member Data Documentation

◆ key

Keyboard::Key ecstasy::integration::event::KeyEvent::key

Target key.

Definition at line 27 of file KeyEvent.hpp.

◆ pressed

bool ecstasy::integration::event::KeyEvent::pressed

Whether the key is pressed (down) or not (up).

Definition at line 29 of file KeyEvent.hpp.

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