Documentation

Unity Engine


Unity Engine


ScheduleParallelByRef

Adds an IJobEntity instance to the job scheduler queue for parallel execution.
Read time 2 minutesLast updated 2 days ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule

ScheduleParallelByRef<T>(T, JobHandle)

Adds an IJobEntity instance to the job scheduler queue for parallel execution.
public static JobHandle ScheduleParallelByRef<T>(this ref T jobData, JobHandle dependsOn) where T : unmanaged, IJobEntity

Parameters

jobData

T
An IJobEntity instance. In this variant, the jobData is passed by reference, which may be necessary for unusually large job structs.

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

JobHandleA handle that combines the current Job with previous dependencies identified by the
dependsOn
parameter.

ScheduleParallelByRef<T>(T, EntityQuery, JobHandle)

Adds an IJobEntity instance to the job scheduler queue for parallel execution.
public static JobHandle ScheduleParallelByRef<T>(this ref T jobData, EntityQuery query, JobHandle dependsOn) where T : unmanaged, IJobEntity

Parameters

jobData

T
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.

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

JobHandleA handle that combines the current Job with previous dependencies identified by the
dependsOn
parameter.

ScheduleParallelByRef<T>(T)

Adds an IJobEntity instance to the job scheduler queue for parallel execution.
public static void ScheduleParallelByRef<T>(this ref T jobData) where T : unmanaged, IJobEntity

Parameters

jobData

T
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.

ScheduleParallelByRef<T>(T, EntityQuery)

Adds an IJobEntity instance to the job scheduler queue for parallel execution.
public static void ScheduleParallelByRef<T>(this ref T jobData, EntityQuery query) where T : unmanaged, IJobEntity

Parameters

jobData

T
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.