nc::NcEngine Class Reference

Interface for the engine runtime and modules. More...

#include <NcEngine.h>

Public Member Functions
virtual void	Start (std::unique_ptr< Scene > initialScene)=0
	Start engine execution. More...
virtual void	Stop () noexcept=0
	Signal the engine to stop execution after all tasks have completed.
virtual void	Shutdown () noexcept=0
	Clear all engine state.
virtual auto	GetComponentRegistry () noexcept -> ecs::ComponentRegistry &=0
	Get a reference to the ComponentRegistry.
virtual auto	GetModuleRegistry () noexcept -> ModuleRegistry *=0
	Get a pointer to the module registry.
virtual auto	GetSystemEvents () noexcept -> SystemEvents &=0
	Get a reference to the collection of system events.
virtual auto	GetAsyncDispatcher () noexcept -> task::AsyncDispatcher=0
	Get an interface for running async tasks on the thread pool.
virtual void	RebuildTaskGraph ()=0
	Compose a new task graph from all registered modules. More...

Detailed Description

Interface for the engine runtime and modules.

Member Function Documentation

RebuildTaskGraph()

virtual void nc::NcEngine::RebuildTaskGraph ( )

pure virtual

Compose a new task graph from all registered modules.

A graph is built on engine initialization. It only needs rebuilding if modules are added afterwards. Only call this from the main thread and when the graph is not currently running (prior to calling Start() or from a Scene).

Start()

virtual void nc::NcEngine::Start ( std::unique_ptr< Scene >  initialScene )

pure virtual

Start engine execution.

Parameters

initialScene

The initial scene to load.

---

The documentation for this class was generated from the following file:

• include/ncengine/NcEngine.h