Creating jobs
To create a job in Unity you need to implement the IJob interface. IJob
allows you to schedule a single job that runs in parallel to any other jobs that are running.
Note: A “job” is a collective term in Unity for any struct that implements the IJob
interface.
To create a job, you need to:
- Create a struct that implements
IJob
.
- Add the member variables that the job uses (either blittable types or NativeContainer types).
- Create a method in your struct called Execute with the implementation of the job inside it.
When executing the job, the Execute
method runs once on a single core.
Note: When designing your job, remember that they operate on copies of data, except in the case of NativeContainer
. So, the only way to access data from a job in the main thread is by writing to a NativeContainer
.
An example of a simple job definition
// Job adding two floating point values together
public struct MyJob : IJob
{
public float a;
public float b;
public NativeArray<float> result;
public void Execute()
{
result[0] = a + b;
}
}
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?
Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.
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:
Thanks for helping to make the Unity documentation better!