From caa869d3ace57609680782b5862bb1d0820e86b5 Mon Sep 17 00:00:00 2001
From: goaaats <goatsdev@protonmail.com>
Date: Sun, 7 Dec 2025 12:54:13 +0100
Subject: [PATCH] Clarify exception and docs regarding off-thread drawing with
 SeStrings, again

---
 .../Interface/ImGuiSeStringRenderer/SeStringDrawParams.cs    | 5 ++++-
 Dalamud/Interface/ImGuiSeStringRenderer/SeStringDrawState.cs | 2 +-
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/Dalamud/Interface/ImGuiSeStringRenderer/SeStringDrawParams.cs b/Dalamud/Interface/ImGuiSeStringRenderer/SeStringDrawParams.cs
index 1d8126f3b..972013328 100644
--- a/Dalamud/Interface/ImGuiSeStringRenderer/SeStringDrawParams.cs
+++ b/Dalamud/Interface/ImGuiSeStringRenderer/SeStringDrawParams.cs
@@ -14,8 +14,9 @@ public record struct SeStringDrawParams
     /// <see cref="ImGui.GetWindowDrawList"/> (the default).</value>
     /// <remarks>
     /// If this value is set, <see cref="ImGui.Dummy"/> will not be called, and ImGui ID will be ignored.
-    /// You <b>must</b> specify a valid draw list and a valid font via <see cref="Font"/> if you set this value,
+    /// You <b>must</b> specify a valid draw list, a valid font via <see cref="Font"/> and <see cref="FontSize"/> if you set this value,
     /// since the renderer will not be able to retrieve them from ImGui context.
+    /// Must be set when drawing off the main thread.
     /// </remarks>
     public ImDrawListPtr? TargetDrawList { get; set; }
 
@@ -29,11 +30,13 @@ public record struct SeStringDrawParams
 
     /// <summary>Gets or sets the font to use.</summary>
     /// <value>Font to use, or <c>null</c> to use <see cref="ImGui.GetFont"/> (the default).</value>
+    /// <remarks>Must be set when specifying a target draw-list or drawing off the main thread.</remarks>
     public ImFontPtr? Font { get; set; }
 
     /// <summary>Gets or sets the font size.</summary>
     /// <value>Font size in pixels, or <c>0</c> to use the current ImGui font size <see cref="ImGui.GetFontSize"/>.
     /// </value>
+    /// <remarks>Must be set when specifying a target draw-list or drawing off the main thread.</remarks>
     public float? FontSize { get; set; }
 
     /// <summary>Gets or sets the line height ratio.</summary>
diff --git a/Dalamud/Interface/ImGuiSeStringRenderer/SeStringDrawState.cs b/Dalamud/Interface/ImGuiSeStringRenderer/SeStringDrawState.cs
index 11c1120b4..04d0501b1 100644
--- a/Dalamud/Interface/ImGuiSeStringRenderer/SeStringDrawState.cs
+++ b/Dalamud/Interface/ImGuiSeStringRenderer/SeStringDrawState.cs
@@ -65,7 +65,7 @@ public unsafe ref struct SeStringDrawState
             this.drawList = ssdp.TargetDrawList.Value;
             this.ScreenOffset = Vector2.Zero;
             this.FontSize = ssdp.FontSize ?? throw new ArgumentException(
-                                $"{nameof(ssdp.FontSize)} must be set to render outside the main thread.");
+                                $"{nameof(ssdp.FontSize)} must be set when specifying a target draw list, as it cannot be fetched from the ImGui state.");
             this.WrapWidth = ssdp.WrapWidth ?? float.MaxValue;
             this.Color = ssdp.Color ?? uint.MaxValue;
             this.LinkHoverBackColor = 0; // Interactivity is unused outside the main thread.