Raito 0.1
Loading...
Searching...
No Matches
Raito::Core::Application Class Reference

Application base class. More...

#include <Application.h>

Collaboration diagram for Raito::Core::Application:

Public Member Functions

virtual ~Application ()=default
 Virtual destructor.
 
bool Initialize ()
 Initialization function.
 
bool Update ()
 EndTimeUpdate function.
 
void Shutdown ()
 Shutdown function.
 
void Close ()
 Close function.
 

Static Public Member Functions

static ApplicationGet ()
 Application getter.
 

Public Attributes

ECS::Scene Scene {}
 

Protected Member Functions

virtual bool OnInit ()
 Initialization event function.
 
virtual bool OnRenderGUI ()
 
virtual bool OnUpdate ()
 
virtual void OnShutdown ()
 Shutdown event function.
 
 Application ()=default
 Application constructor.
 

Protected Attributes

bool m_Running = false
 

Friends

int RunApp (Application &app, ApplicationInfo info, int argc, char **argv)
 

Detailed Description

Application base class.

The base class for an application to inherit from, it handles all the modules execution.

Constructor & Destructor Documentation

◆ ~Application()

virtual Raito::Core::Application::~Application ( )
virtualdefault

Virtual destructor.

◆ Application()

Raito::Core::Application::Application ( )
protecteddefault

Application constructor.

Member Function Documentation

◆ Close()

void Raito::Core::Application::Close ( )
inline

Close function.

◆ Get()

static Application & Raito::Core::Application::Get ( )
inlinestatic

Application getter.

◆ Initialize()

bool Raito::Core::Application::Initialize ( )

Initialization function.

Initializes all the modules and calls OnInit at the end if all succeed.

◆ OnInit()

virtual bool Raito::Core::Application::OnInit ( )
inlineprotectedvirtual

Initialization event function.

◆ OnRenderGUI()

virtual bool Raito::Core::Application::OnRenderGUI ( )
inlineprotectedvirtual

ImGui rendering event function Note: Called after OnUpdate()

◆ OnShutdown()

virtual void Raito::Core::Application::OnShutdown ( )
inlineprotectedvirtual

Shutdown event function.

◆ OnUpdate()

virtual bool Raito::Core::Application::OnUpdate ( )
inlineprotectedvirtual

EndTimeUpdate event function Note: Called before OnRenderGUI()

◆ Shutdown()

void Raito::Core::Application::Shutdown ( )

Shutdown function.

Shutdowns every module and closes the application

◆ Update()

bool Raito::Core::Application::Update ( )

EndTimeUpdate function.

Main update loop, runs every module update function and calls OnUpdate() and OnRenderGUI() with this order.

Friends And Related Symbol Documentation

◆ RunApp

int RunApp ( Application & app,
ApplicationInfo info,
int argc,
char ** argv )
friend

Application creation function Initializes and runs the application with the parameters

Member Data Documentation

◆ m_Running

bool Raito::Core::Application::m_Running = false
protected

Flag for the application loop to be ran

◆ Scene

ECS::Scene Raito::Core::Application::Scene {}

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