add comment for Font.Load

cosmonaut 2023-12-15 10:03:51 -08:00
parent 95baaf3a91
commit 1bd1560560
1 changed files with 5 additions and 0 deletions

View File

@ -16,6 +16,11 @@ namespace MoonWorks.Graphics.Font
private byte* StringBytes;
private int StringBytesLength;
/// <summary>
/// Loads a TTF or OTF font from a path for use in MSDF rendering.
/// Note that there must be an msdf-atlas-gen JSON and image file alongside.
/// </summary>
/// <returns></returns>
public unsafe static Font Load(
GraphicsDevice graphicsDevice,
CommandBuffer commandBuffer,