CreateCommandBuffer
Creates an EntityCommandBuffer and adds it to this system's list of command buffers.
Read time 2 minutesLast updated a day ago
Definition
- Type: Method
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
CreateCommandBuffer()
Creates an EntityCommandBuffer and adds it to this system's list of command buffers.
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 EntityCommandBufferSystem.OnUpdate function in the order you created the command buffers.
This method requires a managed reference to the buffer system. To create a command buffer from unmanaged systems code, get the buffer system's component with SystemAPI.GetSingleton and call on that singleton instead.
SingletonCreateCommandBuffer(WorldUnmanaged)If you write to a command buffer created by this method in a job, you must add the job as a dependency of this system by calling EntityCommandBufferSystem.AddJobHandleForProducer. The dependency ensures that the buffer system waits for the job to complete before executing the command buffer. This step isn't necessary for command buffers created through the buffer system's component, because the buffer system completes all jobs scheduled against that singleton component before it plays the command buffer back.
SingletonIf 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(UnsafeList<EntityCommandBuffer>, AllocatorHandle, WorldUnmanaged)
Creates a command buffer, sets it up, and appends it to a list of command buffers.
public static EntityCommandBuffer CreateCommandBuffer(ref UnsafeList<EntityCommandBuffer> pendingBuffers, AllocatorManager.AllocatorHandle allocator, WorldUnmanaged world)
Parameters
The list of command buffers to append to
The allocator to allocate from, when building the command buffer
The world that this command buffer buffers changes for
Returns
Type | Description |
|---|---|
| EntityCommandBuffer | Returns the command buffer |
CreateCommandBuffer(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.
public static EntityCommandBuffer CreateCommandBuffer(ref UnsafeList<EntityCommandBuffer> pendingBuffers, WorldUnmanaged world)
Parameters
The list of command buffers to append to
The world that this command buffer buffers changes for
Returns
Type | Description |
|---|---|
| EntityCommandBuffer | Returns the command buffer |