Hubris::Engine Class Reference

Stores and defines Engine wide data and functionalities. More...

#include <Engine.h>

Static Public Member Functions
static EngineConfig	GetPlatformConfig (std::string ProjectName="Default", const Version &ProjectVersion={0, 0, 0, 0}) noexcept
	Returns the default platform's (Windows, Linux, etc...) default engine configuration.
static void	Init (const EngineConfig &config) noexcept
	Initializes the engine (headless) for the first time called. TODO: Make sure this is a headless initializer.
static void	Run ()
	Yields control to the engine logic. The Engine will run until the program exits.
static void	Loop ()
	The Engine Executes the main loop once, then returns control to user.
static void	Shutdown ()
static void	GetPluginManager ()
	Get the Plugin Manager object. [A planned feature].
static void	CreateWindow ()
static Graphics::Window *	GetWindow ()
static const std::string &	GetProjectName () noexcept
static const Version &	GetProjectVersion () noexcept

Detailed Description

Stores and defines Engine wide data and functionalities.

Definition at line 60 of file Engine.h.

Member Function Documentation

CreateWindow()

static void Hubris::Engine::CreateWindow ( )

inlinestatic

Definition at line 164 of file Engine.h.

GetPlatformConfig()

static EngineConfig Hubris::Engine::GetPlatformConfig ( std::string ProjectName = "Default", const Version & ProjectVersion = {0,0,0,0} )

inlinestaticnoexcept

Returns the default platform's (Windows, Linux, etc...) default engine configuration.

Definition at line 88 of file Engine.h.

GetPluginManager()

static void Hubris::Engine::GetPluginManager ( )

inlinestatic

Get the Plugin Manager object. [A planned feature].

Definition at line 160 of file Engine.h.

GetProjectName()

static const std::string & Hubris::Engine::GetProjectName ( )

inlinestaticnoexcept

Definition at line 167 of file Engine.h.

Here is the caller graph for this function:

GetProjectVersion()

static const Version & Hubris::Engine::GetProjectVersion ( )

inlinestaticnoexcept

Definition at line 168 of file Engine.h.

Here is the caller graph for this function:

GetWindow()

static Graphics::Window * Hubris::Engine::GetWindow ( )

inlinestatic

Definition at line 166 of file Engine.h.

Init()

static void Hubris::Engine::Init ( const EngineConfig & config )

inlinestaticnoexcept

Initializes the engine (headless) for the first time called. TODO: Make sure this is a headless initializer.

Definition at line 106 of file Engine.h.

Here is the call graph for this function:

Loop()

static void Hubris::Engine::Loop ( )

inlinestatic

The Engine Executes the main loop once, then returns control to user.

Warning

This requires the Engine to be initialized first.

Definition at line 142 of file Engine.h.

Here is the caller graph for this function:

Run()

static void Hubris::Engine::Run ( )

inlinestatic

Yields control to the engine logic. The Engine will run until the program exits.

This Calls Loop() in a loop.

Warning

This requires the Engine to be initialized first.

Definition at line 131 of file Engine.h.

Here is the call graph for this function:

Shutdown()

static void Hubris::Engine::Shutdown ( )

inlinestatic

Definition at line 150 of file Engine.h.

---

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

• include/Engine.h
• src/Engine.cpp