Aspen
2D C++ Class-Based Object Oriented Game Engine
Aspen::Input Namespace Reference

Input namespace Contains classes and functions for tracking and retrieving user input information. More...

Classes

class  Axis
 Input axis class. More...
 
class  Key
 Key status class. More...
 
class  Mouse
 Mouse data. More...
 

Functions

KeyGetKey (SDL_Keycode k)
 Gets a Key reference from a hidden map Creates a new Key reference if one does not yet exist for the provided SDL_Keycode.
 
bool KeyHeld (SDL_Keycode k)
 Gets the held state of a Key. More...
 
bool KeyPressed (SDL_Keycode k)
 Gets the pressed state of a Key. More...
 
bool KeyReleased (SDL_Keycode k)
 Gets the released state of a Key. More...
 
MouseGetMouse ()
 Gets the mouse data. More...
 

Detailed Description

Input namespace Contains classes and functions for tracking and retrieving user input information.

Function Documentation

◆ GetMouse()

Mouse& Aspen::Input::GetMouse ( )

Gets the mouse data.

Returns
Mouse data

◆ KeyHeld()

bool Aspen::Input::KeyHeld ( SDL_Keycode  k)

Gets the held state of a Key.

Parameters
kKeycode to check
Returns
held state of the Key held at GetKey(k)

◆ KeyPressed()

bool Aspen::Input::KeyPressed ( SDL_Keycode  k)

Gets the pressed state of a Key.

Parameters
kKeycode to check
Returns
pressed state of the Key held at GetKey(k)

◆ KeyReleased()

bool Aspen::Input::KeyReleased ( SDL_Keycode  k)

Gets the released state of a Key.

Parameters
kKeycode to check
Returns
released state of the Key held at GetKey(k)