`LiteFX::App`¶

The base class for an application.

Synopsis¶

Declared in <litefx/app.hpp>

class [[dllexport, dllimport]] App;

Name
`builder_type`

Name	Description
`App` [constructor]	Initializes a new app instance.
`~App` [destructor] [virtual]	Destructor
`operator=`	Assignment operators
`findBackend`	Returns the registered backend instance for a type index.
`getBackend`	Returns the registered backend instance for a type index.
`getBackends`	Returns all registered backend instances of a backend type.
`name` [virtual]	Returns the name of the app.
`onBackendStart`	Sets a callback that is called, if a backend is started.
`onBackendStop`	Sets a callback that is called, if a backend is stopped.
`operator[]`	Returns the registered backend instance for a type index.
`platform`	Returns the platform, the app is running on.
`resize`	Called, if the application window resizes.
`run`	Starts the application.
`startBackend`	Attempts to start a backend of type `TBackend` and stops the active backend of the same `BackendType`, if any.
`stopBackend`	Stops a backend, if it is currently running.
`use` [virtual]	Adds a backend to the app.
`version` [virtual]	Returns the version of the app.

Name	Description
`build`	Creates a new application builder.

Name	Description
`backendStarted`	Invoked, if a backend has been started.
`backendStopped`	Invoked, if a backend has been stopped.
`initializing`	Invoked during initialization.
`resized`	Invoked, if the app window or context gets resized.
`shutdown`	Invoked, if the application has is shutting down.
`startup`	Invoked, if the application has been started.

Name	Description
`activeBackend`	Returns the active backend of the provided backend `type.`
`activeBackendType`	Returns the type index of the active backend of the provided backend `type.`
`findBackend`	Returns the registered backend instance for a type index.
`getBackend`	Returns the registered backend instance for a type index.
`startBackend`	Starts a backend.
`stopActiveBackends`	Stops the active backend of `type.`
`stopBackend`	Stops a backend.

Name	Description
`LiteFX::AppBuilder`	Creates a new builder for an `App`.
`LiteFX::App::AppImpl`
`LiteFX::PimplPtr`	A smart pointer that manages an implementation instance for a public interface class.