galaxy 1.0.0
Real-Time C++23 Game Programming Framework. Built on data-driven design principles and agile software engineering.
Loading...
Searching...
No Matches
galaxy::KeyReleased Struct Referencefinal

Contains data on key that was released. More...

#include <KeyReleased.hpp>

+ Inheritance diagram for galaxy::KeyReleased:
+ Collaboration diagram for galaxy::KeyReleased:

Public Member Functions

 KeyReleased (const SDL_Scancode scancode, const Keys key, const KeyMods mod, const unsigned short raw, const bool repeat) noexcept
 Constructor.
 
- Public Member Functions inherited from galaxy::Event
 Event () noexcept
 Constructor.
 
 Event (Event &&) noexcept
 Move constructor.
 
Eventoperator= (Event &&) noexcept
 Move assignment operator.
 
 Event (const Event &) noexcept
 Copy constructor.
 
Eventoperator= (const Event &) noexcept
 Copy assignment operator.
 
virtual ~Event () noexcept
 Destructor.
 
void consume () noexcept
 Mark this event as consumed.
 
bool consumed () const noexcept
 Is this event already consumed?
 

Public Attributes

SDL_Scancode m_scancode = SDL_SCANCODE_UNKNOWN
 SDL physical key code.
 
Keys m_key = Keys::KEY_UNKNOWN
 SDL virtual key code.
 
KeyMods m_mod = KeyMods::MOD_NONE
 Current key modifiers.
 
unsigned short m_raw = 0
 The platform dependent scancode for this event.
 
bool m_repeat = false
 True if this is a key repeat.
 

Additional Inherited Members

- Protected Attributes inherited from galaxy::Event
bool m_handled
 Keeps track if event has been used already.
 

Detailed Description

Contains data on key that was released.

Definition at line 19 of file KeyReleased.hpp.

Constructor & Destructor Documentation

◆ KeyReleased()

galaxy::KeyReleased::KeyReleased ( const SDL_Scancode scancode,
const Keys key,
const KeyMods mod,
const unsigned short raw,
const bool repeat )
noexcept

Constructor.

Parameters
scancodeSDL physical key code.
keySDL virtual key code.
modCurrent key modifiers.
rawThe platform dependent scancode for this event.
repeatTrue if this is a key repeat.

Definition at line 12 of file KeyReleased.cpp.

Member Data Documentation

◆ m_scancode

SDL_Scancode galaxy::KeyReleased::m_scancode = SDL_SCANCODE_UNKNOWN

SDL physical key code.

Definition at line 35 of file KeyReleased.hpp.

◆ m_key

Keys galaxy::KeyReleased::m_key = Keys::KEY_UNKNOWN

SDL virtual key code.

Definition at line 40 of file KeyReleased.hpp.

◆ m_mod

KeyMods galaxy::KeyReleased::m_mod = KeyMods::MOD_NONE

Current key modifiers.

Definition at line 45 of file KeyReleased.hpp.

◆ m_raw

unsigned short galaxy::KeyReleased::m_raw = 0

The platform dependent scancode for this event.

Definition at line 50 of file KeyReleased.hpp.

◆ m_repeat

bool galaxy::KeyReleased::m_repeat = false

True if this is a key repeat.

Definition at line 55 of file KeyReleased.hpp.


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