Documentation

Unity Engine


Unity Engine


ScheduleParallelByRef<T>(ref T, EntityQuery, JobHandle)

Adds an IJobChunk instance to the job scheduler queue for parallel execution.
Read time 1 minuteLast updated a day ago

Definition

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

ScheduleParallelByRef<T>(T, EntityQuery, JobHandle)

public static JobHandle ScheduleParallelByRef<T>(this ref T jobData, EntityQuery query, JobHandle dependsOn) where T : struct, IJobChunk

Parameters

jobData

T
An IJobChunk 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 must complete before this job is executed. For example, 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. Most frequently, an appropriate value for this parameter is SystemState.Dependency to ensure that jobs registered with the safety system are taken into account as input dependencies.

Returns

Type

Description

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