EntityTombstone.ixx File

Sentinel value for invalid sparse array indices. More...

Included Headers

#include <limits>

Namespaces Index

namespace	helios
namespace	engine
	Main engine module aggregating core infrastructure and game systems. More...
namespace	ecs
	Core Entity-Component-System architecture. More...
namespace	types

Description

Sentinel value for invalid sparse array indices.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file EntityTombstone.ixx

3 * @brief Sentinel value for invalid sparse array indices.

4 */

5module;

6

7

8#include <limits>

9

10

11export module helios.engine.ecs.types.EntityTombstone;

12

13

14export namespace helios::engine::ecs::types {

15

16 /**

17 * @brief Sentinel value indicating an invalid or removed sparse index.

18 *

19 * Used in sparse-set data structures (e.g., EntityPool, GameObjectPool) to mark

20 * slots that do not contain valid entity references. When a slot contains this

21 * value, the corresponding entity has been removed or was never assigned.

22 *

23 * @see EntityPool

24 * @see GameObjectPool

25 */

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

27

28

29}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.