Unity - Scripting API: Awaitable.NextFrameAsync

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.

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.

Your name Your email Suggestion*

Cancel

Declaration

public static Awaitable NextFrameAsync(CancellationToken cancellationToken);

Parameters

Parameter	Description
cancellationToken	Optional cancellation token.

Description

Resumes execution on the next frame.

Note: This method can only be called from the main thread and always completes on main thread.

async Awaitable SampleSchedulingJobsForNextFrame()
{
    // Wait until end of frame to avoid competing over resources with other Unity subsystems
    await Awaitable.EndOfFrameAsync();
    var jobHandle = ScheduleSomethingWithJobSystem();
    // Let the job execute while the next frame starts
    await Awaitable.NextFrameAsync();
    jobHandle.Complete();
    // Use results of computation
}JobHandle ScheduleSomethingWithJobSystem()
{
    ...
}