helios::ecs::details::CmdBuffer Class Reference

Command buffer to record operations to be executed later. More...

#include <command_buffer.hpp>

Public Member Functions
	CmdBuffer (SystemLocalStorage &local_storage) noexcept
	CmdBuffer (const CmdBuffer &)=delete
	CmdBuffer (CmdBuffer &&)=delete
	~CmdBuffer () noexcept=default
CmdBuffer &	operator= (const CmdBuffer &)=delete
CmdBuffer &	operator= (CmdBuffer &&)=delete
void	Push (std::unique_ptr< Command > command)
	Pushes a pre-constructed command to the buffer.
template<CommandTrait T, typename... Args> requires std::constructible_from<T, Args...>
void	Emplace (Args &&... args)
	Constructs and pushes a command to the buffer.

Detailed Description

Command buffer to record operations to be executed later.

All operations are recorded to system local storage and executed in the order they were recorded when World::Update() is called.

Note

Command buffer is not thread-safe but doesn't need to be since each system has its own local storage.

Definition at line 22 of file command_buffer.hpp.

Constructor & Destructor Documentation

CmdBuffer() [1/3]

helios::ecs::details::CmdBuffer::CmdBuffer ( SystemLocalStorage &  local_storage )

inlineexplicitnoexcept

Definition at line 24 of file command_buffer.hpp.

: local_storage_(local_storage) {}

CmdBuffer() [2/3]

helios::ecs::details::CmdBuffer::CmdBuffer ( const CmdBuffer &  )

delete

CmdBuffer() [3/3]

helios::ecs::details::CmdBuffer::CmdBuffer ( CmdBuffer &&  )

delete

~CmdBuffer()

helios::ecs::details::CmdBuffer::~CmdBuffer ( )

defaultnoexcept

Member Function Documentation

Emplace()

template<CommandTrait T, typename... Args>
requires std::constructible_from<T, Args...>

void helios::ecs::details::CmdBuffer::Emplace ( Args &&...  args )

inline

Constructs and pushes a command to the buffer.

Template Parameters

T	Command type
Args	Constructor argument types

Parameters

args	Arguments to forward to command constructor

Definition at line 46 of file command_buffer.hpp.

                               {
    local_storage_.EmplaceCommand<T>(std::forward<Args>(args)...);
  }

operator=() [1/2]

CmdBuffer & helios::ecs::details::CmdBuffer::operator= ( CmdBuffer &&  )

delete

operator=() [2/2]

CmdBuffer & helios::ecs::details::CmdBuffer::operator= ( const CmdBuffer &  )

delete

Push()

void helios::ecs::details::CmdBuffer::Push ( std::unique_ptr< Command >  command )

inline

Pushes a pre-constructed command to the buffer.

Parameters

command

Unique pointer to command

Definition at line 54 of file command_buffer.hpp.

                                                          {
  HELIOS_ASSERT(command != nullptr, "Failed to push command to command buffer: command is nullptr!");
  local_storage_.AddCommand(std::move(command));
}