From e144956a483e8b0d2dee16a2d58ccd6b1b2c3bfe Mon Sep 17 00:00:00 2001
From: Soreepeong <soreepeong@gmail.com>
Date: Wed, 5 Jun 2024 00:14:36 +0900
Subject: [PATCH] Add notes on CreateTextureAsync

---
 .../SharedImmediateTextures/SharedImmediateTexture.cs        | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/Dalamud/Interface/Textures/Internal/SharedImmediateTextures/SharedImmediateTexture.cs b/Dalamud/Interface/Textures/Internal/SharedImmediateTextures/SharedImmediateTexture.cs
index a20736e0a..1c218f6af 100644
--- a/Dalamud/Interface/Textures/Internal/SharedImmediateTextures/SharedImmediateTexture.cs
+++ b/Dalamud/Interface/Textures/Internal/SharedImmediateTextures/SharedImmediateTexture.cs
@@ -344,9 +344,12 @@ internal abstract class SharedImmediateTexture
             default(CancellationToken));
     }
 
-    /// <summary>Creates the texture.</summary>
+    /// <summary>Creates the texture immediately.</summary>
     /// <param name="cancellationToken">The cancellation token.</param>
     /// <returns>The task resulting in a loaded texture.</returns>
+    /// <remarks>This function is intended to be called from texture load scheduler.
+    /// See <see cref="LoadUnderlyingWrap"/> and note that this function is being used as the callback from
+    /// <see cref="DynamicPriorityQueueLoader.LoadAsync{T}"/>.</remarks>
     protected abstract Task<IDalamudTextureWrap> CreateTextureAsync(CancellationToken cancellationToken);
 
     private IRefCountable.RefCountResult TryAddRef(out int newRefCount)