TestApp Class Reference

#include <common.h>

Inherits LiteFX::App, and LiteFX::App.

Public Member Functions
StringView	name () const noexcept override
	Returns the name of the app.
AppVersion	version () const noexcept override
	Returns the version of the app.
	TestApp ()
StringView	name () const noexcept override
	Returns the name of the app.
AppVersion	version () const noexcept override
	Returns the version of the app.
	TestApp ()
Public Member Functions inherited from LiteFX::App
	App ()
	Initializes a new app instance.
	App (const App &)=delete
	App (App &&) noexcept=delete
auto	operator= (const App &)=delete
auto	operator= (App &&) noexcept=delete
virtual	~App () noexcept
Platform	platform () const noexcept
	Returns the platform, the app is running on.
const IBackend *	operator[] (std::type_index type) const
	Returns the registered backend instance for a type index.
const IBackend *	getBackend (std::type_index type) const
	Returns the registered backend instance for a type index.
Enumerable< const IBackend & >	getBackends (const BackendType type) const
	Returns all registered backend instances of a backend type.
template<typename TBackend > requires meta::implements<TBackend, IBackend>
void	onBackendStart (const std::function< bool(TBackend *)> &callback)
	Sets a callback that is called, if a backend is started.
template<typename TBackend > requires meta::implements<TBackend, IBackend>
void	onBackendStop (const std::function< void(TBackend *)> &callback)
	Sets a callback that is called, if a backend is stopped.
template<typename TBackend > requires meta::implements<TBackend, IBackend>
const TBackend *	findBackend () const
	Returns the registered backend instance for a type index.
template<typename TBackend > requires meta::implements<TBackend, IBackend>
void	startBackend ()
	Attempts to start a backend of type TBackend and stops the active backend of the same BackendType, if any.
template<typename TBackend > requires meta::implements<TBackend, IBackend>
void	stopBackend ()
	Stops a backend, if it is currently running.
virtual void	use (UniquePtr< IBackend > &&backend)
	Adds a backend to the app.
void	run ()
	Starts the application.
void	resize (int width, int height)
	Called, if the application window resizes.

Static Public Member Functions
static StringView	Name () noexcept
static AppVersion	Version () noexcept
static StringView	Name () noexcept
static AppVersion	Version () noexcept
Static Public Member Functions inherited from LiteFX::App
template<typename TApp , typename ... TArgs>
static AppBuilder	build (TArgs &&... _args)
	Creates a new application builder.

Additional Inherited Members
Public Attributes inherited from LiteFX::App
Event< const IBackend * >	backendStarted
	Invoked, if a backend has been started.
Event< const IBackend * >	backendStopped
	Invoked, if a backend has been stopped.
Event< EventArgs >	startup
	Invoked, if the application has been started.
Event< EventArgs >	initializing
	Invoked during initialization.
Event< EventArgs >	shutdown
	Invoked, if the application has is shutting down.
Event< ResizeEventArgs >	resized
	Invoked, if the app window or context gets resized.
Protected Member Functions inherited from LiteFX::App
IBackend *	getBackend (std::type_index type)
	Returns the registered backend instance for a type index.
template<typename TBackend > requires meta::implements<TBackend, IBackend>
TBackend *	findBackend ()
	Returns the registered backend instance for a type index.
void	startBackend (std::type_index type) const
	Starts a backend.
void	stopBackend (std::type_index type) const
	Stops a backend.
void	stopActiveBackends (BackendType type) const
	Stops the active backend of type .
IBackend *	activeBackend (BackendType type) const
	Returns the active backend of the provided backend type .
std::type_index	activeBackendType (BackendType type) const
	Returns the type index of the active backend of the provided backend type .

Constructor & Destructor Documentation

TestApp() [1/2]

TestApp::TestApp ( )

inline

TestApp() [2/2]

TestApp::TestApp ( )

inline

Member Function Documentation

Name() [1/2]

static StringView TestApp::Name ( )

inlinestaticnoexcept

Name() [2/2]

static StringView TestApp::Name ( )

inlinestaticnoexcept

name() [1/2]

StringView TestApp::name ( ) const

inlineoverridevirtualnoexcept

Returns the name of the app.

Returns

The name of the app.

Implements LiteFX::App.

name() [2/2]

StringView TestApp::name ( ) const

inlineoverridevirtualnoexcept

Returns the name of the app.

Returns

The name of the app.

Implements LiteFX::App.

Version() [1/2]

static AppVersion TestApp::Version ( )

inlinestaticnoexcept

Version() [2/2]

static AppVersion TestApp::Version ( )

inlinestaticnoexcept

version() [1/2]

AppVersion TestApp::version ( ) const

inlineoverridevirtualnoexcept

Returns the version of the app.

Returns

The version of the app.

Implements LiteFX::App.

version() [2/2]

AppVersion TestApp::version ( ) const

inlineoverridevirtualnoexcept

Returns the version of the app.

Returns

The version of the app.

Implements LiteFX::App.