class MAGES::LoadingIndicator

Overview

Static class that manages loading indicators. More…

class LoadingIndicator
{
public:
    // classes

    class Handle;

    // methods

    static Handle Create();
    static void Update(Handle handle, string description, float progress);
    static void Close(Handle handle);
};

Detailed Documentation

Static class that manages loading indicators.

Methods

static Handle Create()

Creates a loading handle.

Parameters:

System.InvalidOperationException

Thrown when the underlying resource has not been configured correctly.

Returns:

The handle.

static void Update(Handle handle, string description, float progress)

Updates the specified handle.

Parameters:

handle

The handle to update.

description

The description to use.

progress

The progress [0, 1].

static void Close(Handle handle)

Closes the specified handle.

Parameters:

handle

The handle to close.