scl::abstract Class Reference

#include <application.h>

Public Types
using	handle = u32

Public Member Functions
const window &	GetWindow () const
virtual void	OnInit ()
virtual void	OnClose ()
virtual void	OnUpdate (float DeltaTime)
virtual void	OnGuiUpdate ()
	application (const std::string &Name)
virtual	~application ()
void	Run ()
void	ShutDown ()
	layer ()=default
virtual	~layer ()
virtual void	OnInit ()
virtual void	OnClose ()
virtual void	OnUpdate (float DeltaTime)
virtual void	OnGuiRender ()
virtual handle	GetHandle () const =0

Static Public Member Functions
static application &	Get ()

Public Attributes
bool	GuiEnabled { false }

Detailed Description

Base abstract application layer class.

Render primitive abstract class

Definition at line 28 of file application.h.

Member Typedef Documentation

handle

using scl::abstract::handle = u32

Definition at line 19 of file render_primitive.h.

Constructor & Destructor Documentation

~application()

virtual scl::abstract::~application ( )

virtual

Default application destructor.

~layer()

virtual scl::abstract::~layer ( )

inlinevirtual

Default layer destcuctor.

Definition at line 25 of file layer.h.

{}

Member Function Documentation

application()

scl::abstract::application

(

const std::string &

Name

)

Application methods.

• Default applicatino construcotr. Initialises all depended systems.

Parameters

Name	- Application name. Will be shown in window title.

Get()

static application & scl::abstract::Get ( )

inlinestatic

Application graphic user interface enabled flag. If false do not rendering gui.

Applicatino getters/setters functions.

Get applciation instance function.

Definition at line 43 of file application.h.

{ return *Instance; }

GetHandle()

virtual handle scl::abstract::GetHandle ( ) const

pure virtual

Backend api render primitive hadnle getter function.

GetWindow()

const window & scl::abstract::GetWindow ( ) const

inline

Window getter function.

Definition at line 45 of file application.h.

{ return *Window; }

layer()

scl::abstract::layer ( )

default

Default layer constructor.

OnClose() [1/2]

virtual void scl::abstract::OnClose ( )

inlinevirtual

• Application deinitialisation virtual callback function.

Parameters

None.

Returns

None.

Definition at line 71 of file application.h.

{}

OnClose() [2/2]

virtual void scl::abstract::OnClose ( )

inlinevirtual

• Layer deinitialisation virtual callback function.

Parameters

None.

Returns

None.

Definition at line 41 of file layer.h.

{}

OnGuiRender()

virtual void scl::abstract::OnGuiRender ( )

inlinevirtual

• Layer GUI rendering virtual callback function.

Parameters

None.

Returns

None.

Definition at line 57 of file layer.h.

{}

OnGuiUpdate()

virtual void scl::abstract::OnGuiUpdate ( )

inlinevirtual

• Application GUI update virtual callback function.

Parameters

None.

Returns

None.

Definition at line 87 of file application.h.

{}

OnInit() [1/2]

virtual void scl::abstract::OnInit ( )

inlinevirtual

Client application virtual collbacks.

• Application initialisation virtual callback function.

Parameters

None.

Returns

None.

Definition at line 63 of file application.h.

{}

OnInit() [2/2]

virtual void scl::abstract::OnInit ( )

inlinevirtual

• Layer initialisation virtual callback function.

Parameters

None.

Returns

None.

Definition at line 33 of file layer.h.

{}

OnUpdate() [1/2]

virtual void scl::abstract::OnUpdate ( float  DeltaTime )

inlinevirtual

• Application update virtual callback function.

Parameters

DeltaTime

- update inter frame delta time. \retunr None.

Definition at line 79 of file application.h.

{}

OnUpdate() [2/2]

virtual void scl::abstract::OnUpdate ( float  DeltaTime )

inlinevirtual

• Layer update virtual callback function.

Parameters

None.

Returns

None.

Definition at line 49 of file layer.h.

{}

Run()

void scl::abstract::Run

(

)

• Run application loop and show window function.

Parameters

None.

Returns

None.

ShutDown()

void scl::abstract::ShutDown

(

)

• Application shut down function.

Parameters

None.

Returns

None.

Member Data Documentation

GuiEnabled

bool scl::abstract::GuiEnabled { false }

Main app window.

Definition at line 39 of file application.h.

---

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

• core/application/application.h
• core/render/primitives/render_primitive.h
• core/application/layer.h