Fling Engine  0.00.1
Fling Engine is a game engine written in Vulkan
Public Member Functions | Private Member Functions | Private Attributes
Fling::Engine Class Reference

Core engine class of Fling. More...

#include <Engine.h>

Inherits Fling::NonCopyable.

Public Member Functions

 Engine ()=default
 
 Engine (int argc, char *argv[])
 
 ~Engine ()=default
 
UINT64 Run ()
 Run the engine (Startup, Tick until should stop, and shutodwn) More...
 
- Public Member Functions inherited from Fling::NonCopyable
 NonCopyable (const NonCopyable &)=delete
 
 NonCopyable (NonCopyable &&)=default
 
NonCopyableoperator= (const NonCopyable &)=delete
 
NonCopyableoperator= (NonCopyable &&)=default
 

Private Member Functions

void Startup ()
 Start any systems or subsystems that may be needed More...
 
void Tick ()
 Initial tick for the engine frame More...
 
void Shutdown ()
 Shutdown all engine systems and do any necessary cleanup More...
 

Private Attributes

int m_CmdLineArgCount = 0
 
char ** m_CmdLineArgs = nullptr
 
Worldm_World = nullptr
 Persistant world object that can be used to load levels, entities, etc. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Fling::NonCopyable
 NonCopyable ()=default
 
virtual ~NonCopyable ()=default
 

Detailed Description

Core engine class of Fling.

This is where the core update loop lives along with all startup/shutdown ordering.

Constructor & Destructor Documentation

◆ Engine() [1/2]

Fling::Engine::Engine ( )
default

◆ Engine() [2/2]

Fling::Engine::Engine ( int  argc,
char *  argv[] 
)

◆ ~Engine()

Fling::Engine::~Engine ( )
default

Member Function Documentation

◆ Run()

UINT64 Fling::Engine::Run ( )

Run the engine (Startup, Tick until should stop, and shutodwn)

Returns
UINT64 0 for success, otherwise an error has occured

◆ Shutdown()

void Fling::Engine::Shutdown ( )
private

Shutdown all engine systems and do any necessary cleanup

◆ Startup()

void Fling::Engine::Startup ( )
private

Start any systems or subsystems that may be needed

◆ Tick()

void Fling::Engine::Tick ( )
private

Initial tick for the engine frame

Field Documentation

◆ m_CmdLineArgCount

int Fling::Engine::m_CmdLineArgCount = 0
private

◆ m_CmdLineArgs

char** Fling::Engine::m_CmdLineArgs = nullptr
private

◆ m_World

World* Fling::Engine::m_World = nullptr
private

Persistant world object that can be used to load levels, entities, etc.


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