SaturnRingLibrary 0.9.1
SGL wrapper
 
Loading...
Searching...
No Matches
SRL::Input::Analog Struct Reference

Detailed Description

Generic analog peripheral.

#include <srl_input.hpp>

Inheritance diagram for SRL::Input::Analog:
SRL::Input::Digital SRL::Input::PeripheralGeneric

Public Types

enum  Axis {
  Axis1 = 0 , Axis2 , Axis3 , Axis4 ,
  Axis5 , Axis6
}
 Analog axis. More...
 
enum class  Button : uint16_t {
  Right = 1 << 15 , Left = 1 << 14 , Down = 1 << 13 , Up = 1 << 12 ,
  START = 1 << 11 , A = 1 << 10 , B = 1 << 8 , C = 1 << 9 ,
  X = 1 << 6 , Y = 1 << 5 , Z = 1 << 4 , R = 1 << 7 ,
  L = 1 << 3
}
 Digital gamepad buttons. More...
 

Public Member Functions

 Analog (const uint8_t &port)
 Construct a new analog peripheral handler.
 
virtual uint8_t GetAxis (const Axis axis) const
 Get current axis value.
 
PeripheralFamily GetFamily () const
 Gets connected peripheral type family.
 
PeripheralType GetType () const
 Gets connected peripheral type.
 
bool IsConnected () const override
 Indicates whether peripheral is connected or not.
 
virtual bool IsHeld (const Button &button) const
 Check if user is holding down a button.
 
virtual bool WasPressed (const Button &button) const
 Check if user pressed a button.
 
virtual bool WasReleased (const Button &button) const
 Check if user released a button.
 

Public Attributes

uint8_t Port = 0
 Port number peripheral is connected to.
 

Protected Member Functions

PerDigital * GetCurrentFrameState () const
 Get state of the peripheral in the current frame.
 
PerDigital * GetPreviousFrameState () const
 Get state of the peripheral in the previous frame.