diff options
Diffstat (limited to 'src/input_common/input_mapping.h')
| -rw-r--r-- | src/input_common/input_mapping.h | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/src/input_common/input_mapping.h b/src/input_common/input_mapping.h index 44eb8ad9a..93564b5f8 100644 --- a/src/input_common/input_mapping.h +++ b/src/input_common/input_mapping.h | |||
| @@ -14,8 +14,8 @@ public: | |||
| 14 | MappingFactory(); | 14 | MappingFactory(); |
| 15 | 15 | ||
| 16 | /** | 16 | /** |
| 17 | * Resets all varables to beggin the mapping process | 17 | * Resets all variables to begin the mapping process |
| 18 | * @param "type": type of input desired to be returned | 18 | * @param type type of input desired to be returned |
| 19 | */ | 19 | */ |
| 20 | void BeginMapping(Polling::InputType type); | 20 | void BeginMapping(Polling::InputType type); |
| 21 | 21 | ||
| @@ -24,8 +24,8 @@ public: | |||
| 24 | 24 | ||
| 25 | /** | 25 | /** |
| 26 | * Registers mapping input data from the driver | 26 | * Registers mapping input data from the driver |
| 27 | * @param "data": An struct containing all the information needed to create a proper | 27 | * @param data A struct containing all the information needed to create a proper |
| 28 | * ParamPackage | 28 | * ParamPackage |
| 29 | */ | 29 | */ |
| 30 | void RegisterInput(const MappingData& data); | 30 | void RegisterInput(const MappingData& data); |
| 31 | 31 | ||
| @@ -34,42 +34,42 @@ public: | |||
| 34 | 34 | ||
| 35 | private: | 35 | private: |
| 36 | /** | 36 | /** |
| 37 | * If provided data satisfies the requeriments it will push an element to the input_queue | 37 | * If provided data satisfies the requirements it will push an element to the input_queue |
| 38 | * Supported input: | 38 | * Supported input: |
| 39 | * - Button: Creates a basic button ParamPackage | 39 | * - Button: Creates a basic button ParamPackage |
| 40 | * - HatButton: Creates a basic hat button ParamPackage | 40 | * - HatButton: Creates a basic hat button ParamPackage |
| 41 | * - Analog: Creates a basic analog ParamPackage | 41 | * - Analog: Creates a basic analog ParamPackage |
| 42 | * @param "data": An struct containing all the information needed to create a proper | 42 | * @param data A struct containing all the information needed to create a proper |
| 43 | * ParamPackage | 43 | * ParamPackage |
| 44 | */ | 44 | */ |
| 45 | void RegisterButton(const MappingData& data); | 45 | void RegisterButton(const MappingData& data); |
| 46 | 46 | ||
| 47 | /** | 47 | /** |
| 48 | * If provided data satisfies the requeriments it will push an element to the input_queue | 48 | * If provided data satisfies the requirements it will push an element to the input_queue |
| 49 | * Supported input: | 49 | * Supported input: |
| 50 | * - Button, HatButton: Pass the data to RegisterButton | 50 | * - Button, HatButton: Pass the data to RegisterButton |
| 51 | * - Analog: Stores the first axis and on the second axis creates a basic stick ParamPackage | 51 | * - Analog: Stores the first axis and on the second axis creates a basic stick ParamPackage |
| 52 | * @param "data": An struct containing all the information needed to create a proper | 52 | * @param data A struct containing all the information needed to create a proper |
| 53 | * ParamPackage | 53 | * ParamPackage |
| 54 | */ | 54 | */ |
| 55 | void RegisterStick(const MappingData& data); | 55 | void RegisterStick(const MappingData& data); |
| 56 | 56 | ||
| 57 | /** | 57 | /** |
| 58 | * If provided data satisfies the requeriments it will push an element to the input_queue | 58 | * If provided data satisfies the requirements it will push an element to the input_queue |
| 59 | * Supported input: | 59 | * Supported input: |
| 60 | * - Button, HatButton: Pass the data to RegisterButton | 60 | * - Button, HatButton: Pass the data to RegisterButton |
| 61 | * - Analog: Stores the first two axis and on the third axis creates a basic Motion | 61 | * - Analog: Stores the first two axis and on the third axis creates a basic Motion |
| 62 | * ParamPackage | 62 | * ParamPackage |
| 63 | * - Motion: Creates a basic Motion ParamPackage | 63 | * - Motion: Creates a basic Motion ParamPackage |
| 64 | * @param "data": An struct containing all the information needed to create a proper | 64 | * @param data A struct containing all the information needed to create a proper |
| 65 | * ParamPackage | 65 | * ParamPackage |
| 66 | */ | 66 | */ |
| 67 | void RegisterMotion(const MappingData& data); | 67 | void RegisterMotion(const MappingData& data); |
| 68 | 68 | ||
| 69 | /** | 69 | /** |
| 70 | * Returns true if driver can be mapped | 70 | * Returns true if driver can be mapped |
| 71 | * @param "data": An struct containing all the information needed to create a proper | 71 | * @param data A struct containing all the information needed to create a proper |
| 72 | * ParamPackage | 72 | * ParamPackage |
| 73 | */ | 73 | */ |
| 74 | bool IsDriverValid(const MappingData& data) const; | 74 | bool IsDriverValid(const MappingData& data) const; |
| 75 | 75 | ||