Documentation

Unity Engine

Unity Engine

GetBufferTypeHandle<T>(bool)

Manually gets the run-time type information required to access an array of buffer components in a chunk.
Read time 1 minuteLast updated 5 days ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule
public BufferTypeHandle<T> GetBufferTypeHandle<T>(bool isReadOnly = false) where T : unmanaged, IBufferElementData

Parameters

isReadOnly

Whether the data is only read, not written. Access data as read-only whenever possible.

Returns

Type

Description

BufferTypeHandle<T>An object representing the type information required to safely access buffer components stored in a chunk.

Remarks

Remember to call BufferTypeHandle<T>.Update.
Pass a BufferTypeHandle instance to a job that has access to chunk data, such as an IJobChunk job, to access that type of buffer component inside the job.
Prefer using SystemAPI.GetBufferTypeHandle in SystemAPI as it will cache in OnCreate for you and call .Update(this) at the call-site.