Method CreateCommandBuffer
CreateCommandBuffer()
Creates an EntityCommandBuffer and adds it to this system's list of command buffers.
Declaration
public EntityCommandBuffer CreateCommandBuffer()Returns
| Type | Description |
|---|---|
| EntityCommandBuffer | A command buffer that will be executed by this system. |
Remarks
This buffer system executes its list of command buffers during its OnUpdate() function in the order you created the command buffers.
If you write to a command buffer in a Job, you must add the Job as a dependency of this system by calling AddJobHandleForProducer(JobHandle). The dependency ensures that the buffer system waits for the Job to complete before executing the command buffer.
If you write to a command buffer from a parallel Job, such as IJobEntity or IJobChunk, you must use the concurrent version of the command buffer, provided by EntityCommandBuffer.ParallelWriter.
CreateCommandBuffer(ref UnsafeList<EntityCommandBuffer>, AllocatorHandle, WorldUnmanaged)
Creates a command buffer, sets it up, and appends it to a list of command buffers.
Declaration
public static EntityCommandBuffer CreateCommandBuffer(ref UnsafeList<EntityCommandBuffer> pendingBuffers, AllocatorManager.AllocatorHandle allocator, WorldUnmanaged world)Parameters
| Type | Name | Description |
|---|---|---|
| UnsafeList<EntityCommandBuffer> | pendingBuffers | The list of command buffers to append to |
| AllocatorManager.AllocatorHandle | allocator | The allocator to allocate from, when building the command buffer |
| WorldUnmanaged | world | The world that this command buffer buffers changes for |
Returns
| Type | Description |
|---|---|
| EntityCommandBuffer | Returns the command buffer |
CreateCommandBuffer(ref UnsafeList<EntityCommandBuffer>, WorldUnmanaged)
Creates a command buffer that allocates from a World's Update Allocator, sets it up, and appends it to a list of command buffers.
Declaration
public static EntityCommandBuffer CreateCommandBuffer(ref UnsafeList<EntityCommandBuffer> pendingBuffers, WorldUnmanaged world)Parameters
| Type | Name | Description |
|---|---|---|
| UnsafeList<EntityCommandBuffer> | pendingBuffers | The list of command buffers to append to |
| WorldUnmanaged | world | The world that this command buffer buffers changes for |
Returns
| Type | Description |
|---|---|
| EntityCommandBuffer | Returns the command buffer |