ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Add docs for RebuildRecommend

Browse source
This commit is contained in:
Soreepeong 2024-01-12 12:21:36 +09:00
parent 015c313c5e
commit 6ccc982d2b
2 changed files with 12 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

13
Dalamud/Interface/ManagedFontAtlas/IFontAtlas.cs
View file

@ -1,6 +1,7 @@
using System.Threading.Tasks;
using Dalamud.Interface.GameFonts;
using Dalamud.Interface.Utility;
using ImGuiNET;
@ -18,9 +19,17 @@ public interface IFontAtlas : IDisposable
event FontAtlasBuildStepDelegate? BuildStepChange;
/// <summary>
/// Event fired when a font rebuild operation is suggested.<br />
/// This will be invoked from the main thread.
/// Event fired when a font rebuild operation is recommended.<br />
/// This event will be invoked from the main thread.<br />
/// <br />
/// Reasons for the event include changes in <see cref="ImGuiHelpers.GlobalScale"/> and
/// initialization of new associated font handles.
/// </summary>
/// <remarks>
/// You should call <see cref="BuildFontsAsync"/> or <see cref="BuildFontsOnNextFrame"/>
/// if <see cref="AutoRebuildMode"/> is not set to <c>true</c>.<br />
/// Avoid calling <see cref="BuildFontsImmediately"/> here; it will block the main thread.
/// </remarks>
event Action? RebuildRecommend;
/// <summary>

4
Dalamud/Interface/ManagedFontAtlas/Internals/IFontHandleManager.cs
View file

@ -5,9 +5,7 @@ namespace Dalamud.Interface.ManagedFontAtlas.Internals;
/// </summary>
internal interface IFontHandleManager : IDisposable
{
/// <summary>
/// Event fired when a font rebuild operation is suggested.
/// </summary>
/// <inheritdoc cref="IFontAtlas.RebuildRecommend"/>
event Action? RebuildRecommend;
/// <summary>