Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Background Tasks window reference

Monitor and manage long-running operations such as asset imports, shader compilation, and lighting builds.
Read time 3 minutesLast updated 11 days ago

The Background Tasks window displays the progress of any running asynchronous tasks. For example, you can see the progress for shader compilation, lightmap baking, and occlusion culling.
To open the Background Tasks window, do one of the following:
  • From the menu, select Window > General > Progress.
  • From the Unity Editor status bar, click the global progress bar or the activity indicator (spinner).

The Background Tasks Window

  1. Toolbar

    ?

    : Provides options to filter tasks and clear inactive tasks from the list.
  2. Task list: Displays progress information about each task for the following:
    • Active tasks, including tasks that have stopped responding.
    • Some finished tasks. By default, Unity removes these from the list, but some are designed to stay in the list until you clear them manually.
    • Failed and cancelled tasks.

Task information

Each entry in the Background Tasks window displays the following information about the task.

Components of a background task entry

Screenshot label

Section

Displays

1Task name/descriptionA name or short description for the task.
2Progress barIndicates how close the task is to completion.

If the task is indeterminate, because its progress is not measurable, the bar shows a small filled region that moves from side to side until the task is finished.
3Percent completeShows how close the task is to completion, as a percentage.

For indeterminate tasks, whose progress is not measurable, this area is empty.
4CancelClick to cancel an active task.

If the task cannot be cancelled, this icon does not appear.
5StatusOptionally displays a short description of the current activity for an active task.

When the task finishes, this area displays its final status (for example, finished, failed, or cancelled).
6Time elapsed/remaining/totalWhen an active task takes longer than a few seconds, displays either the current time elapsed or the estimated time remaining.

When the task finishes, this area displays the total time elapsed.

Subtasks

Some tasks spawn subtasks. The progress window displays an overall progress entry in the parent task (1), and a sub progress entry for each child task (2).

Subtasks in the Background Tasks window

Monitor subtasks to determine which part of a complex task takes the most time. This is useful for operations like lightmap baking, which can have hundreds of subtasks.

View task status

Background tasks can have the following statuses:

Status

Description

Icon

ActiveThe task is running and reports progress as percent complete, or estimated time remaining.None
IndeterminateThe task is running and reports progress, but cannot determine how close it is to being complete.None
FinishedThe task finished successfully

A check mark for a finished task


(check mark)
UnresponsiveThe task has not reported any progress for five seconds.None
CancelledThe task is no longer active because you cancelled it manually.

Some tasks cannot be cancelled from the Background Tasks window.

A warning symbol for a cancelled task


(warning symbol)
FailedThe task is no longer active because it failed

An error symbol for a failed task


(error symbol)

Filter tasks by status

Use the filter options in the Background Tasks window toolbar to hide and show different types of tasks.

Filter toggles in the Background Tasks window

Filter option

Shows or hides

A check mark for a finished task


(check mark)
Finished tasks

A warning symbol for a cancelled or unresponsive task


(warning symbol)
Cancelled and unresponsive tasks

An error symbol for a failed task


(error symbol)
Failed tasks

Cancel active tasks

You can cancel some running tasks directly from the Background Tasks window. To cancel a running task click the cancel (x) icon.

Clear inactive tasks

Click the Clear inactive button in the toolbar to remove all inactive tasks from the list.
Unity automatically clears most finished tasks from the list. However, some tasks are designed to stay in the list until you clear them manually.
Failed and cancelled tasks also stay in the list until you clear them.
To clear unresponsive tasks, you must cancel them first.

View global progress

The Unity Editor status bar displays a global progress bar that shows the aggregate overall progress of all active tasks. It does not include finished, failed, or cancelled tasks.