Fix RGB returning wrong color and change it to RGBA (#1793)

* FIx RGB returning wrong color and change it to RGBA

* Don't use the old RGB variable

* Fix UIGlowPayload too

* Add RGBA to ABGR helper and new method for glow/foreground to expose it directly

* Move from Utils to ColorHelpers

* Rename the function

Dalamud/Game/Text/SeStringHandling/Payloads/UIForegroundPayload.cs

@@ -77,15 +77,21 @@ public class UIForegroundPayload : Payload
     }
 
     /// <summary>
-    /// Gets the Red/Green/Blue values for this foreground color, encoded as a typical hex color.
+    /// Gets the Red/Green/Blue/Alpha values for this foreground color, encoded as a typical hex color.
     /// </summary>
     [JsonIgnore]
-    public uint RGB => this.UIColor.UIForeground & 0xFFFFFF;
+    public uint RGBA => this.UIColor.UIForeground;
+
+    /// <summary>
+    /// Gets the ABGR value for this foreground color, as ImGui requires it in PushColor.
+    /// </summary>
+    [JsonIgnore]
+    public uint ABGR => Interface.ColorHelpers.SwapEndianness(this.UIColor.UIForeground);
 
     /// <inheritdoc/>
     public override string ToString()
     {
-        return $"{this.Type} - UIColor: {this.colorKey} color: {(this.IsEnabled ? this.RGB : 0)}";
+        return $"{this.Type} - UIColor: {this.colorKey} color: {(this.IsEnabled ? this.RGBA : 0)}";
     }
 
     /// <inheritdoc/>

Dalamud/Game/Text/SeStringHandling/Payloads/UIGlowPayload.cs

@@ -68,10 +68,16 @@ public class UIGlowPayload : Payload
     public bool IsEnabled => this.ColorKey != 0;
 
     /// <summary>
-    /// Gets the Red/Green/Blue values for this glow color, encoded as a typical hex color.
+    /// Gets the Red/Green/Blue/Alpha values for this glow color, encoded as a typical hex color.
     /// </summary>
     [JsonIgnore]
-    public uint RGB => this.UIColor.UIGlow & 0xFFFFFF;
+    public uint RGBA => this.UIColor.UIGlow;
+
+    /// <summary>
+    /// Gets the ABGR value for this glow color, as ImGui requires it in PushColor.
+    /// </summary>
+    [JsonIgnore]
+    public uint ABGR => Interface.ColorHelpers.SwapEndianness(this.UIColor.UIGlow);
 
     /// <summary>
     /// Gets a Lumina UIColor object representing this payload.  The actual color data is at UIColor.UIGlow.
@@ -85,7 +91,7 @@ public class UIGlowPayload : Payload
     /// <inheritdoc/>
     public override string ToString()
     {
-        return $"{this.Type} - UIColor: {this.colorKey} color: {(this.IsEnabled ? this.RGB : 0)}";
+        return $"{this.Type} - UIColor: {this.colorKey} color: {(this.IsEnabled ? this.RGBA : 0)}";
     }
 
     /// <inheritdoc/>

Dalamud/Interface/ColorHelpers.cs

@@ -1,3 +1,4 @@
+using System.Buffers.Binary;
 using System.Diagnostics.CodeAnalysis;
 using System.Drawing;
 using System.Numerics;
@@ -159,6 +160,16 @@ public static class ColorHelpers
         return new Vector4(r, g, b, hsv.A);
     }
 
+    /// <summary>
+    /// Performs a swap of endianness
+    /// Exmaple:
+    /// (FFXIV) RGBA to ABGR (ImGui)
+    /// </summary>
+    /// <param name="rgba">Color value in byte order X Y Z W.</param>
+    /// <returns>Endian swapped color value with new byte order W Z Y X.</returns>
+    public static uint SwapEndianness(uint rgba)
+        => BinaryPrimitives.ReverseEndianness(rgba);
+
     /// <summary>
     /// Lighten a color.
     /// </summary>
@@ -259,7 +270,7 @@ public static class ColorHelpers
         hsv.A -= amount;
         return HsvToRgb(hsv);
     }
-    
+
     /// <summary>
     /// Set alpha of a color.
     /// </summary>
@@ -299,10 +310,10 @@ public static class ColorHelpers
     {
         // If any components are out of range, return original value.
         { W: > 255.0f or < 0.0f } or { X: > 255.0f or < 0.0f } or { Y: > 255.0f or < 0.0f } or { Z: > 255.0f or < 0.0f } => color,
-            
+
         // If all components are already unit range, return original value.
         { W: >= 0.0f and <= 1.0f, X: >= 0.0f and <= 1.0f, Y: >= 0.0f and <= 1.0f, Z: >= 0.0f and <= 1.0f } => color,
-            
+
         _ => color / 255.0f,
     };
 }

Dalamud/Utility/Util.cs

@@ -476,12 +476,12 @@ public static class Util
             case "MacOS": return OSPlatform.OSX;
             case "Linux": return OSPlatform.Linux;
         }
-        
+
         // n.b. we had some fancy code here to check if the Wine host version returned "Darwin" but apparently
         // *all* our Wines report Darwin if exports aren't hidden. As such, it is effectively impossible (without some
         // (very cursed and inaccurate heuristics) to determine if we're on macOS or Linux unless we're explicitly told
         // by our launcher. See commit a7aacb15e4603a367e2f980578271a9a639d8852 for the old check.
-        
+
         return IsWine() ? OSPlatform.Linux : OSPlatform.Windows;
     }
 
@@ -544,7 +544,7 @@ public static class Util
                     }
                 }
             }
-        } 
+        }
         finally
         {
             foreach (var enumerator in enumerators)
@@ -585,7 +585,7 @@ public static class Util
     {
         WriteAllTextSafe(path, text, Encoding.UTF8);
     }
-    
+
     /// <summary>
     /// Overwrite text in a file by first writing it to a temporary file, and then
     /// moving that file to the path specified.
@@ -597,7 +597,7 @@ public static class Util
     {
         WriteAllBytesSafe(path, encoding.GetBytes(text));
     }
-    
+
     /// <summary>
     /// Overwrite data in a file by first writing it to a temporary file, and then
     /// moving that file to the path specified.
@@ -607,13 +607,13 @@ public static class Util
     public static unsafe void WriteAllBytesSafe(string path, byte[] bytes)
     {
         ArgumentException.ThrowIfNullOrEmpty(path);
-        
+
         // Open the temp file
         var tempPath = path + ".tmp";
 
         using var tempFile = Windows.Win32.PInvoke.CreateFile(
-            tempPath, 
+            tempPath,
-            (uint)(FILE_ACCESS_RIGHTS.FILE_GENERIC_READ | FILE_ACCESS_RIGHTS.FILE_GENERIC_WRITE), 
+            (uint)(FILE_ACCESS_RIGHTS.FILE_GENERIC_READ | FILE_ACCESS_RIGHTS.FILE_GENERIC_WRITE),
             FILE_SHARE_MODE.FILE_SHARE_NONE,
             null,
             FILE_CREATION_DISPOSITION.CREATE_ALWAYS,
@@ -622,7 +622,7 @@ public static class Util
 
         if (tempFile.IsInvalid)
             throw new Win32Exception();
-        
+
         // Write the data
         uint bytesWritten = 0;
         if (!Windows.Win32.PInvoke.WriteFile(tempFile, new ReadOnlySpan<byte>(bytes), &bytesWritten, null))
@@ -633,7 +633,7 @@ public static class Util
 
         if (!Windows.Win32.PInvoke.FlushFileBuffers(tempFile))
             throw new Win32Exception();
-        
+
         tempFile.Close();
 
         if (!Windows.Win32.PInvoke.MoveFileEx(tempPath, path, MOVE_FILE_FLAGS.MOVEFILE_REPLACE_EXISTING | MOVE_FILE_FLAGS.MOVEFILE_WRITE_THROUGH))
@@ -750,7 +750,7 @@ public static class Util
             "-",
             MethodAttributes.Public | MethodAttributes.Static,
             CallingConventions.Standard,
-            null, 
+            null,
             new[] { typeof(object), typeof(IList<string>), typeof(ulong) },
             obj.GetType(),
             true);
@@ -907,7 +907,7 @@ public static class Util
             }
         }
     }
-    
+
     /// <summary>
     /// Show a structure in an ImGui context.
     /// </summary>