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

EntityQuery.CalculateBaseEntityIndexArray

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 NativeArray<int> CalculateBaseEntityIndexArray(AllocatorHandle allocator);

Parameters

Parameter Description
allocator The allocator used to allocate the output array.

Returns

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.

Description

Generates an array containing the index of the first entity within each chunk, relative to the list of entities that match this query.

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.