Method GetBufferFromEntity
GetBufferFromEntity<T>(Boolean)
Gets a BufferFromEntity<T> object that can access a DynamicBuffer<T>.
Declaration
public BufferFromEntity<T> GetBufferFromEntity<T>(bool isReadOnly = false)
where T : struct, IBufferElementData
Parameters
Type | Name | Description |
---|---|---|
Boolean | isReadOnly | Whether the buffer data is only read or is also written. Access data in a read-only fashion whenever possible. |
Returns
Type | Description |
---|---|
BufferFromEntity<T> | An array-like object that provides access to buffers, indexed by Entity. |
Type Parameters
Name | Description |
---|---|
T | The type of IBufferElementData stored in the buffer. |
Remarks
Assign the returned object to a field of your Job struct so that you can access the
contents of the buffer in a Job.
When you call this method on the main thread, it invokes GetBufferFromEntity<T>(Boolean).
(An Entities.ForEach function invoked with Run()
executes on the main thread.) When you call this method
inside a job scheduled using Entities.ForEach, this method gets replaced direct access to
BufferFromEntity<T>.