Skip to content

AssetLoadProgress Struct

Progress snapshot reported during asset preloading. Value type to avoid per-report heap allocations on the preload path.

public readonly record struct AssetLoadProgress : System.IEquatable<Brine2D.Assets.AssetLoadProgress>

Implements System.IEquatable<AssetLoadProgress>

Remarks

default(AssetLoadProgress) zeroes all fields (LastCompletedAsset will be null). Always construct via object initializer.

Properties
FailedAssets Number of assets that threw during loading.
LastCompletedAsset Path of the most recently completed asset (success or failure).
ProgressRatio Overall completion ratio (0.0–1.0) including both successful and failed assets. Reaches 1.0 when all assets have been attempted, regardless of outcome. Use SuccessRatio for the success-only ratio.
SucceededAssets Number of assets that loaded successfully.
SuccessRatio Ratio (0.0–1.0) of successfully loaded assets to total. Will be less than ProgressRatio when any assets have failed.
TotalAssets Total number of assets in the manifest being preloaded.