Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

IJobParallelForTransformExtensions.ScheduleByRef

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 ScheduleByRef(ref T jobData, Jobs.TransformAccessArray transforms, Unity.Jobs.JobHandle dependsOn);

Parameters

jobData The job to schedule.
transforms The TransformAccessArray to run the job on.
dependsOn A JobHandle containing any jobs that must finish executing before this job begins. You can combine multiple jobs with JobHandle.CombineDependencies. Use dependencies to ensure that two jobs that read or write to the same data don't run in parallel.

Returns

JobHandle The handle identifying the scheduled job, which you can as a dependency for a later job or to ensure completion on the main thread.

Description

Schedules an IJobParallelForTransform job with read-write access to the transform data by reference.

This method parallelizes access to transforms in different hierarchies. Transforms with a shared root object are always processed on the same thread. All transforms are guaranteed to be valid when this scheduling mode is used. Invalid transform references in the input array are ignored.