GameObjectPoolSnapshot.ixx File

Read-only snapshot of GameObjectPool state. More...

Namespaces Index

namespace	helios
namespace	engine
	Main engine module aggregating core infrastructure and game systems. More...
namespace	runtime
	Runtime infrastructure for game execution and lifecycle orchestration. More...
namespace	pooling
	GameObject pooling for efficient object recycling. More...

Classes Index

struct	GameObjectPoolSnapshot
	Immutable snapshot of a GameObjectPool's current state. More...

Description

Read-only snapshot of GameObjectPool state.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file GameObjectPoolSnapshot.ixx

3 * @brief Read-only snapshot of GameObjectPool state.

4 */

5module;

6

7export module helios.engine.runtime.pooling.GameObjectPoolSnapshot;

8

9export namespace helios::engine::runtime::pooling {

10

11 /**

12 * @brief Immutable snapshot of a GameObjectPool's current state.

13 *

14 * @details GameObjectPoolSnapshot provides a point-in-time view of a pool's

15 * active and inactive entity counts. This is useful for monitoring pool

16 * utilization, debugging spawn issues, and making spawn decisions based

17 * on available capacity.

18 *

19 * The snapshot is read-only and captures the state at creation time;

20 * subsequent pool operations do not affect it.

21 *

22 * Example usage:

23 * ```cpp

24 * auto snapshot = poolManager.poolSnapshot(bulletPoolId);

25 * if (snapshot.inactiveCount > 0) {

26 * // Pool has available capacity for spawning

27 * }

28 * ```

29 *

30 * @see GameObjectPool

31 * @see GameObjectPoolManager::poolSnapshot

32 */

33 struct GameObjectPoolSnapshot {

34

35 /**

36 * @brief Number of currently active (in-use) entities in the pool.

37 */

38 const size_t activeCount;

39

40 /**

41 * @brief Number of currently inactive (available) entities in the pool.

42 */

43 const size_t inactiveCount;

44

45 };

46

47}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.