ScheduleByRef
Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.
Read time 2 minutesLast updated a day ago
Definition
- Type: Method
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
ScheduleByRef<T>(T, JobHandle)
Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.
public static JobHandle ScheduleByRef<T>(this ref T jobData, JobHandle dependsOn) where T : unmanaged, IJobEntity
Parameters
An IJobEntity instance. In this variant, the jobData is passed by reference, which may be necessary for unusually large job structs.
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 |
ScheduleByRef<T>(T, EntityQuery, JobHandle)
Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.
public static JobHandle ScheduleByRef<T>(this ref T jobData, EntityQuery query, JobHandle dependsOn) where T : unmanaged, IJobEntity
Parameters
An IJobEntity instance. In this variant, the jobData is passed by reference, which may be necessary for unusually large job structs.
The query selecting chunks with the necessary components.
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 |
ScheduleByRef<T>(T)
Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.
public static void ScheduleByRef<T>(this ref T jobData) where T : unmanaged, IJobEntity
Parameters
An IJobEntity instance. In this variant, the jobData is passed by reference, which may be necessary for unusually large job structs.
Remarks
This job automatically uses the system's Dependency property as the input and output dependency.
ScheduleByRef<T>(T, EntityQuery)
Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.
public static void ScheduleByRef<T>(this ref T jobData, EntityQuery query) where T : unmanaged, IJobEntity
Parameters
An IJobEntity instance. In this variant, the jobData is passed by reference, which may be necessary for unusually large job structs.
The query selecting chunks with the necessary components.
Remarks
This job automatically uses the system's Dependency property as the input and output dependency.