Lay out impl, add new APIs from proposal

Author: Perksey

sources/Windowing/Windowing/IDetachedSurfaceLifecycle.cs

@@ -0,0 +1,69 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Diagnostics.CodeAnalysis;
+
+namespace Silk.NET.Windowing;
+
+/// <summary>
+/// Represents a surface with a user-controlled lifecycle.
+/// </summary>
+/// <remarks>
+/// This API is <b>not guaranteed to be supported</b> on all platforms and you should only use it if you know what
+/// you're doing and know you need the granular control this API provides! Please use
+/// <see cref="ISurfaceApplication.Run{T}" /> instead where possible. If you insist on using this API, please fall back
+/// to <see cref="ISurfaceApplication.Run{T}" /> if <see cref="TryCreate{T}" /> returns <c>false</c> indicating a lack
+/// of support.
+/// </remarks>
+public interface IDetachedSurfaceLifecycle : IDisposable
+{
+    /// <summary>
+    /// Gets the surface with which this lifecycle is associated. The destruction of this surface is handled by
+    /// the <see cref="IDisposable.Dispose" /> method of this <see cref="IDetachedSurfaceLifecycle" /> implementation.
+    /// </summary>
+    Surface Surface { get; }
+
+    /// <summary>
+    /// Gets a value indicating whether the surface is indicating that its lifecycle should conclude as a result of
+    /// its current configuration e.g. an entire tick passing with <see cref="ISurfaceWindow.IsCloseRequested" /> being
+    /// <c>true</c>.
+    /// </summary>
+    /// <remarks>
+    /// It is expected that <see cref="Tick" /> shall not be called if this property is <c>true</c>.
+    /// </remarks>
+    bool ShouldTerminate { get; }
+
+    /// <summary>
+    /// Steps the underlying implementation's surface lifecycle (i.e. event loop), running a single tick on the
+    /// <see cref="Surface" />.
+    /// </summary>
+    /// <remarks>
+    /// It is expected that implementations shall return after doing as little work as possible. For instance, if the
+    /// underlying implementation exposes one-by-one event retrieval or otherwise allows customisation of the extent to
+    /// which the event pump is run, it is expected that a single event shall be pumped in this case. Note that this is
+    /// just an example and the exact details of this is implementation-defined.
+    /// </remarks>
+    void Tick();
+
+    /// <summary>
+    /// Attempts to create a <see cref="IDetachedSurfaceLifecycle" /> using the reference implementation.
+    /// </summary>
+    /// <param name="lifecycle">The created surface lifecycle on success, <c>null</c> otherwise.</param>
+    /// <typeparam name="T">
+    /// The application that shall be associated with the surface. Note that even with this API,
+    /// <see cref="ISurfaceApplication.Initialize{T}" /> shall still be called for consistency and portability. However,
+    /// unlike <see cref="ISurfaceApplication.Run{T}" />, this method shall not block and will instead return an
+    /// <see cref="IDetachedSurfaceLifecycle" /> on which <see cref="Tick" /> is expected to be continuously called to
+    /// enact the same behaviour on the surface. The associated application is also used for any additional global
+    /// configuration, such as <see cref="ISurfaceApplication.WindowClass" />.
+    /// </typeparam>
+    /// <returns>
+    /// <c>true</c> if <paramref name="lifecycle" /> has been populated with an <see cref="IDetachedSurfaceLifecycle" />
+    /// object containing a valid <see cref="Surface" />, <c>false</c> otherwise.
+    /// </returns>
+    /// <remarks>
+    /// This is the same reference implementation that <see cref="ISurfaceApplication.Run{T}" /> would otherwise use.
+    /// </remarks>
+    static sealed bool TryCreate<T>([NotNullWhen(true)] out IDetachedSurfaceLifecycle? lifecycle)
+        where T : ISurfaceApplication => throw new NotImplementedException();
+}

sources/Windowing/Windowing/Implementations/SDL3/SdlSurface.cs

@@ -0,0 +1,39 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Diagnostics.CodeAnalysis;
+using System.Numerics;
+
+namespace Silk.NET.Windowing.SDL3;
+
+internal class SdlSurface : Surface
+{
+    private SdlSurfaceComponents _components;
+
+    public SdlSurface() => _components = new SdlSurfaceComponents(this);
+
+    public override ISurfaceOpenGL? OpenGL => _components.IsOpenGLEnabled ? _components : null;
+    public override ISurfaceWindow? Window => _components.IsWindowEnabled ? _components : null;
+    public override ISurfaceDisplay? Display => _components.IsDisplayEnabled ? _components : null;
+    public override ISurfaceVulkan? Vulkan => _components.IsVulkanEnabled ? _components : null;
+    public override ISurfaceChildren? Children =>
+        _components.IsChildrenEnabled ? _components : null;
+    public override ISurfaceScale? Scale => _components.IsScaleEnabled ? _components : null;
+    public override Vector2 DrawableSize { get; }
+    public override event Action<SurfaceResizeEvent>? DrawableSizeChanged;
+    public override event Action<SurfaceLifecycleEvent>? Created;
+    public override event Action<SurfaceLifecycleEvent>? Terminating;
+    public override event Action<SurfaceLifecycleEvent>? Pausing;
+    public override event Action<SurfaceLifecycleEvent>? Resuming;
+    public override event Action<SurfaceLifecycleEvent>? LowMemory;
+    public override SurfaceTickOptions TickOptions { get; set; }
+
+    public override void Continue() => throw new NotImplementedException();
+
+    public override void Terminate() => throw new NotImplementedException();
+
+    public override bool TryGetPlatformInfo<TPlatformInfo>(
+        [NotNullWhen(true)] out TPlatformInfo? info
+    )
+        where TPlatformInfo : default => throw new NotImplementedException();
+}

sources/Windowing/Windowing/Implementations/SDL3/SdlSurfaceComponents.Children.cs

@@ -0,0 +1,9 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Silk.NET.Windowing.SDL3;
+
+internal partial class SdlSurfaceComponents : ISurfaceChildren
+{
+    void ISurfaceChildren.Spawn<T>() => throw new NotImplementedException();
+}

sources/Windowing/Windowing/Implementations/SDL3/SdlSurfaceComponents.Display.cs

@@ -0,0 +1,42 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Silk.NET.Windowing.SDL3;
+
+internal partial class SdlSurfaceComponents : ISurfaceDisplay
+{
+    IDisplay ISurfaceDisplay.Current
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    IReadOnlyList<IDisplay> ISurfaceDisplay.Available => throw new NotImplementedException();
+
+    VideoMode ISurfaceDisplay.VideoMode
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    IReadOnlyList<VideoMode> ISurfaceDisplay.AvailableVideoModes =>
+        throw new NotImplementedException();
+
+    event Action<DisplayChangeEvent>? ISurfaceDisplay.CurrentDisplayChanged
+    {
+        add => throw new NotImplementedException();
+        remove => throw new NotImplementedException();
+    }
+
+    event Action<DisplayAvailabilityChangeEvent>? ISurfaceDisplay.AvailableChanged
+    {
+        add => throw new NotImplementedException();
+        remove => throw new NotImplementedException();
+    }
+
+    event Action<DisplayVideoModeAvailabilityChangeEvent>? ISurfaceDisplay.AvailableVideoModesChanged
+    {
+        add => throw new NotImplementedException();
+        remove => throw new NotImplementedException();
+    }
+}

sources/Windowing/Windowing/Implementations/SDL3/SdlSurfaceComponents.OpenGL.cs

@@ -0,0 +1,85 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Silk.NET.Core.Loader;
+using Silk.NET.Maths;
+
+namespace Silk.NET.Windowing.SDL3;
+
+internal partial class SdlSurfaceComponents : ISurfaceOpenGL
+{
+    void IDisposable.Dispose() => throw new NotImplementedException();
+
+    unsafe void* INativeContext.LoadFunction(string functionName, string libraryNameHint) =>
+        throw new NotImplementedException();
+
+    bool IGLContext.IsCurrent
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    int IGLContext.SwapInterval
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    void IGLContext.SwapBuffers() => throw new NotImplementedException();
+
+    int? ISurfaceOpenGL.PreferredDepthBufferBits
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    int? ISurfaceOpenGL.PreferredStencilBufferBits
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    Vector4D<int>? ISurfaceOpenGL.PreferredBitDepth
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    int? ISurfaceOpenGL.PreferredSampleCount
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    Version32? ISurfaceOpenGL.Version
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    OpenGLContextFlags ISurfaceOpenGL.Flags
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    OpenGLContextProfile ISurfaceOpenGL.Profile
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    bool ISurfaceOpenGL.IsSupported => throw new NotImplementedException();
+
+    bool ISurfaceOpenGL.ShouldSwapAutomatically
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    IGLContext? ISurfaceOpenGL.SharedContext
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+}

sources/Windowing/Windowing/Implementations/SDL3/SdlSurfaceComponents.Scale.cs

@@ -0,0 +1,13 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Silk.NET.Windowing.SDL3;
+
+internal partial class SdlSurfaceComponents : ISurfaceScale
+{
+    float ISurfaceScale.ContentScale => throw new NotImplementedException();
+
+    float ISurfaceScale.DrawScale => throw new NotImplementedException();
+
+    float ISurfaceScale.PixelDensity => throw new NotImplementedException();
+}

sources/Windowing/Windowing/Implementations/SDL3/SdlSurfaceComponents.Vulkan.cs

@@ -0,0 +1,19 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Silk.NET.Windowing.SDL3;
+
+internal partial class SdlSurfaceComponents : ISurfaceVulkan
+{
+    bool ISurfaceVulkan.IsEnabled
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    ulong ISurfaceVulkan.CreateSurface(IntPtr instance, Ptr allocator) =>
+        throw new NotImplementedException();
+
+    Ptr2D<sbyte> ISurfaceVulkan.GetRequiredExtensions(out uint count) =>
+        throw new NotImplementedException();
+}

sources/Windowing/Windowing/Implementations/SDL3/SdlSurfaceComponents.Window.cs

@@ -0,0 +1,95 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Silk.NET.Maths;
+
+namespace Silk.NET.Windowing.SDL3;
+
+internal partial class SdlSurfaceComponents : ISurfaceWindow
+{
+    Rectangle<float> ISurfaceWindow.Bounds
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    Rectangle<float> ISurfaceWindow.ClientArea
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    event Action<WindowCoordinatesEvent>? ISurfaceWindow.CoordinatesChanged
+    {
+        add => throw new NotImplementedException();
+        remove => throw new NotImplementedException();
+    }
+
+    bool ISurfaceWindow.IsCloseRequested
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    bool ISurfaceWindow.IsVisible
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    event Action<WindowToggleEvent>? ISurfaceWindow.CloseRequested
+    {
+        add => throw new NotImplementedException();
+        remove => throw new NotImplementedException();
+    }
+
+    bool ISurfaceWindow.IsFocused
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    event Action<WindowToggleEvent>? ISurfaceWindow.FocusChanged
+    {
+        add => throw new NotImplementedException();
+        remove => throw new NotImplementedException();
+    }
+
+    string ISurfaceWindow.Title
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    WindowState ISurfaceWindow.State
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    event Action<WindowStateEvent>? ISurfaceWindow.StateChanged
+    {
+        add => throw new NotImplementedException();
+        remove => throw new NotImplementedException();
+    }
+
+    WindowBorder ISurfaceWindow.Border
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    bool ISurfaceWindow.IsTopMost
+    {
+        get => throw new NotImplementedException();
+        set => throw new NotImplementedException();
+    }
+
+    event Action<WindowFileEvent>? ISurfaceWindow.FileDrop
+    {
+        add => throw new NotImplementedException();
+        remove => throw new NotImplementedException();
+    }
+
+    bool ISurfaceWindow.TrySetIcon(WindowIconVariants icon) => throw new NotImplementedException();
+}