CalculateBaseEntityIndexArray(AllocatorHandle)
Generates an array containing the index of the first entity within each chunk, relative to the list of entities that match this query.
Read time 1 minuteLast updated 3 days ago
Definition
- Type: Method
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
public NativeArray<int> CalculateBaseEntityIndexArray(AllocatorManager.AllocatorHandle allocator)
Parameters
The allocator used to allocate the output array.
Returns
Type | Description |
|---|---|
| NativeArray<int> | An array of integers, where array[N] is the index of the first entity in chunk N among the list of entities that match this query. The size of this array is given by EntityQuery.CalculateChunkCountWithoutFiltering. |
Remarks
Note that the chunk index used to access the output array's elements should be relative to the full, unfiltered list of chunks matched by this query. Most commonly, this is the chunkIndex parameter available within IJobChunk.Execute.
This function will automatically block until any running jobs which could affect its output have completed. For a non-blocking implementation, use EntityQuery.CalculateBaseEntityIndexArrayAsync.