nc::Module Class Reference

Modules are extensions that provide functionality to the engine. More...

#include <Module.h>

Inheritance diagram for nc::Module:

Public Member Functions
	Module (size_t id=0) noexcept
	Constructor for the Module interface. More...
auto	Id () const noexcept
	Get the module's unique id.
virtual void	OnBuildTaskGraph (task::UpdateTasks &, task::RenderTasks &)
	Called on registered modules when the task graphs are constructed.
virtual void	OnBeforeSceneLoad ()
	Called on registered modules prior to loading a new scene.
virtual void	OnBeforeSceneFragmentLoad ()
	Called on registered modules immediately before loading a SceneFragment file.
virtual void	OnAfterSceneFragmentLoad ()
	Called on registered modules immediately after loading a SceneFragment file.
virtual void	Clear () noexcept
	Called on registered modules prior to clearing the Registry. This includes Scene::Unload() and NcEngine::Shutdown().

Friends
class	ModuleRegistry

Detailed Description

Modules are extensions that provide functionality to the engine.

Constructor & Destructor Documentation

Module()

nc::Module::Module ( size_t  id = 0 )

inlinenoexcept

Constructor for the Module interface.

All registered modules must have unique ids. Set 'id' to 0 to get assigned an available id upon registration. The range [1, 100] is reserved for engine modules. Automatically assigned ids are assigned in reverse order starting from std::numeric_limits<size_t>::max().

---

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

• include/ncengine/module/Module.h