Version: Unity 6 (6000.0)
LanguageEnglish
  • C#

Awaitable.BackgroundThreadAsync

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static BackgroundThreadAwaitable BackgroundThreadAsync();

Returns

BackgroundThreadAwaitable Awaitable object that completes when switching to a background thread.

Description

Resumes execution on a ThreadPool background thread. Completes immediately when called from a background thread.

private async Awaitable<float> DoSomeHeavyComputationInBackgroundAsync(bool continueOnMainThread = true)
{
    await Awaitable.BackgroundThreadAsync();
    // do some heavy math here
    float result = 42;

// by default, switch back to main thread: if(continueOnMainThread){ await Awaitable.MainThreadAsync(); } return result; }

public async Awaitable Start() { var computationResult = await DoSomeHeavyComputationInBackgroundAsync(); await SceneManager.LoadSceneAsync("my-scene"); }