Skip to main content

Interface IFontAtlasBuildToolkit

Common stuff for Dalamud.Interface.ManagedFontAtlas.IFontAtlasBuildToolkitPreBuild and Dalamud.Interface.ManagedFontAtlas.IFontAtlasBuildToolkitPostBuild.

Not intended for plugins to implement.

Assembly: Dalamud.dll
View Source
Declaration
public interface IFontAtlasBuildToolkit

Properties

Font

Gets or sets the font relevant to the call.

View Source
Declaration
ImFontPtr Font { get; set; }

Scale

Gets the current scale this font atlas is being built with.

View Source
Declaration
float Scale { get; }

IsAsyncBuildOperation

Gets a value indicating whether the current build operation is asynchronous.

View Source
Declaration
bool IsAsyncBuildOperation { get; }

BuildStep

Gets the current build step.

View Source
Declaration
FontAtlasBuildStep BuildStep { get; }

NewImAtlas

Gets the font atlas being built.

View Source
Declaration
ImFontAtlasPtr NewImAtlas { get; }

Fonts

Gets the wrapper for ImGuiNET.ImFontAtlas.Fonts of Dalamud.Interface.ManagedFontAtlas.IFontAtlasBuildToolkit.NewImAtlas.

This does not need to be disposed. Calling System.IDisposable.Dispose does nothing.-

Modification of this vector may result in undefined behaviors.

View Source
Declaration
ImVectorWrapper<ImFontPtr> Fonts { get; }

Methods

DisposeWithAtlas<T>(T)

Queues an item to be disposed after the native atlas gets disposed, successful or not.

View Source
Declaration
T DisposeWithAtlas<T>(T disposable) where T : IDisposable
Returns

<T>: The same <code class="paramref">disposable</code>.

Parameters
TypeNameDescription
<T>disposableThe disposable.
Type Parameters
NameDescription
TDisposable type.

DisposeWithAtlas(GCHandle)

Queues an item to be disposed after the native atlas gets disposed, successful or not.

View Source
Declaration
GCHandle DisposeWithAtlas(GCHandle gcHandle)
Returns

System.Runtime.InteropServices.GCHandle: The same <code class="paramref">gcHandle</code>.

Parameters
TypeNameDescription
System.Runtime.InteropServices.GCHandlegcHandleThe gc handle.

DisposeWithAtlas(Action)

Queues an item to be disposed after the native atlas gets disposed, successful or not.

View Source
Declaration
void DisposeWithAtlas(Action action)
Parameters
TypeNameDescription
System.ActionactionThe action to run on dispose.

GetFont(IFontHandle)

Gets the instance of ImGuiNET.ImFontPtr corresponding to <code class="paramref">fontHandle</code> from Dalamud.Interface.ManagedFontAtlas.IFontAtlasBuildToolkit.NewImAtlas.

View Source
Declaration
ImFontPtr GetFont(IFontHandle fontHandle)
Returns

ImGuiNET.ImFontPtr: The corresonding ImGuiNET.ImFontPtr, or default if not found.

Parameters
TypeNameDescription
Dalamud.Interface.ManagedFontAtlas.IFontHandlefontHandleThe font handle.

Extension Methods

  • Dalamud.Interface.ManagedFontAtlas.IFontAtlasBuildToolkit.Dalamud.Interface.ManagedFontAtlas.FontAtlasBuildToolkitUtilities.FindConfigPtr(ImGuiNET.ImFontPtr)
  • Dalamud.Interface.ManagedFontAtlas.IFontAtlasBuildToolkit.Dalamud.Interface.ManagedFontAtlas.FontAtlasBuildToolkitUtilities.OnPostBuild(System.Action{Dalamud.Interface.ManagedFontAtlas.IFontAtlasBuildToolkitPostBuild})
  • Dalamud.Interface.ManagedFontAtlas.IFontAtlasBuildToolkit.Dalamud.Interface.ManagedFontAtlas.FontAtlasBuildToolkitUtilities.OnPreBuild(System.Action{Dalamud.Interface.ManagedFontAtlas.IFontAtlasBuildToolkitPreBuild})