AtlasLoadEvent

Namespace: Shadop.Archmage.Sdk

Progress event data reported during asynchronous Atlas item loading.

public struct AtlasLoadEvent

Remarks:

AtlasLoadEvent instances are reported to an IProgress implementation passed to Archmage.LoadAtlasAsync(String, String, IAtlas, AtlasOptions, IProgress, CancellationToken). This allows consumers to track loading progress and provide feedback to the user.

The Elapsed property can be used to implement timeouts or progress visualization.

Properties

public string Key { get; }

public AtlasLoadStage Stage { get; }

Set during StartReading, StartParsing, StartReadingOverride, and ApplyingOverride; null for StartProcessing and Completed.

public string FilePath { get; }

public TimeSpan Elapsed { get; }

The total number of atlas items to load. Only meaningful for AtlasLoadStage.ItemsQueued.

public int Total { get; }

AtlasLoadEvent(string key, AtlasLoadStage stage, string filePath, TimeSpan elapsed, int total)

filePath String

elapsed TimeSpan

total Int32