Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


NextFrameAsync(CancellationToken)

Resumes execution on the next frame.
Read time 1 minuteLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public static Awaitable NextFrameAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken

Optional cancellation token.

Returns

Type

Description

Awaitable

Remarks

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

Examples

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(){ ...}