HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions
hi::v1::log Class Reference

Public Member Functions

template<global_state_type Level, fixed_string SourcePath, int SourceLine, fixed_string Fmt, typename... Args>
hi_force_inline void add (Args &&...args) noexcept
 Log a message.
 
hi_no_inline void flush () noexcept
 Flush all messages from the log_queue directly from this thread.
 

Static Public Member Functions

static bool start_subsystem (global_state_type log_level=global_state_type::log_level_default)
 Start the logger system.
 
static void stop_subsystem ()
 Stop the logger system.
 

Member Function Documentation

◆ add()

template<global_state_type Level, fixed_string SourcePath, int SourceLine, fixed_string Fmt, typename... Args>
hi_force_inline void hi::v1::log::add ( Args &&... args)
inlinenoexcept

Log a message.

Template Parameters
Levellog level of message, must be greater or equal to the log level of the system_status.
SourcePathThe source file where this function was called.
SourceLineThe source line where this function was called.
FmtThe format string.
Parameters
argsArguments to std::format().

◆ flush()

hi_no_inline void hi::v1::log::flush ( )
inlinenoexcept

Flush all messages from the log_queue directly from this thread.

Flushing includes writing the message to a log file or displaying them on the console.

◆ start_subsystem()

bool hi::v1::log::start_subsystem ( global_state_type log_level = global_state_type::log_level_default)
inlinestatic

Start the logger system.

Initialize the logger system if it is not already initialized and while the system is not in shutdown-mode.

Parameters
log_levelThe level at which to log.
Returns
true if the logger system is initialized, false when the system is being shutdown.

◆ stop_subsystem()

static void hi::v1::log::stop_subsystem ( )
inlinestatic

Stop the logger system.

De-initialize the logger system if it is initialized.


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