ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Describes an available hardware input. More...

#include <hardware-input.h>

Collaboration diagram for Common::HardwareInput:

List of all members.

Public Member Functions

 HardwareInput ()

Static Public Member Functions

static HardwareInput createCustom (const String &i, HardwareInputCode ic, const String &desc)
static HardwareInput createKeyboard (const String &i, KeyState ky, const String &desc)
static HardwareInput createJoystickButton (const String &i, uint8 button, const String &desc)
static HardwareInput createJoystickHalfAxis (const String &i, uint8 axis, bool positiveHalf, const String &desc)
static HardwareInput createMouse (const String &i, uint8 button, const String &desc)

Public Attributes

String id
 unique id used for saving/loading to config
String description
 Human readable description.
HardwareInputType type
 Type tag.
HardwareInputCode inputCode
 A platform specific unique identifier for an input event generated when this input is triggered.
KeyState key
 The KeyState that is generated by the back-end when this hardware key is pressed.

Static Private Member Functions

static HardwareInput createSimple (HardwareInputType type, const String &i, HardwareInputCode ic, const String &desc)

Detailed Description

Describes an available hardware input.

Definition at line 55 of file hardware-input.h.


Constructor & Destructor Documentation

Common::HardwareInput::HardwareInput (  )  [inline]

Definition at line 79 of file hardware-input.h.


Member Function Documentation

static HardwareInput Common::HardwareInput::createCustom ( const String i,
HardwareInputCode  ic,
const String desc 
) [inline, static]

Definition at line 82 of file hardware-input.h.

static HardwareInput Common::HardwareInput::createJoystickButton ( const String i,
uint8  button,
const String desc 
) [inline, static]

Definition at line 96 of file hardware-input.h.

static HardwareInput Common::HardwareInput::createJoystickHalfAxis ( const String i,
uint8  axis,
bool  positiveHalf,
const String desc 
) [inline, static]

Definition at line 100 of file hardware-input.h.

static HardwareInput Common::HardwareInput::createKeyboard ( const String i,
KeyState  ky,
const String desc 
) [inline, static]

Definition at line 86 of file hardware-input.h.

static HardwareInput Common::HardwareInput::createMouse ( const String i,
uint8  button,
const String desc 
) [inline, static]

Definition at line 104 of file hardware-input.h.

static HardwareInput Common::HardwareInput::createSimple ( HardwareInputType  type,
const String i,
HardwareInputCode  ic,
const String desc 
) [inline, static, private]

Definition at line 109 of file hardware-input.h.


Member Data Documentation

Human readable description.

Definition at line 60 of file hardware-input.h.

unique id used for saving/loading to config

Definition at line 57 of file hardware-input.h.

A platform specific unique identifier for an input event generated when this input is triggered.

This is only relevant when type == kHardwareInputTypeGeneric

Definition at line 70 of file hardware-input.h.

The KeyState that is generated by the back-end when this hardware key is pressed.

This is only relevant when type == kHardwareInputTypeKeyboard

Definition at line 77 of file hardware-input.h.

Type tag.

Definition at line 63 of file hardware-input.h.


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


Generated on Sat Jun 27 2020 05:02:20 for ResidualVM by doxygen 1.7.1
curved edge   curved edge