Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Schedule

Schedule the job for execution on worker threads. list.Length is used as the iteration count. Note that it is required to embed the list on the job struct as well.
Read time 2 minutesLast updated 10 days ago

Definition

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

Schedule<T, U>(T, NativeList<T>, int, JobHandle)

Schedule the job for execution on worker threads. list.Length is used as the iteration count. Note that it is required to embed the list on the job struct as well.
public static JobHandle Schedule<T, U>(this T jobData, NativeList<U> list, int innerloopBatchCount, JobHandle dependsOn = default) where T : struct, IJobParallelForDefer where U : unmanaged

Parameters

jobData

T
The job and data to schedule.

list.Length is used as the iteration count.

innerloopBatchCount

Granularity in which workstealing is performed. A value of 32, means the job queue will steal 32 iterations and then perform them in an efficient inner loop.

dependsOn

Dependencies are used to ensure that a job executes on workerthreads after the dependency has completed execution. Making sure that two jobs reading or writing to same data do not run in parallel.

Returns

Type

Description

JobHandleJobHandle The handle identifying the scheduled job. Can be used as a dependency for a later job or ensure completion on the main thread.

Schedule<T>(T, int*, int, JobHandle)

Schedule the job for execution on worker threads. forEachCount is a pointer to the number of iterations, when dependsOn has completed. This API is unsafe, it is recommended to use the NativeList based Schedule method instead.
public static JobHandle Schedule<T>(this T jobData, int* forEachCount, int innerloopBatchCount, JobHandle dependsOn = default) where T : struct, IJobParallelForDefer

Parameters

jobData

T
The job and data to schedule.

forEachCount

*forEachCount is used as the iteration count.

innerloopBatchCount

Granularity in which workstealing is performed. A value of 32, means the job queue will steal 32 iterations and then perform them in an efficient inner loop.

dependsOn

Dependencies are used to ensure that a job executes on workerthreads after the dependency has completed execution. Making sure that two jobs reading or writing to same data do not run in parallel.

Returns

Type

Description

JobHandle