summaryrefslogtreecommitdiff
path: root/src/core/hid/input_converter.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/core/hid/input_converter.h')
-rw-r--r--src/core/hid/input_converter.h23
1 files changed, 12 insertions, 11 deletions
diff --git a/src/core/hid/input_converter.h b/src/core/hid/input_converter.h
index 1492489d7..d24582226 100644
--- a/src/core/hid/input_converter.h
+++ b/src/core/hid/input_converter.h
@@ -21,7 +21,7 @@ namespace Core::HID {
21/** 21/**
22 * Converts raw input data into a valid battery status. 22 * Converts raw input data into a valid battery status.
23 * 23 *
24 * @param Supported callbacks: Analog, Battery, Trigger. 24 * @param callback Supported callbacks: Analog, Battery, Trigger.
25 * @return A valid BatteryStatus object. 25 * @return A valid BatteryStatus object.
26 */ 26 */
27Common::Input::BatteryStatus TransformToBattery(const Common::Input::CallbackStatus& callback); 27Common::Input::BatteryStatus TransformToBattery(const Common::Input::CallbackStatus& callback);
@@ -29,7 +29,7 @@ Common::Input::BatteryStatus TransformToBattery(const Common::Input::CallbackSta
29/** 29/**
30 * Converts raw input data into a valid button status. Applies invert properties to the output. 30 * Converts raw input data into a valid button status. Applies invert properties to the output.
31 * 31 *
32 * @param Supported callbacks: Analog, Button, Trigger. 32 * @param callback Supported callbacks: Analog, Button, Trigger.
33 * @return A valid TouchStatus object. 33 * @return A valid TouchStatus object.
34 */ 34 */
35Common::Input::ButtonStatus TransformToButton(const Common::Input::CallbackStatus& callback); 35Common::Input::ButtonStatus TransformToButton(const Common::Input::CallbackStatus& callback);
@@ -37,7 +37,7 @@ Common::Input::ButtonStatus TransformToButton(const Common::Input::CallbackStatu
37/** 37/**
38 * Converts raw input data into a valid motion status. 38 * Converts raw input data into a valid motion status.
39 * 39 *
40 * @param Supported callbacks: Motion. 40 * @param callback Supported callbacks: Motion.
41 * @return A valid TouchStatus object. 41 * @return A valid TouchStatus object.
42 */ 42 */
43Common::Input::MotionStatus TransformToMotion(const Common::Input::CallbackStatus& callback); 43Common::Input::MotionStatus TransformToMotion(const Common::Input::CallbackStatus& callback);
@@ -46,7 +46,7 @@ Common::Input::MotionStatus TransformToMotion(const Common::Input::CallbackStatu
46 * Converts raw input data into a valid stick status. Applies offset, deadzone, range and invert 46 * Converts raw input data into a valid stick status. Applies offset, deadzone, range and invert
47 * properties to the output. 47 * properties to the output.
48 * 48 *
49 * @param Supported callbacks: Stick. 49 * @param callback Supported callbacks: Stick.
50 * @return A valid StickStatus object. 50 * @return A valid StickStatus object.
51 */ 51 */
52Common::Input::StickStatus TransformToStick(const Common::Input::CallbackStatus& callback); 52Common::Input::StickStatus TransformToStick(const Common::Input::CallbackStatus& callback);
@@ -54,7 +54,7 @@ Common::Input::StickStatus TransformToStick(const Common::Input::CallbackStatus&
54/** 54/**
55 * Converts raw input data into a valid touch status. 55 * Converts raw input data into a valid touch status.
56 * 56 *
57 * @param Supported callbacks: Touch. 57 * @param callback Supported callbacks: Touch.
58 * @return A valid TouchStatus object. 58 * @return A valid TouchStatus object.
59 */ 59 */
60Common::Input::TouchStatus TransformToTouch(const Common::Input::CallbackStatus& callback); 60Common::Input::TouchStatus TransformToTouch(const Common::Input::CallbackStatus& callback);
@@ -63,7 +63,7 @@ Common::Input::TouchStatus TransformToTouch(const Common::Input::CallbackStatus&
63 * Converts raw input data into a valid trigger status. Applies offset, deadzone, range and 63 * Converts raw input data into a valid trigger status. Applies offset, deadzone, range and
64 * invert properties to the output. Button status uses the threshold property if necessary. 64 * invert properties to the output. Button status uses the threshold property if necessary.
65 * 65 *
66 * @param Supported callbacks: Analog, Button, Trigger. 66 * @param callback Supported callbacks: Analog, Button, Trigger.
67 * @return A valid TriggerStatus object. 67 * @return A valid TriggerStatus object.
68 */ 68 */
69Common::Input::TriggerStatus TransformToTrigger(const Common::Input::CallbackStatus& callback); 69Common::Input::TriggerStatus TransformToTrigger(const Common::Input::CallbackStatus& callback);
@@ -72,22 +72,23 @@ Common::Input::TriggerStatus TransformToTrigger(const Common::Input::CallbackSta
72 * Converts raw input data into a valid analog status. Applies offset, deadzone, range and 72 * Converts raw input data into a valid analog status. Applies offset, deadzone, range and
73 * invert properties to the output. 73 * invert properties to the output.
74 * 74 *
75 * @param Supported callbacks: Analog. 75 * @param callback Supported callbacks: Analog.
76 * @return A valid AnalogStatus object. 76 * @return A valid AnalogStatus object.
77 */ 77 */
78Common::Input::AnalogStatus TransformToAnalog(const Common::Input::CallbackStatus& callback); 78Common::Input::AnalogStatus TransformToAnalog(const Common::Input::CallbackStatus& callback);
79 79
80/** 80/**
81 * Converts raw analog data into a valid analog value 81 * Converts raw analog data into a valid analog value
82 * @param An analog object containing raw data and properties, bool that determines if the value 82 * @param analog An analog object containing raw data and properties
83 * needs to be clamped between -1.0f and 1.0f. 83 * @param clamp_value determines if the value needs to be clamped between -1.0f and 1.0f.
84 */ 84 */
85void SanitizeAnalog(Common::Input::AnalogStatus& analog, bool clamp_value); 85void SanitizeAnalog(Common::Input::AnalogStatus& analog, bool clamp_value);
86 86
87/** 87/**
88 * Converts raw stick data into a valid stick value 88 * Converts raw stick data into a valid stick value
89 * @param Two analog objects containing raw data and properties, bool that determines if the value 89 * @param analog_x raw analog data and properties for the x-axis
90 * needs to be clamped into the unit circle. 90 * @param analog_y raw analog data and properties for the y-axis
91 * @param clamp_value bool that determines if the value needs to be clamped into the unit circle.
91 */ 92 */
92void SanitizeStick(Common::Input::AnalogStatus& analog_x, Common::Input::AnalogStatus& analog_y, 93void SanitizeStick(Common::Input::AnalogStatus& analog_x, Common::Input::AnalogStatus& analog_y,
93 bool clamp_value); 94 bool clamp_value);