Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

IJobChunk

interface in Unity.Entities

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

Description

IJobChunk is a type of [IJob] that iterates over a set of chunks. For each chunk the job runs on, the job code receives an ArchetypeChunk instance representing the full [chunk], plus a bitmask indicating which entities in the chunk should be processed.

[IJob]: xref:Unity.Jobs.IJob [chunk]: xref:concepts-archetypes#archetype-chunks

Schedule or run an IJobChunk job inside the SystemBase.OnUpdate function of a SystemBase implementation. When the system schedules or runs an IJobChunk job, it uses the specified EntityQuery to select a set of [chunks]. The entities in each chunk are examined to determine which have the necessary components enabled, according to the EntityQuery provided at schedule time. The job struct's Execute function is called for each chunk, along with a bitmask indicating which entities in the chunk should be processed.

To pass data to your Execute function (beyond the Execute parameters), add public fields to the IJobChunk struct declaration and set those fields immediately before scheduling the job. You must always pass the component type information for any components that the job reads or writes using a field of type, ComponentTypeHandle<T0>. Get this type information by calling the appropriate ComponentSystemBase.GetComponentTypeHandle function for the type of component.

[chunks]: xref:concepts-archetypes#archetype-chunks

Additional resources: JobChunkExtensions, IJobEntity

Public Methods

Method Description
Execute Implement the Execute function to perform a unit of work on an ArchetypeChunk representing a chunk.