Pioneer
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
InputBindings::KeyBinding Struct Reference

#include <InputBindings.h>

Public Types

enum class  Type : uint8_t {
  Disabled , KeyboardKey , JoystickButton , JoystickHat ,
  MouseButton
}
 

Public Member Functions

 KeyBinding ()=default
 
 KeyBinding (SDL_Keycode k)
 
bool Enabled () const
 
Response Matches (const SDL_Event &ev) const
 
bool operator== (const KeyBinding &rhs) const
 
bool operator< (const KeyBinding &rhs) const
 

Static Public Member Functions

static KeyBinding JoystickButton (uint16_t joystickID, uint8_t button)
 
static KeyBinding JoystickHat (uint16_t joystickID, uint8_t hat, uint8_t direction)
 
static KeyBinding MouseButton (uint8_t mouseButton)
 
static KeyBinding FromEvent (SDL_Event &event)
 

Public Attributes

Type type = Type::Disabled
 
union { 
 
   SDL_Keycode   keycode = 0 
 
   struct { 
 
      uint16_t   id 
 
      uint8_t   button 
 
      uint8_t   hat 
 
   }   joystick 
 
   struct { 
 
      uint8_t   button 
 
   }   mouse 
 
};  
 

Friends

std::string_view & operator>> (std::string_view &, KeyBinding &)
 
std::ostream & operator<< (std::ostream &, const KeyBinding &)
 

Member Enumeration Documentation

◆ Type

enum class InputBindings::KeyBinding::Type : uint8_t
strong
Enumerator
Disabled 
KeyboardKey 
JoystickButton 
JoystickHat 
MouseButton 

Constructor & Destructor Documentation

◆ KeyBinding() [1/2]

InputBindings::KeyBinding::KeyBinding ( )
default

◆ KeyBinding() [2/2]

InputBindings::KeyBinding::KeyBinding ( SDL_Keycode  k)
inline

Member Function Documentation

◆ Enabled()

bool InputBindings::KeyBinding::Enabled ( ) const
inline

◆ FromEvent()

static KeyBinding InputBindings::KeyBinding::FromEvent ( SDL_Event &  event)
static

◆ JoystickButton()

static KeyBinding InputBindings::KeyBinding::JoystickButton ( uint16_t  joystickID,
uint8_t  button 
)
inlinestatic

◆ JoystickHat()

static KeyBinding InputBindings::KeyBinding::JoystickHat ( uint16_t  joystickID,
uint8_t  hat,
uint8_t  direction 
)
inlinestatic

◆ Matches()

Response KeyBinding::Matches ( const SDL_Event &  ev) const
Here is the call graph for this function:

◆ MouseButton()

static KeyBinding InputBindings::KeyBinding::MouseButton ( uint8_t  mouseButton)
inlinestatic

◆ operator<()

bool KeyBinding::operator< ( const KeyBinding rhs) const

◆ operator==()

bool KeyBinding::operator== ( const KeyBinding rhs) const

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  ,
const KeyBinding  
)
friend

◆ operator>>

std::string_view & operator>> ( std::string_view &  ,
KeyBinding  
)
friend

Member Data Documentation

◆ [union]

◆ button

uint8_t InputBindings::KeyBinding::button

◆ hat

uint8_t InputBindings::KeyBinding::hat

◆ id

uint16_t InputBindings::KeyBinding::id

◆ [struct]

struct { ... } InputBindings::KeyBinding::joystick

◆ keycode

SDL_Keycode InputBindings::KeyBinding::keycode = 0

◆ [struct]

struct { ... } InputBindings::KeyBinding::mouse

◆ type

Type InputBindings::KeyBinding::type = Type::Disabled

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