Method ScheduleParallel
ScheduleParallel<T>(T, EntityQuery, Int32, JobHandle)
Adds an IJobEntityBatchWithIndex instance to the job scheduler queue for parallel execution.
Declaration
public static JobHandle ScheduleParallel<T>(this T jobData, EntityQuery query, int batchesPerChunk = 1, JobHandle dependsOn = null)
where T : struct, IJobEntityBatchWithIndexParameters
| Type | Name | Description |
|---|---|---|
| T | jobData | An IJobEntityBatchWithIndex instance. |
| EntityQuery | query | The query selecting chunks with the necessary components. |
| Int32 | batchesPerChunk | |
| JobHandle | dependsOn | The handle identifying already scheduled jobs that could constrain this job. A job that writes to a component cannot run in parallel with other jobs that read or write that component. Jobs that only read the same components can run in parallel. |
Returns
| Type | Description |
|---|---|
| JobHandle | A handle that combines the current Job with previous dependencies identified by the |
Type Parameters
| Name | Description |
|---|---|
| T | The specific IJobEntityBatchWithIndex implementation type. |
Remarks
This scheduling variant processes each matching chunk as a single batch. Each chunk can execute in parallel. This scheduling method is equivalent to calling ScheduleParallel<T>(T, EntityQuery, Int32, JobHandle) with the batchesPerChunk parameter set to 1.
ScheduleParallel<T>(T, EntityQuery, NativeArray<Entity>, JobHandle)
Adds an IJobEntityBatchWithIndex instance to the job scheduler queue for parallel execution.
Declaration
public static JobHandle ScheduleParallel<T>(this T jobData, EntityQuery query, NativeArray<Entity> limitToEntityArray, JobHandle dependsOn = null)
where T : struct, IJobEntityBatchWithIndexParameters
| Type | Name | Description |
|---|---|---|
| T | jobData | An IJobEntityBatchWithIndex instance. |
| EntityQuery | query | The query selecting chunks with the necessary components. |
| NativeArray<Entity> | limitToEntityArray | A list of entities to limit execution to. Only entities in the list will be processed. |
| JobHandle | dependsOn | The handle identifying already scheduled jobs that could constrain this job. A job that writes to a component cannot run in parallel with other jobs that read or write that component. Jobs that only read the same components can run in parallel. |
Returns
| Type | Description |
|---|---|
| JobHandle | A handle that combines the current Job with previous dependencies identified by the |
Type Parameters
| Name | Description |
|---|---|
| T | The specific IJobEntityBatchWithIndex implementation type. |
Remarks
This scheduling variant processes each batch found in the entity array. Each batch can execute in parallel.