Namespaces
namespace	details

Classes
class	AccessPolicy

class	App
	Application class. More...

struct	CleanUp
	CleanUp schedule - main cleanup. More...

struct	CleanUpStage
	CleanUpStage - cleanup/shutdown phase. More...

struct	DefaultRunnerConfig
	Configuration for the default runner. More...

class	DynamicModule

struct	DynamicModuleConfig
	Configuration for dynamic module loading. More...

struct	First
	First schedule - runs first in the UpdateStage. More...

struct	FixedTimestepRunnerConfig
	Configuration for the fixed timestep runner. More...

class	FrameAllocatorResource

struct	FrameLimitedRunnerConfig
	Configuration for the frame-limited runner. More...

class	FreeListAllocatorResource

struct	Last
	Last schedule - runs last in the UpdateStage. More...

struct	Main
	Main schedule - main thread execution. More...

struct	MainStage
	MainStage - main thread execution phase. More...

class	Module
	Base class for all modules. More...

struct	OnceRunnerConfig
	Configuration for the once runner. More...

class	PoolAllocatorResource

struct	PostCleanUp
	PostCleanUp schedule - runs after cleanup/shutdown. More...

struct	PostStartup
	PostStartup schedule - runs after startup initialization. More...

struct	PostUpdate
	PostUpdate schedule - runs after the main update. More...

struct	PreCleanUp
	PreCleanUp schedule - runs before cleanup/shutdown. More...

struct	PreStartup
	PreStartup schedule - runs before startup initialization. More...

struct	PreUpdate
	PreUpdate schedule - runs before the main update. More...

class	StackAllocatorResource

struct	Startup
	Startup schedule - main initialization. More...

struct	StartUpStage
	StartUpStage - application initialization phase. More...

class	SubApp
	A sub-application with its own ECS world, systems, and resources. More...

class	SystemConfig

class	SystemContext
	Per-system execution context with validated access. More...

class	SystemSetConfig

class	Time

struct	TimedRunnerConfig
	Configuration for the timed runner. More...

struct	Update
	Update schedule - main update logic. More...

struct	UpdateStage
	UpdateStage - main update logic phase. More...

Concepts
concept	ModuleTrait
	Concept to ensure a type is a valid Module.

concept	ModuleWithNameTrait
	Concept to check if a Module provides a GetName() method.

concept	ScheduleTrait

concept	ScheduleWithNameTrait

concept	ScheduleWithBeforeTrait
	Concept for schedules that provide Before() ordering constraints.

concept	ScheduleWithAfterTrait
	Concept for schedules that provide After() ordering constraints.

concept	ScheduleWithStageTrait
	Concept for schedules that declare stage membership.

concept	StageTrait
	Concept for schedules that represent stages.

concept	SubAppTrait
	Trait to identify valid sub-app types.

concept	SubAppWithNameTrait
	Trait to identify sub-apps with custom names.

concept	SubAppWithAsyncTrait

concept	SubAppWithMaxOverlappingUpdatesTrait

concept	SystemSetTrait
	Trait to identify valid system set types.

concept	SystemSetWithNameTrait
	Trait to identify system sets with custom names.

Typedefs
using	CreateModuleFn = Module ()()
	Function signature for module creation.

using	ModuleIdFn = ModuleTypeId(*)()
	Function signature for getting module type ID.

using	ModuleNameFn = const char ()()
	Function signature for getting module name.

using	ModuleTypeId = size_t

using	ScheduleId = size_t
	Type alias for schedule type IDs.

using	SubAppTypeId = size_t
	Type alias for sub-app type IDs.

using	SystemSetId = size_t
	Type alias for system set type IDs.

Enumerations
enum class	AppExitCode : uint8_t { Success = 0 , Failure = 1 }
	Application exit codes. More...

enum class	DynamicModuleError : uint8_t { LibraryLoadFailed , CreateSymbolNotFound , IdSymbolNotFound , NameSymbolNotFound , CreateFailed , NotLoaded , ReloadFailed , FileNotChanged }
	Error codes for dynamic module operations. More...

Functions
constexpr std::string_view	DynamicModuleErrorToString (DynamicModuleError error) noexcept
	Gets a human-readable description for a DynamicModuleError.

template<typename T >
constexpr ModuleTypeId	ModuleTypeIdOf () noexcept

template<ModuleTrait T>
constexpr std::string_view	ModuleNameOf () noexcept
	Gets the name of a module.

auto	CheckShutdownEvent (App &app) noexcept -> std::pair< bool, ecs::ShutdownExitCode >
	Checks if a shutdown event has been received.

constexpr AppExitCode	ToAppExitCode (ecs::ShutdownExitCode code) noexcept
	Converts shutdown exit code to app exit code.

AppExitCode	DefaultRunner (App &app, DefaultRunnerConfig config={})

AppExitCode	FrameLimitedRunner (App &app, FrameLimitedRunnerConfig config)

AppExitCode	TimedRunner (App &app, TimedRunnerConfig config)

AppExitCode	FixedTimestepRunner (App &app, FixedTimestepRunnerConfig config)

AppExitCode	OnceRunner (App &app, OnceRunnerConfig config={})

template<ScheduleTrait T>
constexpr ScheduleId	ScheduleIdOf () noexcept

template<ScheduleTrait T>
constexpr std::string_view	ScheduleNameOf () noexcept

template<ScheduleTrait T>
constexpr auto	ScheduleBeforeOf () noexcept
	Gets the Before() ordering constraints for a schedule.

template<ScheduleTrait T>
constexpr auto	ScheduleAfterOf () noexcept
	Gets the After() ordering constraints for a schedule.

template<ScheduleTrait T>
constexpr bool	IsStage () noexcept
	Checks if a schedule type is a stage.

template<ScheduleTrait T>
constexpr ScheduleId	ScheduleStageOf () noexcept
	Gets the stage ID that a schedule belongs to.

template<SubAppTrait T>
constexpr bool	SubAppAllowsOverlappingUpdates () noexcept
	Gets whether a sub-app allows overlapping updates.

template<SubAppTrait T>
constexpr size_t	SubAppMaxOverlappingUpdates () noexcept
	Gets the maximum number of overlapping updates for a sub-app.

template<SubAppTrait T>
constexpr SubAppTypeId	SubAppTypeIdOf () noexcept
	Type alias for module type IDs.

template<SubAppTrait T>
constexpr std::string_view	SubAppNameOf () noexcept
	Gets the name of a sub-app type.

template<SystemSetTrait T>
constexpr SystemSetId	SystemSetIdOf () noexcept
	Gets unique type ID for a system set type.

template<SystemSetTrait T>
constexpr std::string_view	SystemSetNameOf () noexcept
	Gets the name of a system set type.

Variables
constexpr std::string_view	kDefaultCreateSymbol = "helios_create_module"
	Default symbol name for the module creation function.

constexpr std::string_view	kDefaultModuleIdSymbol = "helios_module_id"
	Default symbol name for the module ID function.

constexpr std::string_view	kDefaultModuleNameSymbol = "helios_module_name"
	Default symbol name for the module name function.

constexpr Main	kMain {}

constexpr PreStartup	kPreStartup {}

constexpr Startup	kStartup {}

constexpr PostStartup	kPostStartup {}

constexpr First	kFirst {}

constexpr PreUpdate	kPreUpdate {}

constexpr Update	kUpdate {}

constexpr PostUpdate	kPostUpdate {}

constexpr Last	kLast {}

constexpr PreCleanUp	kPreCleanUp {}

constexpr CleanUp	kCleanUp {}

constexpr PostCleanUp	kPostCleanUp {}

Typedef Documentation

◆ CreateModuleFn

using helios::app::CreateModuleFn = typedef Module* (*)()

Function signature for module creation.

Dynamic modules must export a function with this signature. The function should create and return a new Module instance.

Definition at line 27 of file dynamic_module.hpp.

◆ ModuleIdFn

using helios::app::ModuleIdFn = typedef ModuleTypeId (*)()

Function signature for getting module type ID.

Dynamic modules must export a function with this signature. The function should return the unique type ID of the module.

Definition at line 34 of file dynamic_module.hpp.

◆ ModuleNameFn

using helios::app::ModuleNameFn = typedef const char* (*)()

Function signature for getting module name.

Dynamic modules must export a function with this signature. The function should return the name of the module as a null-terminated string.

Definition at line 41 of file dynamic_module.hpp.

◆ ModuleTypeId

using helios::app::ModuleTypeId = typedef size_t

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

Definition at line 84 of file module.hpp.

◆ ScheduleId

using helios::app::ScheduleId = typedef size_t

Type alias for schedule type IDs.

Used to uniquely identify schedule types at runtime.

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

Definition at line 20 of file schedule.hpp.

◆ SubAppTypeId

using helios::app::SubAppTypeId = typedef size_t

Type alias for sub-app type IDs.

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

Definition at line 128 of file sub_app.hpp.

◆ SystemSetId

using helios::app::SystemSetId = typedef size_t

Type alias for system set type IDs.

Used to uniquely identify system set types at runtime.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/system_set_config.hpp.

Definition at line 19 of file system_set.hpp.

Enumeration Type Documentation

◆ AppExitCode

enum class helios::app::AppExitCode : uint8_t

strong

Application exit codes.

Enumerator
Success	Successful execution.
Failure	General failure.

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

Definition at line 87 of file app.hpp.

                       : uint8_t {
  Success = 0,  ///< Successful execution
  Failure = 1,  ///< General failure
};

◆ DynamicModuleError

enum class helios::app::DynamicModuleError : uint8_t

strong

Error codes for dynamic module operations.

Enumerator
LibraryLoadFailed	Failed to load the dynamic library.
CreateSymbolNotFound	Module creation function not found.
IdSymbolNotFound	Module ID function not found.
NameSymbolNotFound	Module name function not found.
CreateFailed	Module creation function returned nullptr.
NotLoaded	Module is not loaded.
ReloadFailed	Failed to reload module.
FileNotChanged	File has not been modified.

Definition at line 61 of file dynamic_module.hpp.

                              : uint8_t {
  LibraryLoadFailed,     ///< Failed to load the dynamic library
  CreateSymbolNotFound,  ///< Module creation function not found
  IdSymbolNotFound,      ///< Module ID function not found
  NameSymbolNotFound,    ///< Module name function not found
  CreateFailed,          ///< Module creation function returned nullptr
  NotLoaded,             ///< Module is not loaded
  ReloadFailed,          ///< Failed to reload module
  FileNotChanged,        ///< File has not been modified
};

Function Documentation

◆ CheckShutdownEvent()

auto helios::app::CheckShutdownEvent ( App & app ) -> std::pair<bool, ecs::ShutdownExitCode>

inlinenoexcept

Checks if a shutdown event has been received.

Parameters

app	Application to check

Returns: Pair of (should_shutdown, exit_code)

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/runners.hpp.

Definition at line 24 of file runners.hpp.

                                                                                                      {
  const auto& world = app.GetMainWorld();
 
  if (!world.HasEvent<ecs::ShutdownEvent>()) {
    return {false, ecs::ShutdownExitCode::Success};
  }
 
  const auto reader = world.ReadEvents<ecs::ShutdownEvent>();
  if (reader.Empty()) {
    return {false, ecs::ShutdownExitCode::Success};
  }
 
  // Return the first shutdown event's exit code
  const auto events = reader.Read();
  return {true, events.front().exit_code};
}

◆ DefaultRunner()

AppExitCode helios::app::DefaultRunner	(	App &	app,
		DefaultRunnerConfig	config = `{}`
	)

inline

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/runners.hpp.

Definition at line 80 of file runners.hpp.

                                                                        {}) {
  try {
    while (app.IsRunning()) {
      if (config.update_time_resource) [[likely]] {
        app.TickTime();
      }
 
      app.Update();
 
      // Check for shutdown event
      const auto [should_shutdown, exit_code] = CheckShutdownEvent(app);
      if (should_shutdown) [[unlikely]] {
        return ToAppExitCode(exit_code);
      }
    }
  } catch (const std::exception& exception) {
    HELIOS_CRITICAL("Application encountered an unhandled exception and will exit: {}!", exception.what());
    return AppExitCode::Failure;
  }
 
  return AppExitCode::Success;
}

◆ DynamicModuleErrorToString()

constexpr std::string_view helios::app::DynamicModuleErrorToString ( DynamicModuleError error )

constexprnoexcept

Gets a human-readable description for a DynamicModuleError.

Parameters

error The error code

Returns: String description of the error

Definition at line 77 of file dynamic_module.hpp.

                                                                                                     {
  switch (error) {
    case DynamicModuleError::LibraryLoadFailed:
      return "Failed to load dynamic library";
    case DynamicModuleError::CreateSymbolNotFound:
      return "Module creation function not found";
    case DynamicModuleError::IdSymbolNotFound:
      return "Module ID function not found";
    case DynamicModuleError::NameSymbolNotFound:
      return "Module name function not found";
    case DynamicModuleError::CreateFailed:
      return "Module creation function returned nullptr";
    case DynamicModuleError::NotLoaded:
      return "Module is not loaded";
    case DynamicModuleError::ReloadFailed:
      return "Failed to reload module";
    case DynamicModuleError::FileNotChanged:
      return "File has not been modified";
    default:
      return "Unknown error";
  }
}

◆ FixedTimestepRunner()

AppExitCode helios::app::FixedTimestepRunner	(	App &	app,
		FixedTimestepRunnerConfig	config
	)

inline

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/runners.hpp.

Definition at line 244 of file runners.hpp.

                                                                                   {
  try {
    using Duration = std::chrono::duration<float>;
 
    const Duration fixed_delta{config.fixed_delta_seconds};
    Duration accumulator{0.0F};
 
    Timer frame_timer;
    while (app.IsRunning()) {
      // Calculate frame time using Timer
      const auto frame_time = frame_timer.ElapsedDuration<Duration>();
      frame_timer.Reset();
 
      accumulator += frame_time;
 
      // Limit the number of substeps to prevent spiral of death
      uint32_t substeps = 0;
      while (accumulator >= fixed_delta && substeps < config.max_substeps) {
        if (config.update_time_resource) [[likely]] {
          app.TickTime();
        }
 
        app.Update();
        accumulator -= fixed_delta;
        ++substeps;
 
        // Check for shutdown event
        const auto [should_shutdown, exit_code] = CheckShutdownEvent(app);
        if (should_shutdown) [[unlikely]] {
          return ToAppExitCode(exit_code);
        }
      }
 
      // If we hit max substeps, clamp accumulator to prevent runaway
      if (substeps >= config.max_substeps && accumulator >= fixed_delta) {
        HELIOS_WARN("Fixed timestep runner hit max substeps ({}), clamping accumulator", config.max_substeps);
        accumulator = Duration{0.0F};
      }
    }
  } catch (const std::exception& exception) {
    HELIOS_CRITICAL("Application encountered an unhandled exception and will exit: {}!", exception.what());
    return AppExitCode::Failure;
  }
 
  return AppExitCode::Success;
}

◆ FrameLimitedRunner()

AppExitCode helios::app::FrameLimitedRunner	(	App &	app,
		FrameLimitedRunnerConfig	config
	)

inline

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/runners.hpp.

Definition at line 131 of file runners.hpp.

                                                                                 {
  try {
    uint64_t frame = 0;
    while (app.IsRunning() && frame < config.max_frames) {
      if (config.update_time_resource) [[likely]] {
        app.TickTime();
      }
 
      app.Update();
      ++frame;
 
      // Check for shutdown event
      const auto [should_shutdown, exit_code] = CheckShutdownEvent(app);
      if (should_shutdown) [[unlikely]] {
        return ToAppExitCode(exit_code);
      }
    }
  } catch (const std::exception& exception) {
    HELIOS_CRITICAL("Application encountered an unhandled exception and will exit: {}!", exception.what());
    return AppExitCode::Failure;
  }
 
  return AppExitCode::Success;
}

◆ IsStage()

template<ScheduleTrait T>

constexpr bool helios::app::IsStage ( )

constexprnoexcept

Checks if a schedule type is a stage.

Template Parameters

T	Schedule type

Returns: True if the schedule is a stage, false otherwise

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedule.hpp.

Definition at line 185 of file schedule.hpp.

                                  {
  if constexpr (StageTrait<T>) {
    return T::IsStage();
  } else {
    return false;
  }
}

◆ ModuleNameOf()

template<ModuleTrait T>

constexpr std::string_view helios::app::ModuleNameOf ( )

constexprnoexcept

Gets the name of a module.

Returns provided name or type name as fallback.

Template Parameters

T	Module type

Returns: Module name

Definition at line 98 of file module.hpp.

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

◆ ModuleTypeIdOf()

template<typename T >

constexpr ModuleTypeId helios::app::ModuleTypeIdOf ( )

constexprnoexcept

Definition at line 87 of file module.hpp.

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

◆ OnceRunner()

AppExitCode helios::app::OnceRunner	(	App &	app,
		OnceRunnerConfig	config = `{}`
	)

inline

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/runners.hpp.

Definition at line 315 of file runners.hpp.

                                                                  {}) {
  try {
    if (app.IsRunning()) {
      if (config.update_time_resource) [[likely]] {
        app.TickTime();
      }
 
      app.Update();
    }
  } catch (const std::exception& exception) {
    HELIOS_CRITICAL("Application encountered an unhandled exception and will exit: {}!", exception.what());
    return AppExitCode::Failure;
  }
 
  return AppExitCode::Success;
}

◆ ScheduleAfterOf()

template<ScheduleTrait T>

constexpr auto helios::app::ScheduleAfterOf ( )

constexprnoexcept

Gets the After() ordering constraints for a schedule.

Returns schedules that must run after this schedule. If the schedule doesn't provide After(), returns empty array.

Template Parameters

T	Schedule type

Returns: Array of schedule IDs that must run after T

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedule.hpp.

Definition at line 142 of file schedule.hpp.

                                          {
  if constexpr (ScheduleWithAfterTrait<T>) {
    return T::After();
  } else {
    return std::array<ScheduleId, 0>{};
  }
}

◆ ScheduleBeforeOf()

template<ScheduleTrait T>

constexpr auto helios::app::ScheduleBeforeOf ( )

constexprnoexcept

Gets the Before() ordering constraints for a schedule.

Returns schedules that must run before this schedule. If the schedule doesn't provide Before(), returns empty array.

Template Parameters

T	Schedule type

Returns: Array of schedule IDs that must run before T

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedule.hpp.

Definition at line 126 of file schedule.hpp.

                                           {
  if constexpr (ScheduleWithBeforeTrait<T>) {
    return T::Before();
  } else {
    return std::array<ScheduleId, 0>{};
  }
}

◆ ScheduleIdOf()

template<ScheduleTrait T>

constexpr ScheduleId helios::app::ScheduleIdOf ( )

constexprnoexcept

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedule.hpp.

Definition at line 71 of file schedule.hpp.

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

◆ ScheduleNameOf()

template<ScheduleTrait T>

constexpr std::string_view helios::app::ScheduleNameOf ( )

constexprnoexcept

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedule.hpp.

Definition at line 90 of file schedule.hpp.

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

◆ ScheduleStageOf()

template<ScheduleTrait T>

constexpr ScheduleId helios::app::ScheduleStageOf ( )

constexprnoexcept

Gets the stage ID that a schedule belongs to.

If the schedule declares a stage via GetStage(), returns that stage ID. If the schedule is itself a stage, returns its own ID. Otherwise, returns 0 to indicate it's not associated with any stage.

Template Parameters

T	Schedule type

Returns: Stage ID that this schedule belongs to, or 0 if not in a stage

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedule.hpp.

Definition at line 203 of file schedule.hpp.

                                                {
  if constexpr (ScheduleWithStageTrait<T>) {
    return T::GetStage();
  } else if constexpr (IsStage<T>()) {
    return ScheduleIdOf<T>();
  } else {
    return 0;
  }
}

◆ SubAppAllowsOverlappingUpdates()

template<SubAppTrait T>

constexpr bool helios::app::SubAppAllowsOverlappingUpdates ( )

constexprnoexcept

Gets whether a sub-app allows overlapping updates.

Template Parameters

T	Sub-app type

Returns: True if overlapping updates are allowed, false otherwise

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/sub_app.hpp.

Definition at line 103 of file sub_app.hpp.

                                                         {
  if constexpr (SubAppWithAsyncTrait<T>) {
    return T::AllowOverlappingUpdates();
  } else {
    return false;  // Default: no overlapping updates
  }
}

◆ SubAppMaxOverlappingUpdates()

template<SubAppTrait T>

constexpr size_t helios::app::SubAppMaxOverlappingUpdates ( )

constexprnoexcept

Gets the maximum number of overlapping updates for a sub-app.

Template Parameters

T	Sub-app type

Returns: Maximum overlapping updates, or 0 if not specified

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/sub_app.hpp.

Definition at line 117 of file sub_app.hpp.

                                                        {
  if constexpr (SubAppWithMaxOverlappingUpdatesTrait<T>) {
    return T::GetMaxOverlappingUpdates();
  } else {
    return 0;  // Default: no limit
  }
}

◆ SubAppNameOf()

template<SubAppTrait T>

constexpr std::string_view helios::app::SubAppNameOf ( )

constexprnoexcept

Gets the name of a sub-app type.

Template Parameters

T	Sub-app type

Returns: Name of the sub-app

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/sub_app.hpp.

Definition at line 146 of file sub_app.hpp.

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

◆ SubAppTypeIdOf()

template<SubAppTrait T>

constexpr SubAppTypeId helios::app::SubAppTypeIdOf ( )

constexprnoexcept

Type alias for module type IDs.

Template Parameters

T	Module type

Returns: Unique type ID for the module

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/sub_app.hpp.

Definition at line 136 of file sub_app.hpp.

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

◆ SystemSetIdOf()

template<SystemSetTrait T>

constexpr SystemSetId helios::app::SystemSetIdOf ( )

constexprnoexcept

Gets unique type ID for a system set type.

Uses CTTI to generate a unique hash for the system set type. The ID is consistent across compilation units.

Template Parameters

T	System set type

Returns: Unique type ID for the system set

Definition at line 49 of file system_set.hpp.

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

◆ SystemSetNameOf()

template<SystemSetTrait T>

constexpr std::string_view helios::app::SystemSetNameOf ( )

constexprnoexcept

Gets the name of a system set type.

Returns the custom name if GetName() is provided, otherwise returns the CTTI-generated type name.

Template Parameters

T	System set type

Returns: Name of the system set

Definition at line 61 of file system_set.hpp.

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

◆ TimedRunner()

AppExitCode helios::app::TimedRunner	(	App &	app,
		TimedRunnerConfig	config
	)

inline

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/runners.hpp.

Definition at line 184 of file runners.hpp.

                                                                   {
  try {
    const auto duration_seconds = static_cast<double>(config.duration_seconds);
 
    Timer timer;
    while (app.IsRunning()) {
      if (timer.ElapsedSec() >= duration_seconds) {
        break;
      }
 
      if (config.update_time_resource) [[likely]] {
        app.TickTime();
      }
 
      app.Update();
 
      // Check for shutdown event
      const auto [should_shutdown, exit_code] = CheckShutdownEvent(app);
      if (should_shutdown) [[unlikely]] {
        return ToAppExitCode(exit_code);
      }
    }
  } catch (const std::exception& exception) {
    HELIOS_CRITICAL("Application encountered an unhandled exception and will exit: {}!", exception.what());
    return AppExitCode::Failure;
  }
 
  return AppExitCode::Success;
}

◆ ToAppExitCode()

constexpr AppExitCode helios::app::ToAppExitCode ( ecs::ShutdownExitCode code )

constexprnoexcept

Converts shutdown exit code to app exit code.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/runners.hpp.

Definition at line 44 of file runners.hpp.

                                                                                     {
  switch (code) {
    case ecs::ShutdownExitCode::Success:
      return AppExitCode::Success;
    default:
      return AppExitCode::Failure;
  }
}

Variable Documentation

◆ kCleanUp

constexpr CleanUp helios::app::kCleanUp {}

inlineconstexpr

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedules.hpp.

Definition at line 306 of file schedules.hpp.

306{};

◆ kDefaultCreateSymbol

constexpr std::string_view helios::app::kDefaultCreateSymbol = "helios_create_module"

inlineconstexpr

Default symbol name for the module creation function.

Definition at line 46 of file dynamic_module.hpp.

◆ kDefaultModuleIdSymbol

constexpr std::string_view helios::app::kDefaultModuleIdSymbol = "helios_module_id"

inlineconstexpr

Default symbol name for the module ID function.

Definition at line 51 of file dynamic_module.hpp.

◆ kDefaultModuleNameSymbol

constexpr std::string_view helios::app::kDefaultModuleNameSymbol = "helios_module_name"

inlineconstexpr

Default symbol name for the module name function.

Definition at line 56 of file dynamic_module.hpp.

◆ kFirst

constexpr First helios::app::kFirst {}

inlineconstexpr

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedules.hpp.

Definition at line 299 of file schedules.hpp.

299{};

◆ kLast

constexpr Last helios::app::kLast {}

inlineconstexpr

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedules.hpp.

Definition at line 303 of file schedules.hpp.

303{};

◆ kMain

constexpr Main helios::app::kMain {}

inlineconstexpr

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedules.hpp.

Definition at line 293 of file schedules.hpp.

293{};

◆ kPostCleanUp

constexpr PostCleanUp helios::app::kPostCleanUp {}

inlineconstexpr

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedules.hpp.

Definition at line 307 of file schedules.hpp.

307{};

◆ kPostStartup

constexpr PostStartup helios::app::kPostStartup {}

inlineconstexpr

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedules.hpp.

Definition at line 297 of file schedules.hpp.

297{};

◆ kPostUpdate

constexpr PostUpdate helios::app::kPostUpdate {}

inlineconstexpr

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedules.hpp.

Definition at line 302 of file schedules.hpp.

302{};

◆ kPreCleanUp

constexpr PreCleanUp helios::app::kPreCleanUp {}

inlineconstexpr

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedules.hpp.

Definition at line 305 of file schedules.hpp.

305{};

◆ kPreStartup

constexpr PreStartup helios::app::kPreStartup {}

inlineconstexpr

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedules.hpp.

Definition at line 295 of file schedules.hpp.

295{};

◆ kPreUpdate

constexpr PreUpdate helios::app::kPreUpdate {}

inlineconstexpr

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedules.hpp.

Definition at line 300 of file schedules.hpp.

300{};

◆ kStartup

constexpr Startup helios::app::kStartup {}

inlineconstexpr

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedules.hpp.

Definition at line 296 of file schedules.hpp.

296{};

◆ kUpdate

constexpr Update helios::app::kUpdate {}

inlineconstexpr

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/app/schedules.hpp.

Definition at line 301 of file schedules.hpp.

301{};

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

Namespaces

Classes

Concepts

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ CreateModuleFn

◆ ModuleIdFn

◆ ModuleNameFn

◆ ModuleTypeId

◆ ScheduleId

◆ SubAppTypeId

◆ SystemSetId

Enumeration Type Documentation

◆ AppExitCode

◆ DynamicModuleError

Function Documentation

◆ CheckShutdownEvent()

◆ DefaultRunner()

◆ DynamicModuleErrorToString()

◆ FixedTimestepRunner()

◆ FrameLimitedRunner()

◆ IsStage()

◆ ModuleNameOf()

◆ ModuleTypeIdOf()

◆ OnceRunner()

◆ ScheduleAfterOf()

◆ ScheduleBeforeOf()

◆ ScheduleIdOf()

◆ ScheduleNameOf()

◆ ScheduleStageOf()

◆ SubAppAllowsOverlappingUpdates()

◆ SubAppMaxOverlappingUpdates()

◆ SubAppNameOf()

◆ SubAppTypeIdOf()

◆ SystemSetIdOf()

◆ SystemSetNameOf()

◆ TimedRunner()

◆ ToAppExitCode()

Variable Documentation

◆ kCleanUp

◆ kDefaultCreateSymbol

◆ kDefaultModuleIdSymbol

◆ kDefaultModuleNameSymbol

◆ kFirst

◆ kLast

◆ kMain

◆ kPostCleanUp

◆ kPostStartup

◆ kPostUpdate

◆ kPreCleanUp

◆ kPreStartup

◆ kPreUpdate

◆ kStartup

◆ kUpdate