Changed all existing device-providers to use update-queues to decouple the physical update from the internal update-loop (first draft, code-documention is missing)

RGB.NET.Devices.Logitech/Generic/ILogitechRGBDevice.cs

@@ -7,6 +7,6 @@ namespace RGB.NET.Devices.Logitech
     /// </summary>
     internal interface ILogitechRGBDevice : IRGBDevice
     {
-        void Initialize();
+        void Initialize(UpdateQueue updateQueue);
     }
 }

RGB.NET.Devices.Logitech/Generic/LogitechRGBDevice.cs

@@ -19,6 +19,8 @@ namespace RGB.NET.Devices.Logitech
         /// </summary>
         public override TDeviceInfo DeviceInfo { get; }
 
+        protected UpdateQueue UpdateQueue { get; set; }
+
         #endregion
 
         #region Constructors
@@ -39,7 +41,7 @@ namespace RGB.NET.Devices.Logitech
         /// <summary>
         /// Initializes the device.
         /// </summary>
-        public void Initialize()
+        public void Initialize(UpdateQueue updateQueue)
         {
             InitializeLayout();
 
@@ -48,6 +50,8 @@ namespace RGB.NET.Devices.Logitech
                 Rectangle ledRectangle = new Rectangle(this.Select(x => x.LedRectangle));
                 Size = ledRectangle.Size + new Size(ledRectangle.Location.X, ledRectangle.Location.Y);
             }
+
+            UpdateQueue = updateQueue;
         }
 
         /// <summary>

RGB.NET.Devices.Logitech/LogitechDeviceProvider.cs

@@ -56,6 +56,10 @@ namespace RGB.NET.Devices.Logitech
         /// </summary>
         public Func<CultureInfo> GetCulture { get; set; } = CultureHelper.GetCurrentCulture;
 
+        public UpdateTrigger UpdateTrigger { get; private set; }
+        private LogitechPerDeviceUpdateQueue _perDeviceUpdateQueue;
+        private LogitechPerKeyUpdateQueue _perKeyUpdateQueue;
+
         #endregion
 
         #region Constructors
@@ -68,6 +72,10 @@ namespace RGB.NET.Devices.Logitech
         {
             if (_instance != null) throw new InvalidOperationException($"There can be only one instance of type {nameof(LogitechDeviceProvider)}");
             _instance = this;
+
+            UpdateTrigger = new UpdateTrigger();
+            _perDeviceUpdateQueue = new LogitechPerDeviceUpdateQueue(UpdateTrigger);
+            _perKeyUpdateQueue = new LogitechPerKeyUpdateQueue(UpdateTrigger);
         }
 
         #endregion
@@ -88,6 +96,8 @@ namespace RGB.NET.Devices.Logitech
 
             try
             {
+                UpdateTrigger?.Stop();
+
                 _LogitechGSDK.Reload();
                 if (!_LogitechGSDK.LogiLedInit()) return false;
 
@@ -104,7 +114,7 @@ namespace RGB.NET.Devices.Logitech
                         if (loadFilter.HasFlag(deviceType)) //TODO DarthAffe 07.12.2017: Check if it's worth to try another device if the one returned doesn't match the filter
                         {
                             ILogitechRGBDevice device = new LogitechPerKeyRGBDevice(new LogitechRGBDeviceInfo(deviceType, model, LogitechDeviceCaps.PerKeyRGB, imageLayout, layoutPath));
-                            device.Initialize();
+                            device.Initialize(_perKeyUpdateQueue);
                             devices.Add(device);
                         }
                     }
@@ -119,13 +129,15 @@ namespace RGB.NET.Devices.Logitech
                         if (loadFilter.HasFlag(deviceType)) //TODO DarthAffe 07.12.2017: Check if it's worth to try another device if the one returned doesn't match the filter
                         {
                             ILogitechRGBDevice device = new LogitechPerDeviceRGBDevice(new LogitechRGBDeviceInfo(deviceType, model, LogitechDeviceCaps.DeviceRGB, imageLayout, layoutPath));
-                            device.Initialize();
+                            device.Initialize(_perDeviceUpdateQueue);
                             devices.Add(device);
                         }
                     }
                 }
                 catch { if (throwExceptions) throw; }
 
+                UpdateTrigger?.Start();
+
                 Devices = new ReadOnlyCollection<IRGBDevice>(devices);
                 IsInitialized = true;
             }

RGB.NET.Devices.Logitech/PerDevice/LogitechPerDeviceRGBDevice.cs

@@ -1,8 +1,6 @@
-using System;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Linq;
 using RGB.NET.Core;
-using RGB.NET.Devices.Logitech.Native;
 
 namespace RGB.NET.Devices.Logitech
 {
@@ -37,19 +35,10 @@ namespace RGB.NET.Devices.Logitech
         }
 
         /// <inheritdoc />
-        protected override object CreateLedCustomData(LedId ledId) => LogitechLedId.DEVICE;
+        protected override object CreateLedCustomData(LedId ledId) => (ledId, LogitechLedId.DEVICE);
 
         /// <inheritdoc />
-        protected override void UpdateLeds(IEnumerable<Led> ledsToUpdate)
-        {
-            Led led = ledsToUpdate.FirstOrDefault(x => x.Color.A > 0);
-            if (led == null) return;
-
-            _LogitechGSDK.LogiLedSetTargetDevice(LogitechDeviceCaps.DeviceRGB);
-            _LogitechGSDK.LogiLedSetLighting((int)Math.Round(led.Color.RPercent * 100),
-                                             (int)Math.Round(led.Color.GPercent * 100),
-                                             (int)Math.Round(led.Color.BPercent * 100));
-        }
+        protected override void UpdateLeds(IEnumerable<Led> ledsToUpdate) => UpdateQueue.SetData(ledsToUpdate.Where(x => x.Color.A > 0).Take(1));
 
         #endregion
     }

RGB.NET.Devices.Logitech/PerDevice/LogitechPerDeviceUpdateQueue.cs

@@ -0,0 +1,34 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using RGB.NET.Core;
+using RGB.NET.Devices.Logitech.Native;
+
+namespace RGB.NET.Devices.Logitech
+{
+    public class LogitechPerDeviceUpdateQueue : UpdateQueue
+    {
+        #region Constructors
+
+        public LogitechPerDeviceUpdateQueue(IUpdateTrigger updateTrigger)
+            : base(updateTrigger)
+        { }
+
+        #endregion
+
+        #region Methods
+
+        /// <inheritdoc />
+        protected override void Update(Dictionary<object, Color> dataSet)
+        {
+            Color color = dataSet.Values.First();
+
+            _LogitechGSDK.LogiLedSetTargetDevice(LogitechDeviceCaps.DeviceRGB);
+            _LogitechGSDK.LogiLedSetLighting((int)Math.Round(color.RPercent * 100),
+                                             (int)Math.Round(color.GPercent * 100),
+                                             (int)Math.Round(color.BPercent * 100));
+        }
+
+        #endregion
+    }
+}

RGB.NET.Devices.Logitech/PerKey/LogitechPerKeyRGBDevice.cs

@@ -1,8 +1,6 @@
-using System;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Linq;
 using RGB.NET.Core;
-using RGB.NET.Devices.Logitech.Native;
 
 namespace RGB.NET.Devices.Logitech
 {
@@ -28,37 +26,10 @@ namespace RGB.NET.Devices.Logitech
         #region Methods
 
         /// <inheritdoc />
-        protected override object CreateLedCustomData(LedId ledId) => PerKeyIdMapping.DEFAULT.TryGetValue(ledId, out LogitechLedId logitechLedId) ? logitechLedId : LogitechLedId.Invalid;
+        protected override object CreateLedCustomData(LedId ledId) => (ledId, PerKeyIdMapping.DEFAULT.TryGetValue(ledId, out LogitechLedId logitechLedId) ? logitechLedId : LogitechLedId.Invalid);
 
         /// <inheritdoc />
-        protected override void UpdateLeds(IEnumerable<Led> ledsToUpdate)
-        {
-            List<Led> leds = ledsToUpdate.Where(x => x.Color.A > 0).ToList();
-            if (leds.Count <= 0) return;
-
-            _LogitechGSDK.LogiLedSetTargetDevice(LogitechDeviceCaps.PerKeyRGB);
-
-            byte[] bitmap = null;
-            foreach (Led led in leds)
-            {
-                // DarthAffe 26.03.2017: This is only needed since update by name doesn't work as expected for all keys ...
-                if (BitmapMapping.BitmapOffset.TryGetValue(led.Id, out int bitmapOffset))
-                {
-                    if (bitmap == null)
-                        bitmap = BitmapMapping.CreateBitmap();
-
-                    BitmapMapping.SetColor(ref bitmap, bitmapOffset, led.Color);
-                }
-                else
-                    _LogitechGSDK.LogiLedSetLightingForKeyWithKeyName((int)led.CustomData,
-                                                                      (int)Math.Round(led.Color.RPercent * 100),
-                                                                      (int)Math.Round(led.Color.GPercent * 100),
-                                                                      (int)Math.Round(led.Color.BPercent * 100));
-            }
-
-            if (bitmap != null)
-                _LogitechGSDK.LogiLedSetLightingFromBitmap(bitmap);
-        }
+        protected override void UpdateLeds(IEnumerable<Led> ledsToUpdate) => UpdateQueue.SetData(ledsToUpdate.Where(x => x.Color.A > 0));
 
         #endregion
     }

RGB.NET.Devices.Logitech/PerKey/LogitechPerKeyUpdateQueue.cs

@@ -0,0 +1,51 @@
+using System;
+using System.Collections.Generic;
+using RGB.NET.Core;
+using RGB.NET.Devices.Logitech.Native;
+
+namespace RGB.NET.Devices.Logitech
+{
+    public class LogitechPerKeyUpdateQueue : UpdateQueue
+    {
+        #region Constructors
+
+        public LogitechPerKeyUpdateQueue(IUpdateTrigger updateTrigger)
+            : base(updateTrigger)
+        { }
+
+        #endregion
+
+        #region Methods
+
+        /// <inheritdoc />
+        protected override void Update(Dictionary<object, Color> dataSet)
+        {
+            _LogitechGSDK.LogiLedSetTargetDevice(LogitechDeviceCaps.PerKeyRGB);
+
+            byte[] bitmap = null;
+            foreach (KeyValuePair<object, Color> data in dataSet)
+            {
+                (LedId id, int customData) = ((LedId, int))data.Key;
+
+                // DarthAffe 26.03.2017: This is only needed since update by name doesn't work as expected for all keys ...
+                if (BitmapMapping.BitmapOffset.TryGetValue(id, out int bitmapOffset))
+                {
+                    if (bitmap == null)
+                        bitmap = BitmapMapping.CreateBitmap();
+
+                    BitmapMapping.SetColor(ref bitmap, bitmapOffset, data.Value);
+                }
+                else
+                    _LogitechGSDK.LogiLedSetLightingForKeyWithKeyName(customData,
+                                                                      (int)Math.Round(data.Value.RPercent * 100),
+                                                                      (int)Math.Round(data.Value.GPercent * 100),
+                                                                      (int)Math.Round(data.Value.BPercent * 100));
+            }
+
+            if (bitmap != null)
+                _LogitechGSDK.LogiLedSetLightingFromBitmap(bitmap);
+        }
+
+        #endregion
+    }
+}

RGB.NET.Devices.Logitech/RGB.NET.Devices.Logitech.csproj

@@ -57,11 +57,13 @@
     <Compile Include="Generic\LogitechRGBDevice.cs" />
     <Compile Include="Generic\LogitechRGBDeviceInfo.cs" />
     <Compile Include="LogitechDeviceProviderLoader.cs" />
+    <Compile Include="PerDevice\LogitechPerDeviceUpdateQueue.cs" />
     <Compile Include="PerKey\BitmapMapping.cs" />
     <Compile Include="HID\DeviceChecker.cs" />
     <Compile Include="LogitechDeviceProvider.cs" />
     <Compile Include="Native\_LogitechGSDK.cs" />
     <Compile Include="PerDevice\LogitechPerDeviceRGBDevice.cs" />
+    <Compile Include="PerKey\LogitechPerKeyUpdateQueue.cs" />
     <Compile Include="PerKey\PerKeyIdMapping.cs" />
     <Compile Include="PerKey\LogitechPerKeyRGBDevice.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />