mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
Add docs for RebuildRecommend
This commit is contained in:
parent
015c313c5e
commit
6ccc982d2b
2 changed files with 12 additions and 5 deletions
|
|
@ -1,6 +1,7 @@
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
|
|
||||||
using Dalamud.Interface.GameFonts;
|
using Dalamud.Interface.GameFonts;
|
||||||
|
using Dalamud.Interface.Utility;
|
||||||
|
|
||||||
using ImGuiNET;
|
using ImGuiNET;
|
||||||
|
|
||||||
|
|
@ -18,9 +19,17 @@ public interface IFontAtlas : IDisposable
|
||||||
event FontAtlasBuildStepDelegate? BuildStepChange;
|
event FontAtlasBuildStepDelegate? BuildStepChange;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Event fired when a font rebuild operation is suggested.<br />
|
/// Event fired when a font rebuild operation is recommended.<br />
|
||||||
/// This will be invoked from the main thread.
|
/// 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>
|
/// </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;
|
event Action? RebuildRecommend;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
|
||||||
|
|
@ -5,9 +5,7 @@ namespace Dalamud.Interface.ManagedFontAtlas.Internals;
|
||||||
/// </summary>
|
/// </summary>
|
||||||
internal interface IFontHandleManager : IDisposable
|
internal interface IFontHandleManager : IDisposable
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <inheritdoc cref="IFontAtlas.RebuildRecommend"/>
|
||||||
/// Event fired when a font rebuild operation is suggested.
|
|
||||||
/// </summary>
|
|
||||||
event Action? RebuildRecommend;
|
event Action? RebuildRecommend;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue