Namespaces
namespace	details

Classes
class	BasicQuery

class	BasicQueryBuilder

class	BasicQueryWithEntity
	Wrapper for queries that include entity in iteration. More...

class	Command
	Base class for all commands to be executed in the world. More...

struct	ComponentTraits
	Component traits for optimization decisions. More...

class	ComponentTypeInfo
	Component type info for runtime operations. More...

class	Entity
	Unique identifier for entities with generation counter to handle recycling. More...

class	EntityCmdBuffer

struct	EntityDestroyedEvent
	Event emitted when an entity is destroyed. More...

struct	EntitySpawnedEvent
	Event emitted when an entity is spawned/created. More...

class	EventIterator
	Iterator wrapper for EventReader. More...

class	EventReader

class	EventSimpleIterator
	Simple iterator for EventReader that returns plain events. More...

class	EventWriter
	Type-safe writer for events. More...

struct	IsConstComponent
	Helper to detect const components. More...

struct	IsConstComponent< const T >

struct	ShutdownEvent

class	System

class	World
	The World class manages entities with their components and systems. More...

class	WorldCmdBuffer

Concepts
concept	CommandTrait

concept	ConstComponentTrait
	Concept for const-qualified component types.

concept	ComponentTrait
	Concept to check if a type can be used as a component.

concept	ComponentWithNameTrait
	Concept for components that provide a static name method.

concept	TagComponentTrait
	Concept for tag components (empty).

concept	TrivialComponentTrait
	Concept for trivially copyable components (POD-like).

concept	TinyComponentTrait
	Concept for tiny components (single cache line portion), where sizeof(T) <= 16.

concept	SmallComponentTrait
	Concept for small components that fit in cache line, where sizeof(T) <= 64.

concept	MediumComponentTrait
	Concept for medium components (multiple cache line portions), where 64 < sizeof(T) <= 256.

concept	LargeComponentTrait
	Concept for large components that don't fit in cache line, where sizeof(T) > 256.

concept	EventTrait
	Concept for valid event types.

concept	EventWithNameTrait
	Concept for events with custom names.

concept	EventWithClearPolicy
	Concept for events with custom clear policy.

concept	ResourceTrait
	Concept for valid resource types.

concept	ResourceWithNameTrait
	Concept for resources that provide custom names.

concept	ResourceWithThreadSafetyTrait
	Concept for resources that provide thread-safety trait.

concept	AtomicResourceTrait
	Concept for atomic resources that can be accessed concurrently.

concept	SystemTrait
	Concept for valid system types.

concept	SystemWithNameTrait
	Concept for systems with custom names.

concept	WorldType
	Concept that constrains a type to be the World type (with any cv-qualifiers).

Typedefs
using	ComponentTypeId = size_t
	Type ID for components.

using	EventTypeId = size_t
	Type ID for events.

template<typename Allocator = std::allocator<ComponentTypeId>>
using	QueryBuilder = BasicQueryBuilder< World, Allocator >
	Type alias for query builder with mutable world access.

template<typename Allocator = std::allocator<ComponentTypeId>>
using	ReadOnlyQueryBuilder = BasicQueryBuilder< const World, Allocator >
	Type alias for query builder with read-only world access.

template<typename Allocator , ComponentTrait... Components>
using	Query = BasicQuery< World, Allocator, Components... >
	Type alias for query with mutable world access.

template<typename Allocator , ComponentTrait... Components>
using	ReadOnlyQuery = BasicQuery< const World, Allocator, Components... >
	Type alias for query with read-only world access.

template<typename Allocator , ComponentTrait... Components>
using	QueryWithEntity = BasicQueryWithEntity< World, Allocator, Components... >
	Type alias for query with entity with mutable world access.

template<typename Allocator , ComponentTrait... Components>
using	ReadOnlyQueryWithEntity = BasicQueryWithEntity< const World, Allocator, Components... >
	Type alias for query with entity with read-only world access.

using	ResourceTypeId = size_t
	Type ID for resources.

using	SystemTypeId = size_t
	Type ID for systems.

Enumerations
enum class	EventClearPolicy : uint8_t { kAutomatic , kManual }
	Policy for event clearing behavior. More...

enum class	ShutdownExitCode : uint8_t { Success = 0 , Failure = 1 }
	Exit code for application shutdown. More...

Functions
template<ComponentTrait T>
constexpr ComponentTypeId	ComponentTypeIdOf () noexcept
	Type ID for components using CTTI.

template<ComponentTrait T>
constexpr std::string_view	ComponentNameOf () noexcept

template<EventTrait T>
constexpr EventTypeId	EventTypeIdOf () noexcept
	Gets type ID for an event type.

template<EventTrait T>
constexpr std::string_view	EventNameOf () noexcept
	Gets the name of an event.

template<EventTrait T>
constexpr EventClearPolicy	EventClearPolicyOf () noexcept
	Gets the clear policy of an event.

template<WorldType WorldT>
	BasicQueryBuilder (WorldT &) -> BasicQueryBuilder< WorldT, std::allocator< ComponentTypeId > >

template<WorldType WorldT>
	BasicQueryBuilder (WorldT &, const app::AccessPolicy &) -> BasicQueryBuilder< WorldT, std::allocator< ComponentTypeId > >

template<WorldType WorldT, typename Allocator >
	BasicQueryBuilder (WorldT &, Allocator) -> BasicQueryBuilder< WorldT, Allocator >

template<WorldType WorldT, typename Allocator >
	BasicQueryBuilder (WorldT &, const app::AccessPolicy &, Allocator) -> BasicQueryBuilder< WorldT, Allocator >

template<ResourceTrait T>
constexpr ResourceTypeId	ResourceTypeIdOf () noexcept
	Gets type ID for a resource type.

template<ResourceTrait T>
constexpr std::string_view	ResourceNameOf () noexcept
	Gets name for a resource type.

template<ResourceTrait T>
constexpr bool	IsResourceThreadSafe () noexcept
	Checks if a resource type is thread-safe.

template<typename T >
constexpr SystemTypeId	SystemTypeIdOf () noexcept
	Gets type ID for a system type.

template<SystemTrait T>
constexpr std::string_view	SystemNameOf () noexcept
	Gets the name of a system.

Variables
template<typename T >
constexpr bool	IsConstComponent_v = IsConstComponent<T>::value

Typedef Documentation

◆ ComponentTypeId

using helios::ecs::ComponentTypeId = typedef size_t

Type ID for components.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/access_policy.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/query.hpp.

Definition at line 104 of file component.hpp.

◆ EventTypeId

using helios::ecs::EventTypeId = typedef size_t

Type ID for events.

Definition at line 18 of file event.hpp.

◆ Query

template<typename Allocator , ComponentTrait... Components>

using helios::ecs::Query = typedef BasicQuery<World, Allocator, Components...>

Type alias for query with mutable world access.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/access_policy.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/app.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/sub_app.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/system_config.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/system_context.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/time.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/details/entities_manager.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/entity_command_buffer.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/events/builtin_events.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/query.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/system.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/world_command_buffer.hpp.

Definition at line 2481 of file query.hpp.

◆ QueryBuilder

template<typename Allocator = std::allocator<ComponentTypeId>>

using helios::ecs::QueryBuilder = typedef BasicQueryBuilder<World, Allocator>

Type alias for query builder with mutable world access.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/query.hpp.

Definition at line 2473 of file query.hpp.

◆ QueryWithEntity

template<typename Allocator , ComponentTrait... Components>

using helios::ecs::QueryWithEntity = typedef BasicQueryWithEntity<World, Allocator, Components...>

Type alias for query with entity with mutable world access.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/query.hpp.

Definition at line 2489 of file query.hpp.

◆ ReadOnlyQuery

template<typename Allocator , ComponentTrait... Components>

using helios::ecs::ReadOnlyQuery = typedef BasicQuery<const World, Allocator, Components...>

Type alias for query with read-only world access.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/query.hpp.

Definition at line 2485 of file query.hpp.

◆ ReadOnlyQueryBuilder

template<typename Allocator = std::allocator<ComponentTypeId>>

using helios::ecs::ReadOnlyQueryBuilder = typedef BasicQueryBuilder<const World, Allocator>

Type alias for query builder with read-only world access.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/query.hpp.

Definition at line 2477 of file query.hpp.

◆ ReadOnlyQueryWithEntity

template<typename Allocator , ComponentTrait... Components>

using helios::ecs::ReadOnlyQueryWithEntity = typedef BasicQueryWithEntity<const World, Allocator, Components...>

Type alias for query with entity with read-only world access.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/query.hpp.

Definition at line 2493 of file query.hpp.

◆ ResourceTypeId

using helios::ecs::ResourceTypeId = typedef size_t

Type ID for resources.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/access_policy.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/system_context.hpp.

Definition at line 53 of file resource.hpp.

◆ SystemTypeId

using helios::ecs::SystemTypeId = typedef size_t

Type ID for systems.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/system_config.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/system.hpp.

Definition at line 93 of file system.hpp.

Enumeration Type Documentation

◆ EventClearPolicy

enum class helios::ecs::EventClearPolicy : uint8_t

strong

Policy for event clearing behavior.

Enumerator
kAutomatic	Events are automatically cleared after double buffer cycle.
kManual	Events persist until manually cleared via ManualClear()

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/events/builtin_events.hpp.

Definition at line 23 of file event.hpp.

                            : uint8_t {
  kAutomatic,  ///< Events are automatically cleared after double buffer cycle
  kManual      ///< Events persist until manually cleared via ManualClear()
};

◆ ShutdownExitCode

enum class helios::ecs::ShutdownExitCode : uint8_t

strong

Exit code for application shutdown.

Enumerator
Success	Normal shutdown.
Failure	Shutdown due to error.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/runners.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/events/builtin_events.hpp.

Definition at line 60 of file builtin_events.hpp.

                            : uint8_t {
  Success = 0,  ///< Normal shutdown
  Failure = 1,  ///< Shutdown due to error
};

Function Documentation

◆ BasicQueryBuilder() [1/4]

template<WorldType WorldT>

helios::ecs::BasicQueryBuilder ( WorldT & ) -> BasicQueryBuilder< WorldT, std::allocator< ComponentTypeId > >

◆ BasicQueryBuilder() [2/4]

template<WorldType WorldT, typename Allocator >

helios::ecs::BasicQueryBuilder	(	WorldT &	,
		Allocator
	)		-> BasicQueryBuilder< WorldT, Allocator >

◆ BasicQueryBuilder() [3/4]

template<WorldType WorldT>

helios::ecs::BasicQueryBuilder	(	WorldT &	,
		const app::AccessPolicy &
	)		-> BasicQueryBuilder< WorldT, std::allocator< ComponentTypeId > >

◆ BasicQueryBuilder() [4/4]

template<WorldType WorldT, typename Allocator >

helios::ecs::BasicQueryBuilder	(	WorldT &	,
		const app::AccessPolicy &	,
		Allocator
	)		-> BasicQueryBuilder< WorldT, Allocator >

◆ ComponentNameOf()

template<ComponentTrait T>

constexpr std::string_view helios::ecs::ComponentNameOf ( )

constexprnoexcept

Definition at line 117 of file component.hpp.

                                                                  {
  if constexpr (ComponentWithNameTrait<T>) {
    return T::GetName();
  } else {
    return ctti::name_of<T>();
  }
}

◆ ComponentTypeIdOf()

template<ComponentTrait T>

constexpr ComponentTypeId helios::ecs::ComponentTypeIdOf ( )

constexprnoexcept

Type ID for components using CTTI.

Template Parameters

T	Component type

Returns: Unique type ID for the component

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/query.hpp.

Definition at line 112 of file component.hpp.

                                                       {
  return ctti::type_index_of<T>().hash();
}

◆ EventClearPolicyOf()

template<EventTrait T>

constexpr EventClearPolicy helios::ecs::EventClearPolicyOf ( )

constexprnoexcept

Gets the clear policy of an event.

Returns provided policy or kAutomatic as default.

Template Parameters

T	Event type

Returns: Event clear policy

Definition at line 98 of file event.hpp.

                                                                       {
  if constexpr (EventWithClearPolicy<T>) {
    return T::GetClearPolicy();
  } else {
    return EventClearPolicy::kAutomatic;
  }
}

◆ EventNameOf()

template<EventTrait T>

constexpr std::string_view helios::ecs::EventNameOf ( )

constexprnoexcept

Gets the name of an event.

Returns provided name or type name as fallback.

Template Parameters

T	Event type

Returns: Event name

Definition at line 83 of file event.hpp.

                                                              {
  if constexpr (EventWithNameTrait<T>) {
    return T::GetName();
  } else {
    return ctti::name_of<T>();
  }
}

◆ EventTypeIdOf()

template<EventTrait T>

constexpr EventTypeId helios::ecs::EventTypeIdOf ( )

constexprnoexcept

Gets type ID for an event type.

Template Parameters

T	Event type

Returns: Unique type ID for the event

Definition at line 72 of file event.hpp.

                                                             {
  return ctti::type_index_of<T>().hash();
}

◆ IsResourceThreadSafe()

template<ResourceTrait T>

constexpr bool helios::ecs::IsResourceThreadSafe ( )

constexprnoexcept

Checks if a resource type is thread-safe.

Template Parameters

T	Resource type

Returns: True if resource is thread-safe, false otherwise

Definition at line 85 of file resource.hpp.

                                                             {
  if constexpr (ResourceWithThreadSafetyTrait<T>) {
    return T::ThreadSafe();
  } else {
    return false;
  }
}

◆ ResourceNameOf()

template<ResourceTrait T>

constexpr std::string_view helios::ecs::ResourceNameOf ( )

constexprnoexcept

Gets name for a resource type.

Template Parameters

T	Resource type

Returns: Name of the resource

Definition at line 71 of file resource.hpp.

                                                                 {
  if constexpr (ResourceWithNameTrait<T>) {
    return T::GetName();
  } else {
    return ctti::name_of<T>();
  }
}

◆ ResourceTypeIdOf()

template<ResourceTrait T>

constexpr ResourceTypeId helios::ecs::ResourceTypeIdOf ( )

constexprnoexcept

Gets type ID for a resource type.

Template Parameters

T	Resource type

Returns: Unique type ID for the resource

Definition at line 61 of file resource.hpp.

                                                     {
  return ctti::type_index_of<T>().hash();
}

◆ SystemNameOf()

template<SystemTrait T>

constexpr std::string_view helios::ecs::SystemNameOf ( )

constexprnoexcept

Gets the name of a system.

Returns provided name or type name as fallback.

Template Parameters

T	System type

Returns: System name

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/system.hpp.

Definition at line 112 of file system.hpp.

                                                               {
  if constexpr (SystemWithNameTrait<T>) {
    return T::GetName();
  } else {
    return ctti::name_of<T>();
  }
}

◆ SystemTypeIdOf()

template<typename T >

constexpr SystemTypeId helios::ecs::SystemTypeIdOf ( )

constexprnoexcept

Gets type ID for a system type.

Template Parameters

T	System type

Returns: Unique type ID for the system

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/system.hpp.

Definition at line 101 of file system.hpp.

                                                 {
  return ctti::type_index_of<T>().hash();
}

Variable Documentation

◆ IsConstComponent_v

template<typename T >

constexpr bool helios::ecs::IsConstComponent_v = IsConstComponent<T>::value

inlineconstexpr

Definition at line 26 of file component.hpp.

	Helios Engine 0.1.0 A modular ECS based data-oriented C++23 game engine

Namespaces

Classes

Concepts

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ ComponentTypeId

◆ EventTypeId

◆ Query

◆ QueryBuilder

◆ QueryWithEntity

◆ ReadOnlyQuery

◆ ReadOnlyQueryBuilder

◆ ReadOnlyQueryWithEntity

◆ ResourceTypeId

◆ SystemTypeId

Enumeration Type Documentation

◆ EventClearPolicy

◆ ShutdownExitCode

Function Documentation

◆ BasicQueryBuilder() [1/4]

◆ BasicQueryBuilder() [2/4]

◆ BasicQueryBuilder() [3/4]

◆ BasicQueryBuilder() [4/4]

◆ ComponentNameOf()

◆ ComponentTypeIdOf()

◆ EventClearPolicyOf()

◆ EventNameOf()

◆ EventTypeIdOf()

◆ IsResourceThreadSafe()

◆ ResourceNameOf()

◆ ResourceTypeIdOf()

◆ SystemNameOf()

◆ SystemTypeIdOf()

Variable Documentation

◆ IsConstComponent_v