Compare commits

...

5 Commits

Author SHA1 Message Date
CrackThrough 87235b8f27 chore: newline at the end of the file 2022-11-06 22:47:16 +09:00
CrackThrough 7eae03362b feat: KeyLabel enum 2022-11-06 22:46:39 +09:00
CrackThrough 06407c97a1 fix: add missing docs for public/internal members 2022-11-06 22:46:21 +09:00
CrackThrough 58581a7c53 fix: xml docs
feat: use label
2022-11-06 22:11:11 +09:00
CrackThrough 9d97a7ce72 chore: update windows native library 2022-11-06 22:10:07 +09:00
6 changed files with 243 additions and 41 deletions

View File

@ -3,27 +3,189 @@ using System.Runtime.InteropServices;
namespace SkyHook namespace SkyHook
{ {
/// <summary>
/// Recorded key updates from SkyHook.
/// </summary>
[StructLayout(LayoutKind.Sequential)] [StructLayout(LayoutKind.Sequential)]
[SuppressMessage("ReSharper", "MemberCanBePrivate.Global")] [SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
public struct SkyHookEvent public struct SkyHookEvent
{ {
/// <summary> /// <summary>
/// When the key was pressed /// When the key's state was updated.
/// </summary> /// </summary>
public readonly ulong Time; public readonly ulong Time;
/// <summary> /// <summary>
/// The key is pressed or released /// Whether the key is pressed or released.
/// </summary> /// </summary>
public readonly EventType Type; public readonly EventType Type;
/// <summary> /// <summary>
/// The key number that was pressed or released /// The identified key label from the native assembly.
/// </summary> /// </summary>
public readonly uint Key; public readonly KeyLabel Label;
/// <summary>
/// The key number that was pressed or released.
/// </summary>
public readonly ushort Key;
} }
/// <summary>
/// The type of <see cref="SkyHookEvent"/>'s event.
/// </summary>
[SuppressMessage("ReSharper", "UnusedMember.Global")]
public enum EventType public enum EventType
{ {
KeyPressed, KeyPressed,
KeyReleased KeyReleased
} }
/// <summary>
/// The key label identified by native SkyHook.
/// This label will be the same regardless of what OS the player is in.
/// <br/>
/// This is a direct import of the https://git.pikokr.dev/SkyHook/SkyHook/src/branch/main/skyhook/src/keycodes.rs native enum.
/// </summary>
[SuppressMessage("ReSharper", "UnusedMember.Global")]
public enum KeyLabel : ushort
{
Escape,
// Function Keys
F1,
F2,
F3,
F4,
F5,
F6,
F7,
F8,
F9,
F10,
F11,
F12,
F13,
F14,
F15,
F16,
F17,
F18,
F19,
F20,
F21,
F22,
F23,
F24,
// 2nd Layer
Grave,
Alpha1,
Alpha2,
Alpha3,
Alpha4,
Alpha5,
Alpha6,
Alpha7,
Alpha8,
Alpha9,
Alpha0,
Minus,
Equal,
Backspace,
// 3rd Layer
Tab,
Q,
W,
E,
R,
T,
Y,
U,
I,
O,
P,
LeftBrace,
RightBrace,
BackSlash,
// 4th Layer
CapsLock,
A,
S,
D,
F,
G,
H,
J,
K,
L,
Semicolon,
Apostrophe,
Enter,
// 5th Layer
LShift,
Z,
X,
C,
V,
B,
N,
M,
Comma,
Dot,
Slash,
RShift,
// 6th Layer
LControl,
Super,
LAlt,
Space,
RAlt,
RControl,
// Controls
PrintScreen,
ScrollLock,
PauseBreak,
Insert,
Home,
PageUp,
Delete,
End,
PageDown,
ArrowUp,
ArrowLeft,
ArrowDown,
ArrowRight,
// Keypad
NumLock,
KeypadSlash,
KeypadAsterisk,
KeypadMinus,
Keypad1,
Keypad2,
Keypad3,
Keypad4,
Keypad5,
Keypad6,
Keypad7,
Keypad8,
Keypad9,
Keypad0,
KeypadDot,
KeypadPlus,
KeypadEnter,
// Mouse
MouseLeft,
MouseRight,
MouseMiddle,
MouseX1,
MouseX2,
// Uncategorized
Unknown
}
} }

View File

@ -2,8 +2,15 @@ using System;
namespace SkyHook namespace SkyHook
{ {
/// <summary>
/// An <see cref="Exception"/> that specifically occurred in SkyHook.
/// </summary>
public class SkyHookException : Exception public class SkyHookException : Exception
{ {
/// <summary>
/// Initializes an instance of <see cref="SkyHookException"/>.
/// </summary>
/// <param name="message">A message to pass along with exception.</param>
public SkyHookException(string message) : base(message) { } public SkyHookException(string message) : base(message) { }
} }
} }

View File

@ -1,34 +1,46 @@
using System; using System;
using System.Threading; using System.Threading;
using System.Threading.Tasks;
using UnityEngine; using UnityEngine;
using UnityEngine.Events; using UnityEngine.Events;
namespace SkyHook namespace SkyHook
{ {
/// <summary>
/// Manages SkyHook activity.
/// A "<see cref="GameObject.DontDestroyOnLoad"/>ed" instance will be created automatically upon use.
/// </summary>
public class SkyHookManager : MonoBehaviour public class SkyHookManager : MonoBehaviour
{ {
private static SkyHookManager _instance; private static SkyHookManager _instance;
/// <summary>
/// Whether this process is focused.
/// </summary>
public static bool IsFocused; public static bool IsFocused;
/// <summary> /// <summary>
/// Whether or not the event will be received only if the game window is focused. /// Whether or the event will be received only if the game window is focused.
/// Note that only down key events will be ignored.
/// </summary> /// </summary>
// ReSharper disable once MemberCanBePrivate.Global // ReSharper disable once MemberCanBePrivate.Global
// ReSharper disable once FieldCanBeMadeReadOnly.Global // ReSharper disable once FieldCanBeMadeReadOnly.Global
public bool requireFocus = true; public bool requireFocus = true;
/// <summary>
/// Whether the hook is active now.
/// </summary>
public bool isHookActive; public bool isHookActive;
/// <summary> /// <summary>
/// The key updated event data /// Your callback for each key updated events.
/// Use <see cref="UnityEvent.AddListener"/> to register your callback.
/// </summary> /// </summary>
// ReSharper disable once MemberCanBePrivate.Global // ReSharper disable once MemberCanBePrivate.Global
public static readonly UnityEvent<SkyHookEvent> KeyUpdated = new(); public static readonly UnityEvent<SkyHookEvent> KeyUpdated = new();
/// <summary> /// <summary>
/// The instance of sky hook manager. The instance will be created if it does not exist /// The instance of <see cref="SkyHookManager"/>.
/// A new instance will be created if it does not exist.
/// </summary> /// </summary>
// ReSharper disable once MemberCanBePrivate.Global // ReSharper disable once MemberCanBePrivate.Global
public static SkyHookManager Instance public static SkyHookManager Instance
@ -105,11 +117,17 @@ namespace SkyHook
isHookActive = false; isHookActive = false;
} }
/// <summary>
/// Starts the native hook.
/// </summary>
public static void StartHook() public static void StartHook()
{ {
Instance._StartHook(); Instance._StartHook();
} }
/// <summary>
/// Stops the native hook.
/// </summary>
public static void StopHook() public static void StopHook()
{ {
Instance._StopHook(); Instance._StopHook();

View File

@ -2,15 +2,30 @@ using System.Runtime.InteropServices;
namespace SkyHook namespace SkyHook
{ {
/// <summary>
/// Native method calls for SkyHook.
/// </summary>
internal static class SkyHookNative internal static class SkyHookNative
{ {
/// <summary>
/// The native callback handled by <see cref="SkyHookManager"/>.
/// </summary>
public delegate void Callback(SkyHookEvent ev); public delegate void Callback(SkyHookEvent ev);
private const string Lib = "skyhook"; private const string Lib = "skyhook";
/// <summary>
/// The native version of <see cref="SkyHookManager.StartHook"/> method handled by <see cref="SkyHookManager"/>.
/// </summary>
/// <param name="callback">A native callback.</param>
/// <returns><c>null</c> if no error, or an error message.</returns>
[DllImport(Lib, EntryPoint = "start_hook", CallingConvention = CallingConvention.Cdecl)] [DllImport(Lib, EntryPoint = "start_hook", CallingConvention = CallingConvention.Cdecl)]
public static extern string StartHook(Callback callback); public static extern string StartHook(Callback callback);
/// <summary>
/// The native version of <see cref="SkyHookManager.StopHook"/> method handled by <see cref="SkyHookManager"/>.
/// </summary>
/// <returns><c>null</c> if no error, or an error message.</returns>
[DllImport(Lib, EntryPoint = "stop_hook", CallingConvention = CallingConvention.Cdecl)] [DllImport(Lib, EntryPoint = "stop_hook", CallingConvention = CallingConvention.Cdecl)]
public static extern string StopHook(); public static extern string StopHook();
} }

Binary file not shown.

Binary file not shown.