Version: 2022.3
LanguageEnglish
  • C#

IJobParallelForTransformExtensions.ScheduleReadOnlyByRef

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static Unity.Jobs.JobHandle ScheduleReadOnlyByRef(ref T jobData, Jobs.TransformAccessArray transforms, int batchSize, Unity.Jobs.JobHandle dependsOn);

Parameters

jobData The job to schedule.
transforms The TransformAccessArray to run this job on.
batchSize Granularity in which workstealing is performed. A value of 32 means the job queue will steal 32 iterations and then perform them in an efficient inner loop.
dependsOn A JobHandle containing any jobs that must finish executing before this job begins. (Combine multiple jobs with JobHandle.CombineDependencies). Use dependencies to ensure that two jobs reading or writing to the same data do not run in parallel.

Returns

JobHandle The handle identifying the scheduled job. Can be used as a dependency for a later job or ensure completion on the main thread.

Description

Schedule an IJobParallelForTransform job with read-only access to the transform data. This method provides better parallelization because it can read all transforms in parallel instead of just parallelizing over different hierarchies.

Transforms are not guaranteed to be valid when this scheduling mode is used. Invalid transform references in the input array are still processed. Use TransformAccess.isValid to check whether a specific instance is valid.