Core - Split up RGBService into RenderService and DeviceService

Core - Removed rendering from CoreService
Core - Store and restore original device LEDs when applying/clearing layouts

src/Artemis.Core/Services/Interfaces/ICoreService.cs

@@ -12,21 +12,6 @@ public interface ICoreService : IArtemisService
     /// </summary>
     bool IsInitialized { get; }
 
-    /// <summary>
-    ///     The time the last frame took to render
-    /// </summary>
-    TimeSpan FrameTime { get; }
-
-    /// <summary>
-    ///     The amount of frames rendered each second
-    /// </summary>
-    public int FrameRate { get; }
-
-    /// <summary>
-    ///     Gets or sets whether profiles are rendered each frame by calling their Render method
-    /// </summary>
-    bool ProfileRenderingDisabled { get; set; }
-
     /// <summary>
     ///     Gets a boolean indicating whether Artemis is running in an elevated environment (admin permissions)
     /// </summary>
@@ -41,14 +26,4 @@ public interface ICoreService : IArtemisService
     ///     Occurs the core has finished initializing
     /// </summary>
     event EventHandler Initialized;
-
-    /// <summary>
-    ///     Occurs whenever a frame is rendering, after modules have rendered
-    /// </summary>
-    event EventHandler<FrameRenderingEventArgs> FrameRendering;
-
-    /// <summary>
-    ///     Occurs whenever a frame is finished rendering and the render pipeline is closed
-    /// </summary>
-    event EventHandler<FrameRenderedEventArgs> FrameRendered;
 }

src/Artemis.Core/Services/Interfaces/IDeviceService.cs

@@ -1,13 +1,109 @@
-namespace Artemis.Core.Services;
+using System;
+using System.Collections.Generic;
+using Artemis.Core.DeviceProviders;
+
+namespace Artemis.Core.Services;
 
 /// <summary>
 ///     A service that allows you manage an <see cref="ArtemisDevice" />
 /// </summary>
 public interface IDeviceService : IArtemisService
 {
+    /// <summary>
+    ///     Gets a read-only collection containing all enabled devices
+    /// </summary>
+    IReadOnlyCollection<ArtemisDevice> EnabledDevices { get; }
+
+    /// <summary>
+    ///     Gets a read-only collection containing all registered devices
+    /// </summary>
+    IReadOnlyCollection<ArtemisDevice> Devices { get; }
+
     /// <summary>
     ///     Identifies the device by making it blink white 5 times
     /// </summary>
     /// <param name="device"></param>
     void IdentifyDevice(ArtemisDevice device);
+
+    /// <summary>
+    ///     Adds the given device provider and its devices.
+    /// </summary>
+    /// <param name="deviceProvider"></param>
+    void AddDeviceProvider(DeviceProvider deviceProvider);
+
+    /// <summary>
+    ///     Removes the given device provider and its devices.
+    /// </summary>
+    /// <param name="deviceProvider"></param>
+    void RemoveDeviceProvider(DeviceProvider deviceProvider);
+
+    /// <summary>
+    ///     Applies auto-arranging logic to the surface
+    /// </summary>
+    void AutoArrangeDevices();
+    
+    /// <summary>
+    ///     Apples the provided <see cref="ArtemisLayout" /> to the provided <see cref="ArtemisDevice" />
+    /// </summary>
+    /// <param name="device"></param>
+    /// <param name="layout"></param>
+    void ApplyDeviceLayout(ArtemisDevice device, ArtemisLayout? layout);
+
+    /// <summary>
+    ///     Enables the provided device
+    /// </summary>
+    /// <param name="device">The device to enable</param>
+    void EnableDevice(ArtemisDevice device);
+
+    /// <summary>
+    ///     Disables the provided device
+    /// </summary>
+    /// <param name="device">The device to disable</param>
+    void DisableDevice(ArtemisDevice device);
+
+    /// <summary>
+    ///     Saves the configuration of the provided device to persistent storage
+    /// </summary>
+    /// <param name="artemisDevice"></param>
+    void SaveDevice(ArtemisDevice artemisDevice);
+
+    /// <summary>
+    ///     Saves the configuration of all current devices to persistent storage
+    /// </summary>
+    void SaveDevices();
+
+    /// <summary>
+    ///     Occurs when a single device was added.
+    /// </summary>
+    event EventHandler<DeviceEventArgs> DeviceAdded;
+
+    /// <summary>
+    ///     Occurs when a single device was removed.
+    /// </summary>
+    event EventHandler<DeviceEventArgs> DeviceRemoved;
+
+    /// <summary>
+    ///     Occurs when a single device was disabled
+    /// </summary>
+    event EventHandler<DeviceEventArgs> DeviceEnabled;
+
+    /// <summary>
+    ///     Occurs when a single device was disabled.
+    /// </summary>
+    event EventHandler<DeviceEventArgs> DeviceDisabled;
+
+    /// <summary>
+    ///     Occurs when a device provider was added.
+    /// </summary>
+    event EventHandler<DeviceProviderEventArgs> DeviceProviderAdded;
+
+    /// <summary>
+    ///     Occurs when a device provider was removed.
+    /// </summary>
+    event EventHandler<DeviceProviderEventArgs> DeviceProviderRemoved;
+    
+    /// <summary>
+    ///     Occurs when the surface has had modifications to its LED collection
+    /// </summary>
+    event EventHandler LedsChanged;
 }

src/Artemis.Core/Services/Interfaces/IRenderService.cs

@@ -0,0 +1,63 @@
+using System;
+using System.Collections.Generic;
+using Artemis.Core.Services.Core;
+using Artemis.Core.SkiaSharp;
+using RGB.NET.Core;
+
+namespace Artemis.Core.Services;
+
+/// <summary>
+///     Represents a service that manages the render loop and renderers.
+/// </summary>
+public interface IRenderService : IArtemisService
+{
+    /// <summary>
+    ///     Gets the graphics context to be used for rendering
+    /// </summary>
+    IManagedGraphicsContext? GraphicsContext { get; }
+
+    /// <summary>
+    ///     Gets the RGB surface to which is being rendered.
+    /// </summary>
+    RGBSurface Surface { get; }
+
+    /// <summary>
+    ///     Gets a list of registered renderers.
+    /// </summary>
+    List<IRenderer> Renderers { get; }
+
+    /// <summary>
+    ///     Gets or sets a boolean indicating whether rendering is paused.
+    /// </summary>
+    bool IsPaused { get; set; }
+    
+    /// <summary>
+    ///     Gets or sets a boolean indicating whether to flush the RGB.NET LEDs during next update
+    /// </summary>
+    bool FlushLeds { get; set; }
+    
+    /// <summary>
+    ///     The time the last frame took to render
+    /// </summary>
+    TimeSpan FrameTime { get; }
+
+    /// <summary>
+    ///     The amount of frames rendered each second
+    /// </summary>
+    public int FrameRate { get; }
+    
+    /// <summary>
+    ///     Initializes the render service and starts rendering.
+    /// </summary>
+    void Initialize();
+    
+    /// <summary>
+    ///     Occurs whenever a frame is rendering, after modules have rendered
+    /// </summary>
+    event EventHandler<FrameRenderingEventArgs> FrameRendering;
+
+    /// <summary>
+    ///     Occurs whenever a frame is finished rendering and the render pipeline is closed
+    /// </summary>
+    event EventHandler<FrameRenderedEventArgs> FrameRendered;
+}

src/Artemis.Core/Services/Interfaces/IRgbService.cs

@@ -1,168 +0,0 @@
-using System;
-using System.Collections.Generic;
-using Artemis.Core.SkiaSharp;
-using RGB.NET.Core;
-
-namespace Artemis.Core.Services;
-
-/// <summary>
-///     A service that allows you to manage the <see cref="RGBSurface" /> and its contents
-/// </summary>
-public interface IRgbService : IArtemisService, IDisposable
-{
-    /// <summary>
-    ///     Gets a read-only collection containing all enabled devices
-    /// </summary>
-    IReadOnlyCollection<ArtemisDevice> EnabledDevices { get; }
-
-    /// <summary>
-    ///     Gets a read-only collection containing all registered devices
-    /// </summary>
-    IReadOnlyCollection<ArtemisDevice> Devices { get; }
-
-    /// <summary>
-    ///     Gets a dictionary containing all <see cref="ArtemisLed" />s on the surface with their corresponding RGB.NET
-    ///     <see cref="Led" /> as key
-    /// </summary>
-    IReadOnlyDictionary<Led, ArtemisLed> LedMap { get; }
-
-    /// <summary>
-    ///     Gets or sets the RGB surface rendering is performed on
-    /// </summary>
-    RGBSurface Surface { get; set; }
-
-    /// <summary>
-    ///     Gets or sets whether rendering should be paused
-    /// </summary>
-    bool IsRenderPaused { get; }
-
-    /// <summary>
-    ///     Gets a boolean indicating whether the render pipeline is open
-    /// </summary>
-    bool RenderOpen { get; }
-
-    /// <summary>
-    ///     Gets or sets a boolean indicating whether to flush the RGB.NET LEDs during next update
-    /// </summary>
-    bool FlushLeds { get; set; }
-
-    /// <summary>
-    ///     Opens the render pipeline
-    /// </summary>
-    SKTexture OpenRender();
-
-    /// <summary>
-    ///     Closes the render pipeline
-    /// </summary>
-    void CloseRender();
-
-    /// <summary>
-    ///     Applies the current value of the <c>Core.PreferredGraphicsContext</c> setting to the graphics context.
-    /// </summary>
-    /// <param name="forceSoftware">A boolean to indicate whether or not to force the graphics context to software mode.</param>
-    void ApplyPreferredGraphicsContext(bool forceSoftware);
-
-    /// <summary>
-    ///     Updates the graphics context to the provided <paramref name="managedGraphicsContext"></paramref>.
-    ///     <para>Note: The old graphics context will be used until the next frame starts rendering and is disposed afterwards.</para>
-    /// </summary>
-    /// <param name="managedGraphicsContext">
-    ///     The new managed graphics context. If <see langword="null" />, software rendering
-    ///     is used.
-    /// </param>
-    void UpdateGraphicsContext(IManagedGraphicsContext? managedGraphicsContext);
-
-    /// <summary>
-    ///     Adds the given device provider to the <see cref="Surface" />
-    /// </summary>
-    /// <param name="deviceProvider"></param>
-    void AddDeviceProvider(IRGBDeviceProvider deviceProvider);
-
-    /// <summary>
-    ///     Removes the given device provider from the <see cref="Surface" />
-    /// </summary>
-    /// <param name="deviceProvider"></param>
-    void RemoveDeviceProvider(IRGBDeviceProvider deviceProvider);
-
-    /// <summary>
-    ///     Applies auto-arranging logic to the surface
-    /// </summary>
-    void AutoArrangeDevices();
-
-    /// <summary>
-    ///     Applies the best available layout for the given <see cref="ArtemisDevice" />
-    /// </summary>
-    /// <param name="device">The device to apply the best available layout to</param>
-    /// <returns>The layout that was applied to the device</returns>
-    ArtemisLayout? ApplyBestDeviceLayout(ArtemisDevice device);
-
-    /// <summary>
-    ///     Apples the provided <see cref="ArtemisLayout" /> to the provided <see cref="ArtemisDevice" />
-    /// </summary>
-    /// <param name="device"></param>
-    /// <param name="layout"></param>
-    void ApplyDeviceLayout(ArtemisDevice device, ArtemisLayout layout);
-
-    /// <summary>
-    ///     Attempts to retrieve the <see cref="ArtemisDevice" /> that corresponds the provided RGB.NET
-    ///     <see cref="IRGBDevice" />
-    /// </summary>
-    /// <param name="rgbDevice">
-    ///     The RGB.NET <see cref="IRGBDevice" /> to find the corresponding <see cref="ArtemisDevice" />
-    ///     for
-    /// </param>
-    /// <returns>If found, the corresponding <see cref="ArtemisDevice" />; otherwise <see langword="null" />.</returns>
-    ArtemisDevice? GetDevice(IRGBDevice rgbDevice);
-
-    /// <summary>
-    ///     Attempts to retrieve the <see cref="ArtemisLed" /> that corresponds the provided RGB.NET <see cref="Led" />
-    /// </summary>
-    /// <param name="led">The RGB.NET <see cref="Led" /> to find the corresponding <see cref="ArtemisLed" /> for </param>
-    /// <returns>If found, the corresponding <see cref="ArtemisLed" />; otherwise <see langword="null" />.</returns>
-    ArtemisLed? GetLed(Led led);
-
-    /// <summary>
-    ///     Saves the configuration of the provided device to persistent storage
-    /// </summary>
-    /// <param name="artemisDevice"></param>
-    void SaveDevice(ArtemisDevice artemisDevice);
-
-    /// <summary>
-    ///     Saves the configuration of all current devices to persistent storage
-    /// </summary>
-    void SaveDevices();
-
-    /// <summary>
-    ///     Enables the provided device
-    /// </summary>
-    /// <param name="device">The device to enable</param>
-    void EnableDevice(ArtemisDevice device);
-
-    /// <summary>
-    ///     Disables the provided device
-    /// </summary>
-    /// <param name="device">The device to disable</param>
-    void DisableDevice(ArtemisDevice device);
-
-    /// <summary>
-    ///     Pauses or resumes rendering, method won't return until the current frame finished rendering
-    /// </summary>
-    /// <param name="paused"></param>
-    /// <returns><see langword="true" /> if the pause state was changed; otherwise <see langword="false" />.</returns>
-    bool SetRenderPaused(bool paused);
-
-    /// <summary>
-    ///     Occurs when a single device was added
-    /// </summary>
-    event EventHandler<DeviceEventArgs> DeviceAdded;
-
-    /// <summary>
-    ///     Occurs when a single device was removed
-    /// </summary>
-    event EventHandler<DeviceEventArgs> DeviceRemoved;
-
-    /// <summary>
-    ///     Occurs when the surface has had modifications to its LED collection
-    /// </summary>
-    event EventHandler LedsChanged;
-}