BakeProgressState

Description

Provides progress reporting and cancellation support for asynchronous light baking operations.

This class reports progress for ongoing asynchronous bake operations and provides a method to request the cancellation of the operation. It supports work-step based progress tracking and can be shared across multiple operations for unified progress reporting.

BakeProgressState is commonly used with:

• InputExtraction.PopulateWorld for world population progress.
• IProbeIntegrator methods for integration progress tracking.
• Long-running light transport operations that benefit from progress feedback.

The progress state uses a work-step model where the total expected work is set upfront and completed work is incremented as operations progress.

// Set up progress tracking for a baking operation
using var progress = new BakeProgressState();
progress.SetTotalWorkSteps(1000);

// Configure integrator to report progress
var integrator = new RadeonRaysProbeIntegrator();
integrator.SetProgressReporter(progress);

// Start integration operation
var integrationTask = Task.Run(() =>
{
    return integrator.IntegrateDirectRadiance(
        context, 0, probeCount, 2048, false, outputBuffer);
});

// Monitor progress and allow cancellation
while (!integrationTask.IsCompleted)
{
    float currentProgress = progress.Progress();
    Debug.Log($"Baking progress: {currentProgress * 100:F1}%");

    // Check for user cancellation
    if (Input.GetKeyDown(KeyCode.Escape))
    {
        progress.Cancel();
        Debug.Log("Cancelling bake operation...");
    }

    await Task.Delay(100);
}

// Check if operation was cancelled
if (progress.WasCancelled())
{
    Debug.Log("Bake operation was cancelled");
}
else
{
    var result = await integrationTask;
    Debug.Log($"Bake completed: {result.type}");
}

Constructors

Public Methods