Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
kodi::addon::PeripheralEvent Class Reference

#include <PeripheralUtils.h>

Public Member Functions

 PeripheralEvent (void)
 
 PeripheralEvent (unsigned int peripheralIndex, unsigned int buttonIndex, JOYSTICK_STATE_BUTTON state)
 
 PeripheralEvent (unsigned int peripheralIndex, unsigned int hatIndex, JOYSTICK_STATE_HAT state)
 
 PeripheralEvent (unsigned int peripheralIndex, unsigned int axisIndex, JOYSTICK_STATE_AXIS state)
 
 PeripheralEvent (const PERIPHERAL_EVENT &event)
 
PERIPHERAL_EVENT_TYPE Type (void) const
 
unsigned int PeripheralIndex (void) const
 
unsigned int DriverIndex (void) const
 
JOYSTICK_STATE_BUTTON ButtonState (void) const
 
JOYSTICK_STATE_HAT HatState (void) const
 
JOYSTICK_STATE_AXIS AxisState (void) const
 
JOYSTICK_STATE_MOTOR MotorState (void) const
 
void SetType (PERIPHERAL_EVENT_TYPE type)
 
void SetPeripheralIndex (unsigned int index)
 
void SetDriverIndex (unsigned int index)
 
void SetButtonState (JOYSTICK_STATE_BUTTON state)
 
void SetHatState (JOYSTICK_STATE_HAT state)
 
void SetAxisState (JOYSTICK_STATE_AXIS state)
 
void SetMotorState (JOYSTICK_STATE_MOTOR state)
 
void ToStruct (PERIPHERAL_EVENT &event) const
 

Static Public Member Functions

static void FreeStruct (PERIPHERAL_EVENT &event)
 

Detailed Description

ADDON::PeripheralEvent

Wrapper class for peripheral events.

Constructor & Destructor Documentation

◆ PeripheralEvent() [1/5]

kodi::addon::PeripheralEvent::PeripheralEvent ( void  )
inline

◆ PeripheralEvent() [2/5]

kodi::addon::PeripheralEvent::PeripheralEvent ( unsigned int  peripheralIndex,
unsigned int  buttonIndex,
JOYSTICK_STATE_BUTTON  state 
)
inline

◆ PeripheralEvent() [3/5]

kodi::addon::PeripheralEvent::PeripheralEvent ( unsigned int  peripheralIndex,
unsigned int  hatIndex,
JOYSTICK_STATE_HAT  state 
)
inline

◆ PeripheralEvent() [4/5]

kodi::addon::PeripheralEvent::PeripheralEvent ( unsigned int  peripheralIndex,
unsigned int  axisIndex,
JOYSTICK_STATE_AXIS  state 
)
inline

◆ PeripheralEvent() [5/5]

kodi::addon::PeripheralEvent::PeripheralEvent ( const PERIPHERAL_EVENT event)
inlineexplicit

Member Function Documentation

◆ AxisState()

JOYSTICK_STATE_AXIS kodi::addon::PeripheralEvent::AxisState ( void  ) const
inline

◆ ButtonState()

JOYSTICK_STATE_BUTTON kodi::addon::PeripheralEvent::ButtonState ( void  ) const
inline

◆ DriverIndex()

unsigned int kodi::addon::PeripheralEvent::DriverIndex ( void  ) const
inline

◆ FreeStruct()

static void kodi::addon::PeripheralEvent::FreeStruct ( PERIPHERAL_EVENT event)
inlinestatic

◆ HatState()

JOYSTICK_STATE_HAT kodi::addon::PeripheralEvent::HatState ( void  ) const
inline

◆ MotorState()

JOYSTICK_STATE_MOTOR kodi::addon::PeripheralEvent::MotorState ( void  ) const
inline

◆ PeripheralIndex()

unsigned int kodi::addon::PeripheralEvent::PeripheralIndex ( void  ) const
inline

◆ SetAxisState()

void kodi::addon::PeripheralEvent::SetAxisState ( JOYSTICK_STATE_AXIS  state)
inline

◆ SetButtonState()

void kodi::addon::PeripheralEvent::SetButtonState ( JOYSTICK_STATE_BUTTON  state)
inline

◆ SetDriverIndex()

void kodi::addon::PeripheralEvent::SetDriverIndex ( unsigned int  index)
inline

◆ SetHatState()

void kodi::addon::PeripheralEvent::SetHatState ( JOYSTICK_STATE_HAT  state)
inline

◆ SetMotorState()

void kodi::addon::PeripheralEvent::SetMotorState ( JOYSTICK_STATE_MOTOR  state)
inline

◆ SetPeripheralIndex()

void kodi::addon::PeripheralEvent::SetPeripheralIndex ( unsigned int  index)
inline

◆ SetType()

void kodi::addon::PeripheralEvent::SetType ( PERIPHERAL_EVENT_TYPE  type)
inline

◆ ToStruct()

void kodi::addon::PeripheralEvent::ToStruct ( PERIPHERAL_EVENT event) const
inline

◆ Type()

PERIPHERAL_EVENT_TYPE kodi::addon::PeripheralEvent::Type ( void  ) const
inline

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