Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

ScheduleByRef<T>(ref T, int, int, JobHandle)

Schedules the job to execute 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, int, int, JobHandle)

public static JobHandle ScheduleByRef<T>(this ref T jobData, int arrayLength, int innerloopBatchCount, JobHandle dependsOn = default) where T : struct, IJobParallelFor

Parameters

jobData

T
The job and data to schedule.

arrayLength

int
The number of iterations to execute the for loop over.

innerloopBatchCount

int
The number of iterations which workstealing is performed over. For example, a value of 32 means the job queue steals 32 iterations and then performs them in an efficient inner loop.

dependsOn

JobHandle
The JobHandle of the job's dependency. You can use dependencies to make sure that a job executes on worker threads after the dependency has completed execution and two jobs that read or write to same data don't run in parallel.

Returns

Type

Description

JobHandleThe JobHandle of the scheduled job. You can use the 
JobHandle
as a dependency for a later job or to make sure that the job completes on the main thread.

Remarks

Additional Resources: IJobParallelFor.