Struct chunked::CommandBuffer

pub struct CommandBuffer { /* fields omitted */ }

A command buffer for entity changes.

This is used as an allocated list of Snapshot modifications. The primary benefit is that this can be kept around between snapshot modifications and applied later. With CommandBuffers multiple systems can determine changes in parallel and apply them at the end.

Implementations

impl CommandBuffer

pub fn new() -> CommandBuffer

Create a new, empty, command buffer.

pub fn merge(buffers: &[&CommandBuffer]) -> CommandBuffer

Merge multiple command buffers.

If multiple command buffers reference the same component, the rightmost wins.

pub fn iter_edits(&self) -> CommandBufferIterator<'_>

Iterate over the edit list for this command buffer.

This is usually used with Snapshot::modify.

pub fn set_component<T: Component>(
    &mut self,
    entity_id: EntityID,
    component: &T
)

Set a single component on an entity.

pub fn remove_component<T: Component>(&mut self, entity_id: EntityID)

Remove a single component from an entity.

Trait Implementations

impl Clone for CommandBuffer

fn clone(&self) -> CommandBuffer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandBuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.