From a409ea60d6442a37c218dee954e27fc4e5e113d9 Mon Sep 17 00:00:00 2001 From: Soreepeong Date: Sun, 21 Jan 2024 04:54:35 +0900 Subject: [PATCH] Update docs --- .../IFontAtlasBuildToolkitPreBuild.cs | 14 ++++++++------ Dalamud/Interface/ManagedFontAtlas/IFontHandle.cs | 3 ++- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/Dalamud/Interface/ManagedFontAtlas/IFontAtlasBuildToolkitPreBuild.cs b/Dalamud/Interface/ManagedFontAtlas/IFontAtlasBuildToolkitPreBuild.cs index cb8a27a54..38d8d2fe8 100644 --- a/Dalamud/Interface/ManagedFontAtlas/IFontAtlasBuildToolkitPreBuild.cs +++ b/Dalamud/Interface/ManagedFontAtlas/IFontAtlasBuildToolkitPreBuild.cs @@ -54,11 +54,11 @@ public interface IFontAtlasBuildToolkitPreBuild : IFontAtlasBuildToolkit /// /// Adds a font from memory region allocated using .
- /// It WILL crash if you try to use a memory pointer allocated in some other way.
- /// + /// It WILL crash if you try to use a memory pointer allocated in some other way.
+ /// /// Do NOT call on the once this function has /// been called, unless is set and the function has thrown an error. - ///
+ /// ///
/// Memory address for the data allocated using . /// The size of the font file.. @@ -81,9 +81,11 @@ public interface IFontAtlasBuildToolkitPreBuild : IFontAtlasBuildToolkit /// /// Adds a font from memory region allocated using .
- /// It WILL crash if you try to use a memory pointer allocated in some other way.
- /// Do NOT call on the once this - /// function has been called. + /// It WILL crash if you try to use a memory pointer allocated in some other way.
+ /// + /// Do NOT call on the once this function has + /// been called, unless is set and the function has thrown an error. + /// ///
/// Memory address for the data allocated using . /// The size of the font file.. diff --git a/Dalamud/Interface/ManagedFontAtlas/IFontHandle.cs b/Dalamud/Interface/ManagedFontAtlas/IFontHandle.cs index eb57b815f..877cd60c9 100644 --- a/Dalamud/Interface/ManagedFontAtlas/IFontHandle.cs +++ b/Dalamud/Interface/ManagedFontAtlas/IFontHandle.cs @@ -53,7 +53,8 @@ public interface IFontHandle : IDisposable /// /// Locks the fully constructed instance of corresponding to the this - /// , for read-only use in any thread. + /// , for use in any thread.
+ /// Modification of the font will exhibit undefined behavior if some other thread also uses the font. ///
/// An instance of that must be disposed after use. ///