Interface IFontAtlasBuildToolkit

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

Not intended for plugins to implement.

Assembly: Dalamud.dll

Declaration

public interface IFontAtlasBuildToolkit

Properties

Font

Gets or sets the font relevant to the call.

Declaration

ImFontPtr Font { get; set; }

Scale

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

Declaration

float Scale { get; }

IsAsyncBuildOperation

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

Declaration

bool IsAsyncBuildOperation { get; }

BuildStep

Gets the current build step.

Declaration

FontAtlasBuildStep BuildStep { get; }

NewImAtlas

Gets the font atlas being built.

Declaration

ImFontAtlasPtr NewImAtlas { get; }

Fonts

Gets the wrapper for Dalamud.Bindings.ImGui.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.

Declaration

ImVectorWrapper<ImFontPtr> Fonts { get; }

Methods

DisposeWithAtlas<T>(T)

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

Declaration

T DisposeWithAtlas<T>(T disposable) where T : IDisposable

Returns

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

Parameters

Type	Name	Description
<T>	disposable	The disposable.

Type Parameters

Name	Description
T	Disposable type.

DisposeWithAtlas(GCHandle)

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

Declaration

GCHandle DisposeWithAtlas(GCHandle gcHandle)

Returns

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

Parameters

Type	Name	Description
System.Runtime.InteropServices.GCHandle	gcHandle	The gc handle.

DisposeWithAtlas(Action)

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

Declaration

void DisposeWithAtlas(Action action)

Parameters

Type	Name	Description
System.Action	action	The action to run on dispose.

GetFont(IFontHandle)

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

Declaration

ImFontPtr GetFont(IFontHandle fontHandle)

Returns

Dalamud.Bindings.ImGui.ImFontPtr: The corresonding Dalamud.Bindings.ImGui.ImFontPtr, or default if not found.

Parameters

Type	Name	Description
Dalamud.Interface.ManagedFontAtlas.IFontHandle	fontHandle	The font handle.

Extension Methods

• Dalamud.Interface.ManagedFontAtlas.IFontAtlasBuildToolkit.Dalamud.Interface.ManagedFontAtlas.FontAtlasBuildToolkitUtilities.FindConfigPtr(Dalamud.Bindings.ImGui.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})