ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-11 01:37:24 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Clarify exception and docs regarding off-thread drawing with SeStrings, again

Browse source
This commit is contained in:
goaaats 2025-12-07 12:54:13 +01:00
parent ab5ea34e68
commit caa869d3ac
2 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Dalamud/Interface/ImGuiSeStringRenderer/SeStringDrawParams.cs
View file

@ -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>

2
Dalamud/Interface/ImGuiSeStringRenderer/SeStringDrawState.cs
View file

@ -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.