ScummVM API documentation
Common::HardwareInput Struct Reference

#include <hardware-input.h>

Static Public Member Functions

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

Public Attributes

String id
 
U32String description
 
HardwareInputType type
 
HardwareInputCode inputCode
 
KeyState key
 

Detailed Description

Describes an available hardware input

Member Data Documentation

◆ id

String Common::HardwareInput::id

unique id used for saving/loading to config

◆ description

U32String Common::HardwareInput::description

Human readable description

◆ type

HardwareInputType Common::HardwareInput::type

Type tag

◆ inputCode

HardwareInputCode Common::HardwareInput::inputCode

A platform specific unique identifier for an input event generated when this input is triggered. This is only relevant when type == kHardwareInputTypeGeneric

◆ key

KeyState Common::HardwareInput::key

The KeyState that is generated by the back-end when this hardware key is pressed. This is only relevant when type == kHardwareInputTypeKeyboard


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