Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

ScheduleBatchByRef<T>(ref T, int, int, JobHandle)

Schedules a job that will execute the parallel batch job for all arrayLength elements in batches of indicesPerJobCount. The Execute() method for Job T will be provided the start index and number of elements to safely operate on. In cases where indicesPerJobCount is not a multiple of arrayLength, the count provided to the Execute method of Job T will be smaller than the indicesPerJobCount specified here.
Read time 1 minuteLast updated 10 days ago

Definition

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

ScheduleBatchByRef<T>(T, int, int, JobHandle)

public static JobHandle ScheduleBatchByRef<T>(this ref T jobData, int arrayLength, int indicesPerJobCount, JobHandle dependsOn = default) where T : struct, IJobParallelForBatch

Parameters

jobData

T
The job and data to schedule. In this variant, the jobData is passed by reference, which may be necessary for unusually large job structs.

arrayLength

int
Total number of elements to consider when batching.

indicesPerJobCount

int
Number of elements to consider in a single parallel batch.

dependsOn

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