[Input] Added Cursor class;

Author: LittleCodingFox

Engine/Core/Input/Cursor.cs

@@ -0,0 +1,94 @@
+using Staple.Internal;
+
+namespace Staple;
+
+public static class Cursor
+{
+    internal static IRenderWindow window;
+
+    private static CursorLockMode lockState = CursorLockMode.None;
+
+    /// <summary>
+    /// The current lock state of the cursor
+    /// </summary>
+    public static CursorLockMode LockState
+    {
+        get => lockState;
+
+        set
+        {
+            lockState = value;
+
+            switch(value)
+            {
+                case CursorLockMode.None:
+
+                    UnlockCursor();
+
+                    break;
+
+                case CursorLockMode.Locked:
+
+                    LockCursor();
+
+                    break;
+            }
+        }
+    }
+
+    internal static bool visible = true;
+
+    /// <summary>
+    /// Whether the cursor is visible
+    /// </summary>
+    public static bool Visible
+    {
+        get => visible;
+
+        set
+        {
+            visible = value;
+
+            if(visible)
+            {
+                ShowCursor();
+            }
+            else
+            {
+                HideCursor();
+            }
+        }
+    }
+
+    /// <summary>
+    /// Locks the cursor to the window
+    /// </summary>
+    internal static void LockCursor()
+    {
+        window.LockCursor();
+    }
+
+    /// <summary>
+    /// Unlocks the cursor
+    /// </summary>
+    internal static void UnlockCursor()
+    {
+        window.UnlockCursor();
+    }
+
+    /// <summary>
+    /// Hides the cursor
+    /// </summary>
+    internal static void HideCursor()
+    {
+        window.HideCursor();
+    }
+
+    /// <summary>
+    /// Shows the cursor
+    /// </summary>
+    internal static void ShowCursor()
+    {
+        window.ShowCursor();
+    }
+}

Engine/Core/Input/CursorLockMode.cs

@@ -0,0 +1,17 @@
+namespace Staple;
+
+/// <summary>
+/// How the mouse cursor should be handled
+/// </summary>
+public enum CursorLockMode
+{
+    /// <summary>
+    /// Not locked to the window at all
+    /// </summary>
+    None,
+
+    /// <summary>
+    /// Locked to the center of the window
+    /// </summary>
+    Locked,
+}

Engine/Core/Input/Input.cs

@@ -537,14 +537,21 @@ internal static void CursorPosCallback(float xpos, float ypos)
     {
         var newPos = new Vector2(xpos, ypos);
 
-        if(MousePosition == Vector2.Zero)
+        if(Cursor.LockState == CursorLockMode.Locked)
         {
-            previousMousePosition = newPos;
+            MouseRelativePosition = newPos;
         }
+        else
+        {
+            if (MousePosition == Vector2.Zero)
+            {
+                previousMousePosition = newPos;
+            }
 
-        MousePosition = newPos;
+            MousePosition = newPos;
 
-        MouseRelativePosition = newPos - previousMousePosition;
+            MouseRelativePosition = newPos - previousMousePosition;
+        }
     }
 
     internal static void HandleTextEvent(AppEvent appEvent)
@@ -780,38 +787,6 @@ public static Vector2 GetGamepadRightAxis(int index)
             GetGamepadAxis(index, GamepadAxis.RightY));
     }
 
-    /// <summary>
-    /// Locks the cursor to the window
-    /// </summary>
-    public static void LockCursor()
-    {
-        window.LockCursor();
-    }
-
-    /// <summary>
-    /// Unlocks the cursor
-    /// </summary>
-    public static void UnlockCursor()
-    {
-        window.UnlockCursor();
-    }
-
-    /// <summary>
-    /// Hides the cursor
-    /// </summary>
-    public static void HideCursor()
-    {
-        window.HideCursor();
-    }
-
-    /// <summary>
-    /// Shows the cursor
-    /// </summary>
-    public static void ShowCursor()
-    {
-        window.ShowCursor();
-    }
-
     /// <summary>
     /// Registers an input action for being pressed
     /// </summary>

Engine/Core/Rendering/Windowing/Impls/SDL2RenderWindow.cs

@@ -402,7 +402,14 @@ public void PollEvents()
 
                 case SDL.SDL_EventType.SDL_MOUSEMOTION:
 
-                    Input.CursorPosCallback(_event.motion.x, _event.motion.y);
+                    if(SDL.SDL_GetRelativeMouseMode() == SDL.SDL_bool.SDL_TRUE)
+                    {
+                        Input.CursorPosCallback(_event.motion.xrel, _event.motion.yrel);
+                    }
+                    else
+                    {
+                        Input.CursorPosCallback(_event.motion.x, _event.motion.y);
+                    }
 
                     break;
 
@@ -665,12 +672,16 @@ public nint MonitorPointer(AppPlatform platform)
 
     public void LockCursor()
     {
-        SDL.SDL_SetWindowMouseGrab(window, SDL.SDL_bool.SDL_TRUE);
+        SDL.SDL_SetRelativeMouseMode(SDL.SDL_bool.SDL_TRUE);
+
+        Cursor.visible = false;
     }
 
     public void UnlockCursor()
     {
-        SDL.SDL_SetWindowMouseGrab(window, SDL.SDL_bool.SDL_FALSE);
+        SDL.SDL_SetRelativeMouseMode(SDL.SDL_bool.SDL_FALSE);
+
+        Cursor.visible = true;
     }
 
     public void HideCursor()

Engine/Core/Rendering/Windowing/RenderWindow.cs

@@ -54,8 +54,9 @@ public string Title
 
     private bool renderThreadReady = false;
     private Thread renderThread;
-    private bgfx.Init init = new bgfx.Init();
+    private bgfx.Init init = new();
     private AppPlatform currentPlatform;
+    private CursorLockMode lastCursorLockMode;
 
     public bool Paused => hasFocus == false && AppSettings.Current.runInBackground == false;
 
@@ -162,6 +163,20 @@ private void SingleThreadLoop()
             {
                 hasFocus = window.IsFocused;
 
+                if(Platform.IsDesktopPlatform)
+                {
+                    if(hasFocus && lastCursorLockMode != Cursor.LockState)
+                    {
+                        Cursor.LockState = lastCursorLockMode;
+                    }
+                    else
+                    {
+                        lastCursorLockMode = Cursor.LockState;
+
+                        Cursor.LockState = CursorLockMode.None;
+                    }
+                }
+
                 try
                 {
                     OnScreenSizeChange?.Invoke(hasFocus);
@@ -865,7 +880,6 @@ public bool SetResolution(int width, int height, WindowMode windowMode)
     /// <param name="height">The window's height</param>
     /// <param name="resizable">Whether it should be resizable</param>
     /// <param name="windowMode">The window mode</param>
-    /// <param name="appSettings">Application Settings</param>
     /// <param name="maximized">Whether the window should be maximized</param>
     /// <param name="position">A specific position for the window, or null for default</param>
     /// <param name="monitorIndex">The monitor index to use</param>
@@ -938,6 +952,7 @@ public static RenderWindow Create(int width, int height, bool resizable, WindowM
         }
 
         Input.window = renderWindow.window;
+        Cursor.window = renderWindow.window;
 
         //Issue with Metal
         if(Platform.IsMacOS)

Engine/Core/StapleCore.csproj

@@ -139,6 +139,8 @@
 		<Compile Include="External\StbTruetypeSharp\src\StbTrueType.OldRasterizer.cs" />
 		<Compile Include="Hooks\IStapleHook.cs" />
 		<Compile Include="Hooks\StapleHookEvent.cs" />
+		<Compile Include="Input\Cursor.cs" />
+		<Compile Include="Input\CursorLockMode.cs" />
 		<Compile Include="Input\GamepadAxis.cs" />
 		<Compile Include="Input\GamepadButton.cs" />
 		<Compile Include="Input\GamepadConnectionState.cs" />