diff options
| author | TSR Berry <20988865+TSRBerry@users.noreply.github.com> | 2023-04-08 01:22:00 +0200 |
|---|---|---|
| committer | Mary <thog@protonmail.com> | 2023-04-27 23:51:14 +0200 |
| commit | cee712105850ac3385cd0091a923438167433f9f (patch) | |
| tree | 4a5274b21d8b7f938c0d0ce18736d3f2993b11b1 /src/Ryujinx.Input/Assigner/IButtonAssigner.cs | |
| parent | cd124bda587ef09668a971fa1cac1c3f0cfc9f21 (diff) | |
Move solution and projects to src
Diffstat (limited to 'src/Ryujinx.Input/Assigner/IButtonAssigner.cs')
| -rw-r--r-- | src/Ryujinx.Input/Assigner/IButtonAssigner.cs | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/src/Ryujinx.Input/Assigner/IButtonAssigner.cs b/src/Ryujinx.Input/Assigner/IButtonAssigner.cs new file mode 100644 index 00000000..021736df --- /dev/null +++ b/src/Ryujinx.Input/Assigner/IButtonAssigner.cs @@ -0,0 +1,36 @@ +namespace Ryujinx.Input.Assigner +{ + /// <summary> + /// An interface that allows to gather the driver input info to assign to a button on the UI. + /// </summary> + public interface IButtonAssigner + { + /// <summary> + /// Initialize the button assigner. + /// </summary> + void Initialize(); + + /// <summary> + /// Read input. + /// </summary> + void ReadInput(); + + /// <summary> + /// Check if a button was pressed. + /// </summary> + /// <returns>True if a button was pressed</returns> + bool HasAnyButtonPressed(); + + /// <summary> + /// Indicate if the user of this API should cancel operations. This is triggered for example when a gamepad get disconnected or when a user cancel assignation operations. + /// </summary> + /// <returns>True if the user of this API should cancel operations</returns> + bool ShouldCancel(); + + /// <summary> + /// Get the pressed button that was read in <see cref="ReadInput"/> by the button assigner. + /// </summary> + /// <returns>The pressed button that was read</returns> + string GetPressedButton(); + } +}
\ No newline at end of file |