Iterate over chunks of data with IJobChunk
To iterate through your data at the level of entire chunks of entities, implement IJobChunk inside a system
When you schedule an IJobChunk
job in the OnUpdate method of a system, the system uses the entity query you pass to the schedule method to identify the chunks that it should pass to the job.
The job invokes your Execute
method once for each matching chunk, and excludes those where no entities match the query because of enableable components. In your job’s Execute
method, you can iterate over the data inside each chunk, entity by entity.
Note
Iterating with IJobChunk
is more complicated and requires more code setup than using IJobEntity
(which generates an IJobChunk
under the hood). To automatically benefit from any future source-generation improvements, most jobs that perform a single iteration over a chunk's entities should prefer IJobEntity
(optionally implementing the IJobEntityChunkBeginEnd
interface as well, for any custom chunk-level operations before and after the core entity iteration loop).
Some examples of use cases which require IJobChunk
:
- jobs which do not iterate over each chunk's entities at all (e.g. gathering per-chunk statistics)
- jobs which perform multiple iterations over a chunk's entities, or which iterate in a unusual order.
For more information, the ECS samples repository contains a simple HelloCube example that demonstrates how to use IJobChunk
.
Additional resources
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.