Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


ScheduleByRef<T>(ref T, JobHandle)

Schedules the job for execution on a worker thread by reference.
Read time 1 minuteLast updated 14 days ago

Definition

  • Type: Method
  • Namespace: Unity.Jobs
  • Assembly: UnityEngine.CoreModule

ScheduleByRef<T>(T, JobHandle)

public static JobHandle ScheduleByRef<T>(this ref T jobData, JobHandle dependsOn = default) where T : struct, IJob

Parameters

jobData

T
The job and data to schedule.

dependsOn

The dependency of the job. Dependencies ensure that a job executes on worker threads after the dependency has completed execution, and that two jobs reading or writing to same data do not run in parallel.

Returns

Type

Description

JobHandleThe handle identifying the scheduled job, which you can use as a dependency for a later job or to ensure completion on the main thread.

Remarks

Additional Resources: IJob.