brenta::gui Class Reference

Gui class. More...

#include <gui.hpp>

Inheritance diagram for brenta::gui:

Data Structures
class	builder

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

Static Public Member Functions
static gui &	instance ()
static void	new_frame (types::framebuffer *fb, std::string name="Game")
	Start a new frame To be called at each frame before rendering.
static void	render ()
	Render the gui To be called at each frame after rendering.

Static Public Attributes
static const std::string	subsystem_name = "gui"

Additional Inherited Members
Public Types inherited from brenta::subsystem
using	error = std::string

Detailed Description

Gui class.

This class contains the GUI functions, It's a wrapper around imgui, providing functions to initialize, update and delete the gui.

Definition at line 26 of file gui.hpp.

Member Function Documentation

initialize()

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

overridevirtual

Implements brenta::subsystem.

Definition at line 28 of file gui.cpp.

instance()

gui & gui::instance ( )

static

Definition at line 78 of file gui.cpp.

is_initialized()

bool gui::is_initialized ( )

overridevirtual

Returns true if the subsystem is initialized.

Implements brenta::subsystem.

Definition at line 69 of file gui.cpp.

name()

std::string gui::name ( )

overridevirtual

Returns the name of the sybsystem.

Implements brenta::subsystem.

Definition at line 64 of file gui.cpp.

new_frame()

void gui::new_frame ( types::framebuffer * fb, std::string name = "Game" )

static

Start a new frame To be called at each frame before rendering.

Definition at line 84 of file gui.cpp.

render()

void gui::render ( )

static

Render the gui To be called at each frame after rendering.

Definition at line 113 of file gui.cpp.

terminate()

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

overridevirtual

Implements brenta::subsystem.

Definition at line 51 of file gui.cpp.

Field Documentation

subsystem_name

const std::string gui::subsystem_name = "gui"

static

Definition at line 32 of file gui.hpp.

---

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

• include/brenta/gui.hpp
• src/gui.cpp