Merge pull request opentk#1660 from MV10/SizeProperties

Fix API Size/ClientSize inconsistencies

Author: NogginBops

src/OpenTK.Windowing.Desktop/NativeWindow.cs

@@ -504,8 +504,8 @@ public unsafe Vector2i ClientLocation
             }
         }
 
-        private Vector2i? _minimumSize;
-        private Vector2i? _maximumSize;
+        private Vector2i? _minimumClientSize;
+        private Vector2i? _maximumClientize;
 
         /// <summary>
         /// Gets or sets a <see cref="Vector2i" /> structure that contains the external size of this window.
@@ -570,11 +570,11 @@ public unsafe Vector2i FramebufferSize
         /// </remarks>
         public unsafe Vector2i? MinimumSize
         {
-            get => _minimumSize;
+            get => _minimumClientSize;
             set
             {
-                _minimumSize = value;
-                GLFW.SetWindowSizeLimits(WindowPtr, value?.X ?? GLFW.DontCare, value?.Y ?? GLFW.DontCare, _maximumSize?.X ?? GLFW.DontCare, _maximumSize?.Y ?? GLFW.DontCare);
+                _minimumClientSize = value;
+                GLFW.SetWindowSizeLimits(WindowPtr, value?.X ?? GLFW.DontCare, value?.Y ?? GLFW.DontCare, _maximumClientize?.X ?? GLFW.DontCare, _maximumClientize?.Y ?? GLFW.DontCare);
             }
         }
 
@@ -587,11 +587,11 @@ public unsafe Vector2i? MinimumSize
         /// </remarks>
         public unsafe Vector2i? MaximumSize
         {
-            get => _maximumSize;
+            get => _maximumClientize;
             set
             {
-                _maximumSize = value;
-                GLFW.SetWindowSizeLimits(WindowPtr, _minimumSize?.X ?? GLFW.DontCare, _minimumSize?.Y ?? GLFW.DontCare, value?.X ?? GLFW.DontCare, value?.Y ?? GLFW.DontCare);
+                _maximumClientize = value;
+                GLFW.SetWindowSizeLimits(WindowPtr, _minimumClientSize?.X ?? GLFW.DontCare, _minimumClientSize?.Y ?? GLFW.DontCare, value?.X ?? GLFW.DontCare, value?.Y ?? GLFW.DontCare);
             }
         }
 
@@ -882,7 +882,7 @@ public unsafe NativeWindow(NativeWindowSettings settings)
             GLFW.WindowHint(WindowHintInt.RefreshRate, modePtr->RefreshRate);
 
             _cachedWindowLocation = settings.Location ?? new Vector2i(32, 32);  // Better than nothing.
-            _cachedWindowClientSize = settings.Size;
+            _cachedWindowClientSize = settings.ClientSize;
 
             if (settings.WindowState == WindowState.Fullscreen && _isVisible)
             {
@@ -891,7 +891,7 @@ public unsafe NativeWindow(NativeWindowSettings settings)
             }
             else
             {
-                WindowPtr = GLFW.CreateWindow(settings.Size.X, settings.Size.Y, _title, null, (Window*)(settings.SharedContext?.WindowPtr ?? IntPtr.Zero));
+                WindowPtr = GLFW.CreateWindow(settings.ClientSize.X, settings.ClientSize.Y, _title, null, (Window*)(settings.SharedContext?.WindowPtr ?? IntPtr.Zero));
             }
 
             // For Vulkan, we need to pass ContextAPI.NoAPI, otherwise we will get an exception.
@@ -954,10 +954,10 @@ public unsafe NativeWindow(NativeWindowSettings settings)
             GLFW.GetWindowSize(WindowPtr, out var width, out var height);
 
             AspectRatio = settings.AspectRatio;
-            _minimumSize = settings.MinimumSize;
-            _maximumSize = settings.MaximumSize;
+            _minimumClientSize = settings.MinimumClientSize;
+            _maximumClientize = settings.MaximumClientSize;
 
-            GLFW.SetWindowSizeLimits(WindowPtr, _minimumSize?.X ?? GLFW.DontCare, _minimumSize?.Y ?? GLFW.DontCare, _maximumSize?.X ?? GLFW.DontCare, _maximumSize?.Y ?? GLFW.DontCare);
+            GLFW.SetWindowSizeLimits(WindowPtr, _minimumClientSize?.X ?? GLFW.DontCare, _minimumClientSize?.Y ?? GLFW.DontCare, _maximumClientize?.X ?? GLFW.DontCare, _maximumClientize?.Y ?? GLFW.DontCare);
 
             GLFW.GetWindowPos(WindowPtr, out var x, out var y);
 

src/OpenTK.Windowing.Desktop/NativeWindowSettings.cs

@@ -157,7 +157,7 @@ public NativeWindowSettings()
         /// <summary>
         ///     Gets or sets the initial size of the contents of the window.
         /// </summary>
-        public Vector2i Size { get; set; } = new Vector2i(640, 360);
+        public Vector2i ClientSize { get; set; } = new Vector2i(640, 360);
 
         /// <summary>
         ///     Gets or sets the minimum size of the contents of the window.
@@ -166,7 +166,7 @@ public NativeWindowSettings()
         /// Set to <c>null</c> to remove the minimum size constraint.
         /// If you set size limits and an aspect ratio that conflict, the results are undefined.
         /// </remarks>
-        public Vector2i? MinimumSize { get; set; } = null;
+        public Vector2i? MinimumClientSize { get; set; } = null;
 
         /// <summary>
         ///     Gets or sets the maximum size of the contents of the window.
@@ -175,7 +175,45 @@ public NativeWindowSettings()
         /// Set to <c>null</c> to remove the minimum size constraint.
         /// If you set size limits and an aspect ratio that conflict, the results are undefined.
         /// </remarks>
-        public Vector2i? MaximumSize { get; set; } = null;
+        public Vector2i? MaximumClientSize { get; set; } = null;
+
+        /// <summary>
+        ///     Gets or sets the initial size of the contents of the window.
+        /// </summary>
+        [Obsolete("Use the " + nameof(ClientSize) + " property to get or set the initial size of the contents of the window.")]
+        public Vector2i Size
+        {
+            get => ClientSize;
+            set { ClientSize = value; }
+        }
+
+        /// <summary>
+        ///     Gets or sets the minimum size of the contents of the window.
+        /// </summary>
+        /// <remarks>
+        /// Set to <c>null</c> to remove the minimum size constraint.
+        /// If you set size limits and an aspect ratio that conflict, the results are undefined.
+        /// </remarks>
+        [Obsolete("Use the " + nameof(MinimumClientSize) + " property to get or set the minimum size of the contents of the window.")]
+        public Vector2i? MinimumSize
+        {
+            get => MinimumClientSize;
+            set { MinimumClientSize = value; }
+        }
+
+        /// <summary>
+        ///     Gets or sets the maximum size of the contents of the window.
+        /// </summary>
+        /// <remarks>
+        /// Set to <c>null</c> to remove the minimum size constraint.
+        /// If you set size limits and an aspect ratio that conflict, the results are undefined.
+        /// </remarks>
+        [Obsolete("Use the " + nameof(MaximumClientSize) + " property to get or set the minimum size of the contents of the window.")]
+        public Vector2i? MaximumSize
+        {
+            get => MaximumClientSize;
+            set { MaximumClientSize = value; }
+        }
 
         /// <summary>
         /// Gets or sets the aspect ratio the window is locked to until changed.

tests/LocalTest/Program.cs

@@ -17,7 +17,6 @@ static void Main(string[] args)
             GameWindowSettings gwSettings = new GameWindowSettings()
             {
                 UpdateFrequency = 250,
-                //RenderFrequency = 10,
             };
 
             NativeWindowSettings nwSettings = new NativeWindowSettings()
@@ -28,7 +27,7 @@ static void Main(string[] args)
                 Flags = ContextFlags.Debug | ContextFlags.ForwardCompatible,
                 IsEventDriven = false,
                 Profile = ContextProfile.Core,
-                Size = (800, 600),
+                ClientSize = (800, 600),
                 StartFocused = true,
                 StartVisible = true,
                 Title = "Local OpenTK Test",