galaxy::App Class Reference

Base level class for any galaxy app. More...

#include <Application.hpp>

Collaboration diagram for galaxy::App:

Public Member Functions
	App (const std::string &config_file="config.json")
	Default constructor.
	~App ()
	Destructor.
void	run ()
	Loads the default appdata file.
void	set_update_func (LoopFunc &&update)
	Use a custom update step in game loop.
void	set_render_func (LoopFunc &&render)
	Use a custom rendering step in game loop.
SDL_Event &	events () noexcept
	Get event data.

Private Types
using	LoopFunc = std::move_only_function<void(App* app)>
	Defines a callback for update() or render() loops in app.run().

Private Member Functions
	App (const App &)=delete
	Copy constructor.
	App (App &&)=delete
	Move constructor.
App &	operator= (const App &)=delete
	Copy assignment operator.
App &	operator= (App &&)=delete
	Move assignment operator.
void	setup_async ()
void	setup_logging ()
void	setup_config (std::string_view config_file)
void	setup_platform ()
void	setup_fs ()

Private Attributes
SDL_Event	m_events
	Core event data.
LoopFunc	m_update
	Update step in gameloop.
LoopFunc	m_render
	Render step in gameloop.

Detailed Description

Base level class for any galaxy app.

Definition at line 21 of file Application.hpp.

Member Typedef Documentation

LoopFunc

using galaxy::App::LoopFunc = std::move_only_function<void(App* app)>

private

Defines a callback for update() or render() loops in app.run().

Definition at line 26 of file Application.hpp.

Constructor & Destructor Documentation

App() [1/3]

galaxy::App::App ( const std::string & config_file = "config.json" )

explicit

Default constructor.

Sets up the engine. You need to inherit this and call it from a subclass. Also calls std::srand(std::time(nullptr)) for you.

Parameters

config_file

Filepath of config file.

Definition at line 44 of file Application.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

~App()

galaxy::App::~App

(

)

Destructor.

Definition at line 66 of file Application.cpp.

App() [2/3]

galaxy::App::App ( const App & )

privatedelete

Copy constructor.

Here is the call graph for this function:

App() [3/3]

galaxy::App::App ( App && )

privatedelete

Move constructor.

Here is the call graph for this function:

Member Function Documentation

run()

void galaxy::App::run

(

)

Loads the default appdata file.

Main game loop.

Definition at line 86 of file Application.cpp.

Here is the call graph for this function:

set_update_func()

void galaxy::App::set_update_func

(

LoopFunc &&

update

)

Use a custom update step in game loop.

Parameters

update

Callback.

Definition at line 187 of file Application.cpp.

set_render_func()

void galaxy::App::set_render_func

(

LoopFunc &&

render

)

Use a custom rendering step in game loop.

Parameters

render

Callback.

Definition at line 192 of file Application.cpp.

events()

SDL_Event & galaxy::App::events ( )

noexcept

Get event data.

Returns

SDL_Event data.

Definition at line 197 of file Application.cpp.

operator=() [1/2]

App & galaxy::App::operator= ( const App & )

privatedelete

Copy assignment operator.

Here is the call graph for this function:

operator=() [2/2]

App & galaxy::App::operator= ( App && )

privatedelete

Move assignment operator.

Here is the call graph for this function:

setup_async()

void galaxy::App::setup_async ( )

private

Definition at line 202 of file Application.cpp.

Here is the caller graph for this function:

setup_logging()

void galaxy::App::setup_logging ( )

private

Definition at line 221 of file Application.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

setup_config()

void galaxy::App::setup_config ( std::string_view config_file )

private

Definition at line 237 of file Application.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

setup_platform()

void galaxy::App::setup_platform ( )

private

Definition at line 244 of file Application.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

setup_fs()

void galaxy::App::setup_fs ( )

private

Definition at line 314 of file Application.cpp.

Here is the caller graph for this function:

Member Data Documentation

m_events

SDL_Event galaxy::App::m_events

private

Core event data.

Definition at line 114 of file Application.hpp.

m_update

LoopFunc galaxy::App::m_update

private

Update step in gameloop.

Definition at line 119 of file Application.hpp.

m_render

LoopFunc galaxy::App::m_render

private

Render step in gameloop.

Definition at line 124 of file Application.hpp.

---

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

• galaxy/src/galaxy/core/Application.hpp
• galaxy/src/galaxy/core/Application.cpp