brenta::subsystem Class Reference

Subsystem interface. More...

#include <subsystem.hpp>

Inheritance diagram for brenta::subsystem:

Data Structures
class	builder
	Builder interface. More...

Public Types
using	error = std::string

Public Member Functions
virtual std::expected< void, subsystem::error >	initialize ()=0
virtual std::expected< void, subsystem::error >	terminate ()=0
virtual std::string	name ()=0
	Returns the name of the sybsystem.
virtual bool	is_initialized ()=0
	Returns true if the subsystem is initialized.

Detailed Description

Subsystem interface.

A subsistem is a static singleton that can be initialized and terminated. The initialization settings should be passed via a builder class.

Definition at line 21 of file subsystem.hpp.

Member Typedef Documentation

error

using brenta::subsystem::error = std::string

Definition at line 25 of file subsystem.hpp.

Member Function Documentation

initialize()

virtual std::expected< void, subsystem::error > brenta::subsystem::initialize ( )

pure virtual

Implemented in brenta::audio, brenta::input, and brenta::text.

is_initialized()

virtual bool brenta::subsystem::is_initialized ( )

pure virtual

Returns true if the subsystem is initialized.

Implemented in brenta::audio, brenta::engine, brenta::gl, brenta::gui, brenta::input, brenta::logger, brenta::text, and brenta::window.

name()

virtual std::string brenta::subsystem::name ( )

pure virtual

Returns the name of the sybsystem.

Implemented in brenta::audio, brenta::engine, brenta::gl, brenta::gui, brenta::input, brenta::logger, brenta::text, and brenta::window.

terminate()

virtual std::expected< void, subsystem::error > brenta::subsystem::terminate ( )

pure virtual

Implemented in brenta::audio, brenta::input, and brenta::text.

---

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

• include/brenta/subsystem.hpp