types Namespace

Definition

namespace helios::ecs::types { ... }

Classes Index

struct	ComponentOps
	Container for type-erased component lifecycle function pointers. More...
class	ComponentTypeId<THandle>
	Unique type identifier for component types, scoped per domain. More...
struct	EntityHandle<TStrongId>
	A versioned handle for referencing entities in a registry. More...

Typedefs Index

using	VersionId = uint32_t
	Version number for detecting stale entity references. More...
using	EntityId = uint32_t
	Unique identifier for an entity within an EntityPool. More...

Variables Index

constexpr auto	InvalidVersion = VersionId{0}
	Sentinel version indicating an invalid or uninitialized handle. More...
constexpr auto	InitialVersion = VersionId{1}
	The initial version assigned to newly created entities. More...
constexpr size_t	EntityTombstone = std::numeric_limits<size_t>::max()
	Sentinel value indicating an invalid or removed sparse index. More...

Typedefs

EntityId

using helios::ecs::types::EntityId = uint32_t

Unique identifier for an entity within an EntityPool.

Used as the index into the sparse array of an EntityPool. Combined with a VersionId in an EntityHandle, it enables safe entity references that detect stale handles after entity removal.

See Also

EntityHandle

See Also

VersionId

See Also

EntityPool

Definition at line 43 of file TypeDefs.ixx.

43 using EntityId = uint32_t;

VersionId

using helios::ecs::types::VersionId = uint32_t

Version number for detecting stale entity references.

Each entity slot in an EntityPool has an associated version that is incremented when the entity is removed. EntityHandles store both the EntityId and VersionId, allowing the pool to detect when a handle refers to a recycled slot.

A valid version starts at 1 (uninitialized handles have version 0).

See Also

EntityHandle

See Also

EntityId

See Also

EntityPool

Definition at line 30 of file TypeDefs.ixx.

30 using VersionId = uint32_t;

Variables

EntityTombstone

size_t helios::ecs::types::EntityTombstone = std::numeric_limits<size_t>::max()

constexpr

Sentinel value indicating an invalid or removed sparse index.

Used in sparse-set data structures (e.g., EntityPool, GameObjectPool) to mark slots that do not contain valid entity references. When a slot contains this value, the corresponding entity has been removed or was never assigned.

See Also

EntityPool

See Also

GameObjectPool

Definition at line 56 of file TypeDefs.ixx.

56 constexpr size_t EntityTombstone = std::numeric_limits<size_t>::max();

InitialVersion

auto helios::ecs::types::InitialVersion = VersionId{1}

constexpr

The initial version assigned to newly created entities.

Versions start at 1 to distinguish valid handles from default-initialized handles that may have a version of 0.

Definition at line 30 of file EntityHandle.ixx.

30 constexpr auto InitialVersion = VersionId{1};

InvalidVersion

auto helios::ecs::types::InvalidVersion = VersionId{0}

constexpr

Sentinel version indicating an invalid or uninitialized handle.

Definition at line 22 of file EntityHandle.ixx.

22 constexpr auto InvalidVersion = VersionId{0};

Referenced by helios::ecs::EntityRegistry< TStrongId, TLookupStrategy, TAllowRemoval, TCapacity >::version.

---

The documentation for this namespace was generated from the following files:

• EntityHandle.ixx
• TypeDefs.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.